Subscription ¶ OPCUAClient_CreateSubscription (Function) OPCUAClient_DeleteSubscription (Function) OPCUAClient_ModifySubscription (Function) OPCUAClient_SetPublishingMode (Function)
OPCUAClient_CreateSubscription (FUN) ¶ FUNCTION OPCUAClient_CreateSubscription : RTS_IEC_HANDLE This function creates a subscription on the OPC UA server. The subscription parameters are typically changed by the OPC UA server and sent back as reviced parameters. These parameters are used for timeout calculation and so on. The sending of publish requests is done by the runtime system itself. So no publish requests must be sent. InOut: Scope Name Type Comment Return OPCUAClient_CreateSubscription RTS_IEC_HANDLE A handle to the subscription. Input hConnection RTS_IEC_HANDLE Handle to the connection where to create the subscription. publishingInterval OpcUa_Double The publishing interval that should be used by the server. lifetimeCount OpcUa_UInt32 The liftetime count of the subscription. maxKeepAliveCount OpcUa_UInt32 The maximum number of publishing intervals befor a keepalive is sent. maxNotificationsPerPublish OpcUa_UInt32 The maximum number of notificaitons returned by one publihs response. publishingEnabled OpcUa_Boolean Flag if publishing is enabled on the server. priority OpcUa_Byte The priority of the subscription in respect to other subscriptions of the same session. pResult POINTER TO RTS_IEC_RESULT Result of the operation. callback IOPCUAClientSubscriptionCallback Callback interface to get informed on state and parameter changes.
OPCUAClient_DeleteSubscription (FUN) ¶ FUNCTION OPCUAClient_DeleteSubscription : RTS_IEC_RESULT This function deletes a subscription and all assigned monitored items on the server. InOut: Scope Name Type Comment Return OPCUAClient_DeleteSubscription RTS_IEC_RESULT Input hSubscription RTS_IEC_HANDLE Handle to the subscription to delete.
OPCUAClient_ModifySubscription (FUN) ¶ FUNCTION OPCUAClient_ModifySubscription : RTS_IEC_RESULT This function modifies the parameters of a subscription. InOut: Scope Name Type Comment Return OPCUAClient_ModifySubscription RTS_IEC_RESULT Input hSubscription RTS_IEC_HANDLE Handle to the connection where to create the subscription. reqPublishingInterval OpcUa_Double The publishing interval that should be used by the server. reqLifeTimeCount OpcUa_UInt32 The liftetime count of the subscription. reqMaxKeepAliveCount OpcUa_UInt32 The maximum number of publishing intervals befor a keepalive is sent. maxNotificationsPerPublish OpcUa_UInt32 The maximum number of notificaitons returned by one publihs response. priority OpcUa_Byte The priority of the subscription in respect to other subscriptions of the same session.
OPCUAClient_SetPublishingMode (FUN) ¶ FUNCTION OPCUAClient_SetPublishingMode : RTS_IEC_RESULT This function can be used to enable or disable the publishing of a subscription. InOut: Scope Name Type Comment Return OPCUAClient_SetPublishingMode RTS_IEC_RESULT Input hSubscription RTS_IEC_HANDLE Handle to the connection where to create the subscription. publishingEnabled OpcUa_Boolean True: if publishing should be enabled, False if publishing should be disabled.
View ¶ OPCUAClient_Browse (Function) OPCUAClient_BrowseNext (Function) OPCUAClient_RegisterNodes (Function) OPCUAClient_TranslateBrowsePathsToNodeIds (Function) OPCUAClient_UnregisterNodes (Function)
OPCUAClient_Browse (FUN) ¶ FUNCTION OPCUAClient_Browse : RTS_IEC_RESULT This function sends a Browse request to the OPC UA server. Several operations can be done in one call. The results of the operation are returned by a callback interface. InOut: Scope Name Type Comment Return OPCUAClient_Browse RTS_IEC_RESULT Input hConnection RTS_IEC_HANDLE Handle to the connection where the request should be sent. view OpcUa_ViewDescription Description of the view of intrest. requestedMaxReferencesPerNode OpcUa_Int32 The maximum numbers of references that should be returned to the client. noOfNodesToBrowse OpcUa_Int32 Number of nodes to browse. pNodesToBrowse POINTER TO OpcUa_BrowseDescription Pointer to an array of nodes to browser. iBrowseCallback IOPCUAClientViewCallback Callback interface to retrieve the results.
OPCUAClient_BrowseNext (FUN) ¶ FUNCTION OPCUAClient_BrowseNext : RTS_IEC_RESULT This function sends a BrowseNext request to the OPC UA server. Several operations can be done in one call. The results of the operation are returned by a callback interface. InOut: Scope Name Type Comment Return OPCUAClient_BrowseNext RTS_IEC_RESULT Input hConnection RTS_IEC_HANDLE Handle to the connection where the request should be sent. releaseContinuationPoints OpcUa_Boolean Release the continuation point or not. noOfContinuationPoints OpcUa_Int32 Number of continuation points sent. pContinuationPoints POINTER TO OpcUa_ByteString Pointer to an array of continuation points to do the BrowseNext. iViewCallback IOPCUAClientViewCallback Callback interface to retrieve the results.
OPCUAClient_RegisterNodes (FUN) ¶ FUNCTION OPCUAClient_RegisterNodes : RTS_IEC_RESULT This function sends a RegisterNodes request to the OPC UA server. Several operations can be done in one call. The results of the operation are returned by a callback interface. InOut: Scope Name Type Comment Return OPCUAClient_RegisterNodes RTS_IEC_RESULT Input hConnection RTS_IEC_HANDLE Handle to the connection where the request should be sent. noOfNodesToRegister OpcUa_Int32 Number of nodes to be registered by the server. pNodesToRegister POINTER TO OpcUa_NodeId Pointer to an array of nodes to register. iViewCallback IOPCUAClientViewCallback Callback interface to retrieve the results.
OPCUAClient_TranslateBrowsePathsToNodeIds (FUN) ¶ FUNCTION OPCUAClient_TranslateBrowsePathsToNodeIds : RTS_IEC_RESULT This function sends a TranslateBrowsePathsToNodeIds request to the OPC UA server. Several operations can be done in one call. The results of the operation are returned by a callback interface. InOut: Scope Name Type Comment Return OPCUAClient_TranslateBrowsePathsToNodeIds RTS_IEC_RESULT Input hConnection RTS_IEC_HANDLE Handle to the connection where the request should be sent. noOfBrowsePaths OpcUa_Int32 Number of browser paths to be translated by the server. pBrowsePaths POINTER TO OpcUa_BrowsePath Pointer to an array of BrowserPath. iViewCallback IOPCUAClientViewCallback Callback interface to retrieve the results.