SupervisorOperationGetNext (FUN) ¶ FUNCTION SupervisorOperationGetNext : RTS_IEC_HANDLE Iteration interface to get the next registered operation. Must be started with SupervisorOperationGetFirst() Error code: ERR_OK: The next operation was successfully retrieved ERR_NOTINITIALIZED: The operation memory is not initialized ERR_END_OF_OBJECT: There are no registered operations left InOut: Scope Name Type Comment Return SupervisorOperationGetNext RTS_IEC_HANDLE Handle to the first operation or RTS_INVALID_HANDLE in case of an error Input hPrevOperation RTS_IEC_HANDLE Handle to the previous operation retrieved via SupervisorOperationGetFirst() or subsequent calls of SupervisorOperationGetNext() pResult POINTER TO RTS_IEC_RESULT Pointer to error code
SupervisorOperationGetState2 (FUN) ¶ FUNCTION SupervisorOperationGetState2 : RTS_IEC_RESULT Retrieves the supervisor state for all supervised operations! Here you can check with one call how many operations failed. InOut: Scope Name Type Comment Return SupervisorOperationGetState2 RTS_IEC_RESULT Error code Error code: ERR_OK: The SupervisorState was successfully retrieved ERR_NOTINITIALIZED: The operation memory is not initialized ERR_PARAMETER: The pointer to the SupervisorState is invalid ERR_NOT_SUPPORTED”>SysTimeGetUs is not supported Input pSupervisorState POINTER TO SupervisorState Pointer to the SupervisorState, will be filled with the corresponding information. The caller has to hold the buffer.
SupervisorOperationSetTimeout (FUN) ¶ FUNCTION SupervisorOperationSetTimeout : RTS_IEC_RESULT Sets a (new) timeout for the given operation Supervision must be disabled to modify the timeout and should be enabled afterwards. InOut: Scope Name Type Comment Return SupervisorOperationSetTimeout RTS_IEC_RESULT Error code Error code: ERR_OK: The timeout was successfully set 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: The timeout was not modified because supervision is enabled! Input hOperation RTS_IEC_HANDLE Handle to the operation stTimeoutUs ULINT Timeout limit in [us]
SupervisorOperationUnregister (FUN) ¶ FUNCTION SupervisorOperationUnregister : RTS_IEC_RESULT Unregister a previously registered operation from supervision InOut: Scope Name Type Comment Return SupervisorOperationUnregister RTS_IEC_RESULT Error code Error code: ERR_OK: Operation was successfully unregistered 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 Input hOperation RTS_IEC_HANDLE Handle to the operation
SupervisorState (STRUCT) ¶ TYPE SupervisorState : STRUCT InOut: Name Type Comment nNumOfOperations UDINT Number of registered operations that are supervised/enabled nNumOfFailedOperations UDINT Number of failed operations. 0=All operations alive nNumOfRegisteredOperations UDINT Number of all registered operations
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:56:21 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpSupervisor.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpSupervisor.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 20.04.2021, 15:56:21 LibraryCategories library-category-list System|SysLibs Author string 3S - Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 Description See: Description DocFormat reStructuredText Placeholder CmpSupervisor Project CmpSupervisor Title CmpSupervisor Version version 3.5.17.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpEventMgr ¶ Library Identification ¶ Placeholder: CmpEventMgr Default Resolution: CmpEventMgr, * (System) Namespace: CmpEventMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpEventMgr SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)
CmpTlsCreateContext (FUN) ¶ FUNCTION CmpTlsCreateContext : RTS_IEC_HANDLE This function create a TLS context. This context is needed to perform TLS communication using the SysSocket2 library. The context contains all informaiton how to handle this TLS connection. InOut: Scope Name Type Initial Comment Return CmpTlsCreateContext RTS_IEC_HANDLE Handle to the new accepted socket or RTS_INVALID_HANDLE if failed. Input hCert RTS_IEC_HANDLE RTS_INVALID_HANDLE Handle to a certificate. The private key of this certificate has to be available. Can be RTS_INVALID_HANDLE for client connections. If the server requires a client certificate the connection will fail in these case. tlsMethod CmpTls_Interfaces.CmpTlsMethod Protocol version and role in the communication. TLS1.2 is suggested for new implementations. Default will be TLS1.2 client. cipherList POINTER TO STRING 0 Allowed chipers used by this connection. Leave 0 to get default. Default will result in ciphers with HIGH encryption strength and Diffie Hellman key exchange. verifyMode DWORD Set up how to verify the peer. The settings differ between client and server. See CmpTlsVerifyMode for details. Default results in: Client -> Verify the peer. Server -> Do not Verify Peer The options of CmpTlsConstans can be combined by adding them. pResult POINTER TO RTS_IEC_RESULT Operations Result
CmpTlsCreateContext2 (FUN) ¶ FUNCTION CmpTlsCreateContext2 : RTS_IEC_HANDLE This function create a TLS context. This context is needed to perform TLS communication using the SysSocket2 library. The context contains all informaiton how to handle this TLS connection. InOut: Scope Name Type Initial Comment Return CmpTlsCreateContext2 RTS_IEC_HANDLE Handle to the new accepted socket or RTS_INVALID_HANDLE if failed. Input hCert RTS_IEC_HANDLE RTS_INVALID_HANDLE Handle to a certificate. The private key of this certificate has to be available. Can be RTS_INVALID_HANDLE for client connections. If the server requires a client certificate the connection will fail in these case. tlsMethod CmpTls_Interfaces.CmpTlsMethod Protocol version and role in the communication. TLS1.2 is suggested for new implementations. Default will be TLS1.2 client. cipherList POINTER TO STRING 0 Allowed chipers used by this connection. Leave 0 to get default. Default will result in ciphers with HIGH encryption strength and Diffie Hellman key exchange. verifyMode DWORD Set up how to verify the peer. The settings differ between client and server. See CmpTlsVerifyMode for details. Default results in: Client -> Verify the peer. Server -> Do not Verify Peer The options of CmpTlsConstans can be combined by adding them. verifyCallback CmpTls_Interfaces.IVerifyCertCallback This callback is called after the pre verification of the peers certificate. All possible checks (validity, trust chain, etc.) have been done already. The result of this check is passed to the callback. The callback allows to do futher checks (e.g. check the certificate host name, key usage etc.) depending on the use case of the connection. pResult POINTER TO RTS_IEC_RESULT Operations Result
CmpTlsFreeContext (FUN) ¶ FUNCTION CmpTlsFreeContext : RTS_IEC_RESULT This function cleans up the TLS context created with CmpTlsCreateContext. InOut: Scope Name Type Comment Return CmpTlsFreeContext RTS_IEC_RESULT Input hTlsContext RTS_IEC_HANDLE Handle to the context to clean up