Go to the documentation of this file.
43 #ifndef LIBS2OPC_NEW_CLIENT_H_
44 #define LIBS2OPC_NEW_CLIENT_H_
119 uintptr_t userContext);
228 uintptr_t userContext);
310 uint32_t nbNotifElts,
311 const void* notification,
312 uintptr_t* monitoredItemCtxArray);
333 uintptr_t userParam);
362 uint32_t nbPublishTokens);
376 double* revisedPublishingInterval,
377 uint32_t* revisedLifetimeCount,
378 uint32_t* revisedMaxKeepAliveCount);
421 const uintptr_t* monitoredItemCtxArray,
478 void* subOrMIrequest,
479 void** subOrMIresponse);
513 void* subOrMIrequest,
514 uintptr_t userContext);
High level interface to configure an OPC UA client.
struct SOPC_ClientHelper_Subscription SOPC_ClientHelper_Subscription
Definition: libs2opc_new_client.h:283
Definition: sopc_types.h:5868
SOPC_ReturnStatus SOPC_ClientHelperNew_Disconnect(SOPC_ClientConnection **secureConnection)
Disconnects the connection established with SOPC_ClientHelperNew_Connect in a blocking way (synchrono...
SOPC_ReturnStatus SOPC_ClientHelperNew_Subscription_CreateMonitoredItems(const SOPC_ClientHelper_Subscription *subscription, OpcUa_CreateMonitoredItemsRequest *monitoredItemsReq, const uintptr_t *monitoredItemCtxArray, OpcUa_CreateMonitoredItemsResponse *monitoredItemsResp)
Creates new monitored items on the given subscription. A context array might be provided and context ...
uint32_t SOPC_StatusCode
Definition: libs2opc_client.h:60
SOPC_ReturnStatus SOPC_ClientHelperNew_Subscription_AsyncService(const SOPC_ClientHelper_Subscription *subscription, void *subOrMIrequest, uintptr_t userContext)
Executes an OPC UA service on server related to the given subscription asynchronously....
@ SOPC_ClientConnectionEvent_Disconnected
Definition: libs2opc_new_client.h:60
Definition: sopc_types.h:5818
SOPC_ReturnStatus SOPC_ClientHelperNew_ServiceSync(SOPC_ClientConnection *secureConnection, void *request, void **response)
Executes an OPC UA service on server (read, write, browse, discovery service, etc....
struct SOPC_ClientConnection SOPC_ClientConnection
Structure representing a secure connection to a server.
Definition: libs2opc_new_client.h:56
@ SOPC_ClientConnectionEvent_Reconnecting
Definition: libs2opc_new_client.h:70
SOPC_ReturnStatus SOPC_ClientHelperNew_DeleteSubscription(SOPC_ClientHelper_Subscription **subscription)
Deletes a subscription on the server.
SOPC_ReturnStatus SOPC_ClientHelperNew_Subscription_DeleteMonitoredItems(const SOPC_ClientHelper_Subscription *subscription, OpcUa_DeleteMonitoredItemsRequest *delMonitoredItemsReq, OpcUa_DeleteMonitoredItemsResponse *delMonitoredItemsResp)
Deletes monitored items on the given subscription using the server monitored item ids....
SOPC_ReturnStatus SOPC_ClientHelperNew_Subscription_SyncService(const SOPC_ClientHelper_Subscription *subscription, void *subOrMIrequest, void **subOrMIresponse)
Executes an OPC UA service on server related to the given subscription synchronously.
void SOPC_ClientSubscriptionNotification_Fct(const SOPC_ClientHelper_Subscription *subscription, SOPC_StatusCode status, SOPC_EncodeableType *notificationType, uint32_t nbNotifElts, const void *notification, uintptr_t *monitoredItemCtxArray)
Type of callback called on Subscription Notification.
Definition: libs2opc_new_client.h:307
void SOPC_ClientConnectionEvent_Fct(SOPC_ClientConnection *config, SOPC_ClientConnectionEvent event, SOPC_StatusCode status)
Type of callback called on client connection event.
Definition: libs2opc_new_client.h:84
SOPC_ClientHelper_Subscription * SOPC_ClientHelperNew_CreateSubscription(SOPC_ClientConnection *secureConnection, OpcUa_CreateSubscriptionRequest *subParams, SOPC_ClientSubscriptionNotification_Fct *subNotifCb, uintptr_t userParam)
Creates a subscription on the server.
SOPC_ClientConnection * SOPC_ClientHelperNew_GetSecureConnection(const SOPC_ClientHelper_Subscription *subscription)
Gets the secure connection on which the subscription rely on.
Definition: sopc_types.h:5841
SOPC_ReturnStatus SOPC_ClientHelperNew_DiscoveryServiceSync(SOPC_SecureConnection_Config *secConnConfig, void *request, void **response)
Send a discovery request without user session creation and activation and retrieve response synchrono...
SOPC_ReturnStatus SOPC_ClientHelperNew_Subscription_SetAvailableTokens(SOPC_ClientHelper_Subscription *subscription, uint32_t nbPublishTokens)
Sets the number of publish tokens to be used for the subscription. This number shall be greater than ...
SOPC_ClientConnectionEvent
Definition: libs2opc_new_client.h:59
SOPC_ReturnStatus SOPC_ClientHelperNew_Subscription_GetRevisedParameters(SOPC_ClientHelper_Subscription *subscription, double *revisedPublishingInterval, uint32_t *revisedLifetimeCount, uint32_t *revisedMaxKeepAliveCount)
Gets the created subscription parameters values revised by the server.
Definition: sopc_types.h:5562
SOPC_ReturnStatus SOPC_ClientHelperNew_DiscoveryServiceAsync(SOPC_SecureConnection_Config *secConnConfig, void *request, uintptr_t userContext)
Send a discovery request without user session creation and activation and retrieve response asynchron...
Definition: sopc_types.h:5586
Structure representing a secure connection configuration (secure channel + session) which allow to es...
Definition: sopc_user_app_itf.h:221
uintptr_t SOPC_ClientHelperNew_Subscription_GetUserParam(const SOPC_ClientHelper_Subscription *subscription)
Returns the user parameter defined in SOPC_ClientHelperNew_CreateSubscription.
SOPC_ReturnStatus SOPC_ClientHelperNew_ServiceAsync(SOPC_ClientConnection *secureConnection, void *request, uintptr_t userContext)
Executes an OPC UA service on server (read, write, browse, discovery service, etc....
@ SOPC_ClientConnectionEvent_Connected
Definition: libs2opc_new_client.h:66
Encodeable object type structure definition. It provides all the services functions associated with t...
Definition: sopc_encodeabletype.h:161
SOPC_ReturnStatus SOPC_ClientHelperNew_Connect(SOPC_SecureConnection_Config *secConnConfig, SOPC_ClientConnectionEvent_Fct *connectEventCb, SOPC_ClientConnection **secureConnection)
Establishes the connection in a blocking way (synchronously).
SOPC_ReturnStatus
Definition: libs2opc_client.h:64