ua_client.h 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. #ifndef UA_CLIENT_H_
  2. #define UA_CLIENT_H_
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6. #include "ua_config.h"
  7. #include "ua_types.h"
  8. #include "ua_connection.h"
  9. #include "ua_log.h"
  10. #include "ua_types_generated.h"
  11. struct UA_Client;
  12. typedef struct UA_Client UA_Client;
  13. /**
  14. * The client networklayer is defined by a single function that fills a UA_Connection struct after
  15. * successfully connecting.
  16. */
  17. typedef UA_Connection (*UA_ConnectClientConnection)(UA_ConnectionConfig localConf, char *endpointUrl,
  18. UA_Logger *logger);
  19. typedef struct UA_ClientConfig {
  20. UA_Int32 timeout; //sync response timeout
  21. UA_Int32 secureChannelLifeTime; // lifetime in ms (then the channel needs to be renewed)
  22. UA_Int32 timeToRenewSecureChannel; //time in ms before expiration to renew the secure channel
  23. UA_ConnectionConfig localConnectionConfig;
  24. } UA_ClientConfig;
  25. extern UA_EXPORT const UA_ClientConfig UA_ClientConfig_standard;
  26. UA_Client UA_EXPORT * UA_Client_new(UA_ClientConfig config, UA_Logger logger);
  27. UA_EXPORT void UA_Client_reset(UA_Client* client);
  28. UA_EXPORT void UA_Client_init(UA_Client* client, UA_ClientConfig config, UA_Logger logger);
  29. UA_EXPORT void UA_Client_deleteMembers(UA_Client* client);
  30. UA_EXPORT void UA_Client_delete(UA_Client* client);
  31. UA_StatusCode UA_EXPORT UA_Client_connect(UA_Client *client, UA_ConnectClientConnection connFunc, char *endpointUrl);
  32. UA_StatusCode UA_EXPORT UA_Client_disconnect(UA_Client *client);
  33. UA_StatusCode UA_EXPORT UA_Client_renewSecureChannel(UA_Client *client);
  34. /* Attribute Service Set */
  35. UA_ReadResponse UA_EXPORT UA_Client_read(UA_Client *client, UA_ReadRequest *request);
  36. UA_WriteResponse UA_EXPORT UA_Client_write(UA_Client *client, UA_WriteRequest *request);
  37. /* View Service Set */
  38. UA_BrowseResponse UA_EXPORT UA_Client_browse(UA_Client *client, UA_BrowseRequest *request);
  39. UA_BrowseNextResponse UA_EXPORT UA_Client_browseNext(UA_Client *client, UA_BrowseNextRequest *request);
  40. UA_TranslateBrowsePathsToNodeIdsResponse UA_EXPORT
  41. UA_Client_translateTranslateBrowsePathsToNodeIds(UA_Client *client,
  42. UA_TranslateBrowsePathsToNodeIdsRequest *request);
  43. /* NodeManagement Service Set */
  44. UA_AddNodesResponse UA_EXPORT UA_Client_addNodes(UA_Client *client, UA_AddNodesRequest *request);
  45. UA_AddReferencesResponse UA_EXPORT
  46. UA_Client_addReferences(UA_Client *client, UA_AddReferencesRequest *request);
  47. UA_DeleteNodesResponse UA_EXPORT UA_Client_deleteNodes(UA_Client *client, UA_DeleteNodesRequest *request);
  48. UA_DeleteReferencesResponse UA_EXPORT
  49. UA_Client_deleteReferences(UA_Client *client, UA_DeleteReferencesRequest *request);
  50. /* Client-Side Macro/Procy functions */
  51. #ifdef ENABLE_METHODCALLS
  52. UA_CallResponse UA_EXPORT UA_Client_call(UA_Client *client, UA_CallRequest *request);
  53. UA_StatusCode UA_EXPORT UA_Client_CallServerMethod(UA_Client *client, UA_NodeId objectNodeId, UA_NodeId methodNodeId,
  54. UA_Int32 inputSize, const UA_Variant *input,
  55. UA_Int32 *outputSize, UA_Variant **output);
  56. #endif
  57. UA_AddNodesResponse UA_EXPORT *UA_Client_createObjectNode( UA_Client *client, UA_ExpandedNodeId reqId, UA_QualifiedName browseName, UA_LocalizedText displayName,
  58. UA_LocalizedText description, UA_ExpandedNodeId parentNodeId, UA_NodeId referenceTypeId,
  59. UA_UInt32 userWriteMask, UA_UInt32 writeMask, UA_ExpandedNodeId typeDefinition);
  60. UA_AddNodesResponse UA_EXPORT *UA_Client_createVariableNode(UA_Client *client, UA_ExpandedNodeId reqId, UA_QualifiedName browseName, UA_LocalizedText displayName,
  61. UA_LocalizedText description, UA_ExpandedNodeId parentNodeId, UA_NodeId referenceTypeId,
  62. UA_UInt32 userWriteMask, UA_UInt32 writeMask, UA_ExpandedNodeId typeDefinition,
  63. UA_NodeId dataType, UA_Variant *value );
  64. UA_AddNodesResponse UA_EXPORT *UA_Client_createReferenceTypeNode(UA_Client *client, UA_ExpandedNodeId reqId, UA_QualifiedName browseName, UA_LocalizedText displayName,
  65. UA_LocalizedText description, UA_ExpandedNodeId parentNodeId, UA_NodeId referenceTypeId,
  66. UA_UInt32 userWriteMask, UA_UInt32 writeMask, UA_ExpandedNodeId typeDefinition,
  67. UA_LocalizedText inverseName );
  68. UA_AddNodesResponse UA_EXPORT *UA_Client_createObjectTypeNode(UA_Client *client, UA_ExpandedNodeId reqId, UA_QualifiedName browseName, UA_LocalizedText displayName,
  69. UA_LocalizedText description, UA_ExpandedNodeId parentNodeId, UA_NodeId referenceTypeId,
  70. UA_UInt32 userWriteMask, UA_UInt32 writeMask, UA_ExpandedNodeId typeDefinition);
  71. #ifdef ENABLE_SUBSCRIPTIONS
  72. UA_Int32 UA_EXPORT UA_Client_newSubscription(UA_Client *client, UA_Int32 publishInterval);
  73. UA_StatusCode UA_EXPORT UA_Client_removeSubscription(UA_Client *client, UA_UInt32 subscriptionId);
  74. //void UA_EXPORT UA_Client_modifySubscription(UA_Client *client);
  75. void UA_EXPORT UA_Client_doPublish(UA_Client *client);
  76. UA_UInt32 UA_EXPORT UA_Client_monitorItemChanges(UA_Client *client, UA_UInt32 subscriptionId,
  77. UA_NodeId nodeId, UA_UInt32 attributeID,
  78. void *handlingFunction);
  79. UA_StatusCode UA_EXPORT UA_Client_unMonitorItemChanges(UA_Client *client, UA_UInt32 subscriptionId,
  80. UA_UInt32 monitoredItemId );
  81. #endif
  82. #ifdef __cplusplus
  83. } // extern "C"
  84. #endif
  85. #endif /* UA_CLIENT_H_ */