SupervisorInstance (STRUCT) ¶ TYPE SupervisorInstance : STRUCT InOut: Name Type Comment hInstance RTS_IEC_HANDLE Handle to the instance idInstance UDINT Id of the instance xIsIECInstance BOOL TRUE=hInstance is an IEC instance, FALSE=hInstance is a runtime handle
SupervisorOperationAlive (FUN) ¶ FUNCTION SupervisorOperationAlive : RTS_IEC_RESULT Reassures the alive state of the operation with the given timestamp in order to retrigger the hardware watchdog InOut: Scope Name Type Comment Return SupervisorOperationAlive RTS_IEC_RESULT Error code Error code: ERR_OK: Alive state was successfully reassured ERR_NOTINITIALIZED: The operation memory is not initialized ERR_INVALID_HANDLE: The handle to the operation is invalid ERR_PARAMETER: The handle to the operation is invalid ERR_NO_CHANGE: Supervision is disabled for the operation ERR_NOT_SUPPORTED”>SysTimeGetUs is not supported Input hOperation RTS_IEC_HANDLE Handle to the operation pstTimestampUs POINTER TO ULINT Pointer to timestamp. May be NULL, if time check is enabled timestamp is set to current time.
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:56:50 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpTls.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpTls.clean.json version version 2.0.0.0 ProjectInformation ActivateSigning bool False IsCommonLibraryContainer True Released True LastModificationDateTime date 20.04.2021, 15:56:50 LibraryCategories library-category-list System|SysLibs Author string `` 3S - Smart Software Solutions GmbH `` Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description DocFormat reStructuredText Placeholder CmpTls Project CmpTls Title CmpTls Version version 3.5.17.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpTls Implementation ¶ Library Identification ¶ Placeholder: CmpTls Implementation Default Resolution: CmpTls Implementation, * (System) Namespace: CmpTls_Implementation Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpTls Implementation CmpTls Interfaces ¶ Library Identification ¶ Name: CmpTls Interfaces Version: newest Company: System Namespace: CmpTls_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpTls Interfaces, * (System)
CmpTls Interfaces Library Documentation ¶ Company System Title CmpTls Interfaces Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Description 1 ¶ This interface contains common types an error codes related to the CmpTls Implementation library. Contents: ¶ CmpTlsConstants (GVL) CmpTlsMethod (Enum) ERRORS (GVL) IVerifyCertCallback (Interface) VerifyCertCallback (Method) Indices and tables ¶ 1 Based on CmpTls_Itfs.library, last modified 20.04.2021, 15:57:27. LibDoc 4.4.0.0-b.27 The content file CmpTls_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:57:27.
CmpTlsMethod (ENUM) ¶ TYPE CmpTlsMethod : Attributes: qualified_only InOut: Name Initial Comment SSLv2_CLIENT 16#0 Not Available SSLv3_CLIENT 16#1 SSL v3 Client SSLv23_CLIENT 16#2 SSL Client accepting all versions but SSL v2 TLSv1_CLIENT 16#3 TLS 1.1 Client TLSv2_CLIENT 16#4 TLS 1.2 Client (Default for CmpTlsCreateContext) SSLv2_SERVER 16#5 Not Available SSLv3_SERVER 16#6 SSL v3 Server SSLv23_SERVER 16#7 SSL Server accepting all versions but SSL v2 TLSv1_SERVER 16#8 TLS 1.1 Server TLSv2_SERVER 16#9 TLS 1.2 Server TLSv3_CLIENT 16#A TLS 1.3 Client TLSv3_SERVER 16#B TLS 1.3 Server
CmpTlsConstants (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant TLS_VERIFY_NONE DWORD 16#1 Don’t perform a peer verification (Default for server) TLS_VERIFY_PEER DWORD 16#2 Perform a peer verification (Default for client). For Server: Send a client certificate request. If a client certificate is available verify this certificate. TLS_VERIFY_FAIL_IF_NO_PEER_CERT DWORD 16#4 Only for for Server methods. Forces the connection to be terminated if the client does not provide a certificate. Add this to TLS_VERIFY_PERR TLS_VERIFY_CLIENT_ONCE DWORD 16#8 Only for for Server methods. Request the client certificate only whithin the initial handshake. While renegortiation no certificate is requested from the client. Add this to TLS_VERIFY_PERR
ERRORS (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant ERR_TLS_INTERNAL DWORD 16#600 INTERNAL Error OF TLS component ERR_TLS_CONNECTION_CLOSED DWORD 16#610 The TLS connection has been closed. ERR_TLS_RETRY_OPERATION DWORD 16#611 The same TLS IO operation should be called again ERR_TLS_IO_SYSTEM DWORD 16#612 The underlaying transport caused a problem ERR_TLS_WANT_READ DWORD 16#613 The finish THIS operation data have TO be read. The data was NOT available. Receive TLS protocol data TO finish THIS operation ERR_TLS_WANT_WRITE DWORD 16#614 TO finish THIS operation data has TO be written. The buffer doesn’t allow that. Send existing data to allow writing new data
IVerifyCertCallback (ITF) ¶ INTERFACE IVerifyCertCallback EXTENDS __SYSTEM.IQueryInterface Methods: VerifyCertCallback Structure: VerifyCertCallback (Method)
IVerifyCertCallback.VerifyCertCallback (METH) ¶ METHOD VerifyCertCallback : RTS_IEC_RESULT This function is called to allow futher checks on the peers certificate. Return ERR_CERT_OK if the certificate is trustworthy. If not return any (expect ERR_CERT_OK) of the error codes found at CmpX509Cert.ERRORS InOut: Scope Name Type Comment Return VerifyCertCallback RTS_IEC_RESULT Input hCert RTS_IEC_HANDLE Handle to the peers certificate. Can be passed to all functions provieded by CmpX509Cert library. verifyResult RTS_IEC_RESULT Result of the pre verification. See CmpX509Cert.ERRORS for details of the corresponding error codes.
