UA Ansi C Server Professional  1.3.1.232
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
UaServerSubscription

Data Structures

struct  _UaServer_CreateSubscriptionContext
 Holds all data to handle the CreateSubscriptionRequest. More...
struct  _UaServer_ModifySubscriptionContext
 Holds all data to handle the ModifySubscriptionRequest. More...
struct  _UaServer_DeleteSubscriptionsContext
 Holds all data to handle the DeleteSubscriptionRequest. More...
struct  _UaServer_TransferSubscriptionsContext
 Holds all data to handle the TransferSubscriptionRequest. More...
struct  _UaServer_Subscription
 UaServer_Subscription Structure. More...

Typedefs

typedef enum
_UaServer_SubscriptionState 
UaServer_SubscriptionState
 Typedef for the subscription states.

Enumerations

enum  _UaServer_SubscriptionState
 An enumeration of subscription states. More...

Functions

OpcUa_StatusCode UaServer_CreateSubscriptionContext_Create (UaServer_CreateSubscriptionContext **a_ppCreateSubscriptionContext)
 Creates a new context of subscriptions.
OpcUa_Void UaServer_CreateSubscriptionContext_Delete (UaServer_CreateSubscriptionContext **a_ppCreateSubscriptionContext)
 Deletes a context of subscriptions.
OpcUa_StatusCode UaServer_DeleteSubscriptionsContext_Create (UaServer_DeleteSubscriptionsContext **a_ppDeleteSubscriptionsContext)
 ToDoDoc.
OpcUa_Void UaServer_DeleteSubscriptionsContext_Delete (UaServer_DeleteSubscriptionsContext **a_ppDeleteSubscriptionsContext)
 ToDoDoc.
OpcUa_StatusCode UaServer_TransferSubscriptionsContext_Create (UaServer_TransferSubscriptionsContext **a_ppTransferSubscriptionsContext)
 ToDoDoc.
OpcUa_Void UaServer_TransferSubscriptionsContext_Delete (UaServer_TransferSubscriptionsContext **a_ppTransferSubscriptionsContext)
 ToDoDoc.
OpcUa_StatusCode UaServer_ModifySubscriptionContext_Create (UaServer_ModifySubscriptionContext **a_ppModifySubscriptionContext)
 ToDoDoc.
OpcUa_Void UaServer_ModifySubscriptionContext_Delete (UaServer_ModifySubscriptionContext **a_ppModifySubscriptionContext)
 ToDoDoc.
OpcUa_Void UaServer_Subscription_Delete (UaServer_Subscription **a_ppSubscription)
 Deletes the subscription itself.
OpcUa_StatusCode UaServer_Subscription_Create (UaServer_Subscription **a_ppSubscription)
 Create a Subscription Identifier.
OpcUa_StatusCode UaServer_EndCreateSubscription (OpcUa_StatusCode a_uStatusCode, UaServer_CreateSubscriptionContext *a_pCreateSubscriptionContext)
 Ends to create new subscriptions.
OpcUa_StatusCode UaServer_EndModifySubscription (OpcUa_StatusCode a_uStatusCode, UaServer_ModifySubscriptionContext *a_pModifySubscriptionContext)
 Ends to modify subscriptions.
OpcUa_StatusCode UaServer_EndDeleteSubscriptions (OpcUa_StatusCode a_uStatusCode, UaServer_DeleteSubscriptionsContext *a_pDeleteSubscriptionsContext)
 Ends up to delete the subscription.
OpcUa_StatusCode UaServer_EndTransferSubscriptions (OpcUa_StatusCode a_uStatusCode, UaServer_TransferSubscriptionsContext *a_pTransferSubscriptionsContext)
 Ends to Transfer subscriptions.
OpcUa_StatusCode UaServer_BeginCreateSubscription (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
 Starts to create a new subscription.
OpcUa_StatusCode UaServer_BeginModifySubscription (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
 Starts to modify a subscription.
OpcUa_StatusCode UaServer_BeginDeleteSubscriptions (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
 This function starts to delete subscriptions.
OpcUa_StatusCode UaServer_BeginTransferSubscriptions (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
 This function starts to transfer subscriptions.
OpcUa_StatusCode UaServer_BeginSetPublishingMode (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
 Sets the publishing mode.

Detailed Description

Typedef Documentation

Typedef for the subscription states.

Enumeration Type Documentation

An enumeration of subscription states.

Function Documentation

OpcUa_StatusCode UaServer_BeginCreateSubscription ( OpcUa_Endpoint  a_hEndpoint,
OpcUa_Handle  a_hContext,
OpcUa_Void **  a_ppRequest,
OpcUa_EncodeableType *  a_pRequestType 
)

Starts to create a new subscription.

Parameters
a_hEndpointhandle to the endpoint.
a_hContextGeneral context containing information like the session object.
a_ppRequestthe request of the current send information.
a_pRequestType[in] The type of request.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_BeginDeleteSubscriptions ( OpcUa_Endpoint  a_hEndpoint,
OpcUa_Handle  a_hContext,
OpcUa_Void **  a_ppRequest,
OpcUa_EncodeableType *  a_pRequestType 
)

This function starts to delete subscriptions.

Parameters
a_hEndpointhandle to the endpoint.
a_hContextGeneral context containing information like the session object.
a_ppRequestthe request of the current send information.
a_pRequestType[in] The type of request.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_BeginModifySubscription ( OpcUa_Endpoint  a_hEndpoint,
OpcUa_Handle  a_hContext,
OpcUa_Void **  a_ppRequest,
OpcUa_EncodeableType *  a_pRequestType 
)

Starts to modify a subscription.

Parameters
a_hEndpointhandle to the endpoint.
a_hContextGeneral context containing information like the session object.
a_ppRequestthe request of the current send information.
a_pRequestType[in] The type of request.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_BeginSetPublishingMode ( OpcUa_Endpoint  a_hEndpoint,
OpcUa_Handle  a_hContext,
OpcUa_Void **  a_ppRequest,
OpcUa_EncodeableType *  a_pRequestType 
)

Sets the publishing mode.

Parameters
a_hEndpointhandle to the endpoint.
a_hContextGeneral context containing information like the session object.
a_ppRequestthe request of the current send information.
a_pRequestType[in] The type of request.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_BeginTransferSubscriptions ( OpcUa_Endpoint  a_hEndpoint,
OpcUa_Handle  a_hContext,
OpcUa_Void **  a_ppRequest,
OpcUa_EncodeableType *  a_pRequestType 
)

This function starts to transfer subscriptions.

Parameters
a_hEndpointhandle to the endpoint.
a_hContextGeneral context containing information like the session object.
a_ppRequestthe request of the current send information.
a_pRequestType[in] The type of request.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_CreateSubscriptionContext_Create ( UaServer_CreateSubscriptionContext **  a_ppCreateSubscriptionContext)

Creates a new context of subscriptions.

Parameters
a_ppCreateSubscriptionContexta pointer to a context of available subscriptions.
Returns
the OPC UA Status code.
OpcUa_Void UaServer_CreateSubscriptionContext_Delete ( UaServer_CreateSubscriptionContext **  a_ppCreateSubscriptionContext)

Deletes a context of subscriptions.

Parameters
a_ppCreateSubscriptionContexta pointer to a context of available subscriptions.
OpcUa_StatusCode UaServer_DeleteSubscriptionsContext_Create ( UaServer_DeleteSubscriptionsContext **  a_ppDeleteSubscriptionsContext)

ToDoDoc.

Parameters
a_ppDeleteSubscriptionsContexta pointer to a context of available subscriptions to delete.
Returns
the OPC UA Status code.
OpcUa_Void UaServer_DeleteSubscriptionsContext_Delete ( UaServer_DeleteSubscriptionsContext **  a_ppDeleteSubscriptionsContext)

ToDoDoc.

Parameters
a_ppDeleteSubscriptionsContexta pointer to a context of available subscriptions to delete.
OpcUa_StatusCode UaServer_EndCreateSubscription ( OpcUa_StatusCode  a_uStatusCode,
UaServer_CreateSubscriptionContext a_pCreateSubscriptionContext 
)

Ends to create new subscriptions.

Parameters
a_uStatusCodeError code.
a_pCreateSubscriptionContexta pointer to a context of available subscriptions to create.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_EndDeleteSubscriptions ( OpcUa_StatusCode  a_uStatusCode,
UaServer_DeleteSubscriptionsContext a_pDeleteSubscriptionsContext 
)

Ends up to delete the subscription.

Parameters
a_uStatusCodeError code.
a_pDeleteSubscriptionsContexta pointer to a context of available subscriptions to delete.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_EndModifySubscription ( OpcUa_StatusCode  a_uStatusCode,
UaServer_ModifySubscriptionContext a_pModifySubscriptionContext 
)

Ends to modify subscriptions.

Parameters
a_uStatusCodeError code.
a_pModifySubscriptionContexta pointer to a context of available subscriptions to modify.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_EndTransferSubscriptions ( OpcUa_StatusCode  a_uStatusCode,
UaServer_TransferSubscriptionsContext a_pTransferSubscriptionsContext 
)

Ends to Transfer subscriptions.

Parameters
[in]a_uStatusCodeError code.
[in]a_pTransferSubscriptionsContexta pointer to a context of available subscriptions to Transfer.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaServer_ModifySubscriptionContext_Create ( UaServer_ModifySubscriptionContext **  a_ppModifySubscriptionContext)

ToDoDoc.

OpcUa_Void UaServer_ModifySubscriptionContext_Delete ( UaServer_ModifySubscriptionContext **  a_ppModifySubscriptionContext)

ToDoDoc.

OpcUa_StatusCode UaServer_Subscription_Create ( UaServer_Subscription **  a_ppSubscription)

Create a Subscription Identifier.

Parameters
a_ppSubscriptiona pointer to the subscription structure.
Returns
the OPC UA Status code.
OpcUa_Void UaServer_Subscription_Delete ( UaServer_Subscription **  a_ppSubscription)

Deletes the subscription itself.

Parameters
a_ppSubscriptiona pointer to the subscription structure.
OpcUa_StatusCode UaServer_TransferSubscriptionsContext_Create ( UaServer_TransferSubscriptionsContext **  a_ppTransferSubscriptionsContext)

ToDoDoc.

OpcUa_Void UaServer_TransferSubscriptionsContext_Delete ( UaServer_TransferSubscriptionsContext **  a_ppTransferSubscriptionsContext)

ToDoDoc.