UaServerSubscription


Data Structures

struct  _UaServer_Subscription
 UaServer_Subscription Structure. More...

Typedefs

typedef struct
_UaServer_CreateSubscriptionContext 		UaServer_CreateSubscriptionContext
 Holds all data to handle the CreateSubscriptionRequest.
typedef struct
_UaServer_ModifySubscriptionContext 		UaServer_ModifySubscriptionContext
 Holds all data to handle the ModifySubscriptionRequest.
typedef struct
_UaServer_DeleteSubscriptionsContext 		UaServer_DeleteSubscriptionsContext
 Holds all data to handle the DeleteSubscriptionRequest.
typedef struct
_UaServer_TransferSubscriptionsContext 		UaServer_TransferSubscriptionsContext
 Holds all data to handle the TransferSubscriptionRequest.

Enumerations

enum  _UaServer_SubscriptionState {
  UaServer_SubscriptionState_Closed, UaServer_SubscriptionState_Creating, UaServer_SubscriptionState_Normal, UaServer_SubscriptionState_Late,
  UaServer_SubscriptionState_Keepalive
}
 UaServer_SubscriptionState Enumeration. 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_Subscription_Delete (UaServer_Subscription **a_ppSubscription)
 Deletes the subscription itself.
OpcUa_StatusCode UaServer_Subscription_Create (UaServer_Subscription **a_ppSubscription, UaServer_Session *a_pSession, OpcUa_UInt32 a_uPublishingInterval, OpcUa_UInt32 a_uMaxKeepAliveCount, OpcUa_UInt32 a_uMaxLifeTimeCount, OpcUa_Boolean a_bPublishingEnabled)
 Create a Subscription Identifier.
OpcUa_Void UaServer_TransferSubscriptionsContext_Delete (UaServer_TransferSubscriptionsContext **a_ppTransferSubscriptionsContext)
 ToDoDoc.
OpcUa_StatusCode UaServer_EndCreateSubscription (OpcUa_StatusCode a_uStatusCode, UaServer_CreateSubscriptionContext *a_pCreateSubscriptionContext)
 Ends to create new 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_SetPublishingMode (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
 Sets the publishing mode.

Typedef Documentation

typedef struct _UaServer_CreateSubscriptionContext UaServer_CreateSubscriptionContext

Holds all data to handle the CreateSubscriptionRequest.

typedef struct _UaServer_DeleteSubscriptionsContext UaServer_DeleteSubscriptionsContext

Holds all data to handle the DeleteSubscriptionRequest.

Deletes all data needed to manage the sessions in an ua server.

typedef struct _UaServer_ModifySubscriptionContext UaServer_ModifySubscriptionContext

Holds all data to handle the ModifySubscriptionRequest.

typedef struct _UaServer_TransferSubscriptionsContext UaServer_TransferSubscriptionsContext

Holds all data to handle the TransferSubscriptionRequest.

Enumeration Type Documentation

enum _UaServer_SubscriptionState

UaServer_SubscriptionState Enumeration.

Enumerator:
UaServer_SubscriptionState_Closed  Item 1.
UaServer_SubscriptionState_Creating  Item 1.
UaServer_SubscriptionState_Normal  Item 1.
UaServer_SubscriptionState_Late  Item 1.
UaServer_SubscriptionState_Keepalive  Item 1.

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_hEndpoint handle to the endpoint.
a_hContext General context containing information like the session object.
a_ppRequest the 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_hEndpoint handle to the endpoint.
a_hContext General context containing information like the session object.
a_ppRequest the 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_hEndpoint handle to the endpoint.
a_hContext General context containing information like the session object.
a_ppRequest the 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_hEndpoint handle to the endpoint.
a_hContext General context containing information like the session object.
a_ppRequest the 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_ppCreateSubscriptionContext a 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_ppCreateSubscriptionContext a pointer to a context of available subscriptions.

OpcUa_StatusCode UaServer_DeleteSubscriptionsContext_Create ( UaServer_DeleteSubscriptionsContext **  a_ppDeleteSubscriptionsContext  ) 

ToDoDoc.

Parameters:
a_ppDeleteSubscriptionsContext a 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_ppDeleteSubscriptionsContext a 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_uStatusCode Error code.
a_pCreateSubscriptionContext a 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_uStatusCode Error code.
a_pDeleteSubscriptionsContext a pointer to a context of available subscriptions to delete.
Returns:
the OPC UA Status code.

OpcUa_StatusCode UaServer_EndTransferSubscriptions ( OpcUa_StatusCode  a_uStatusCode,
UaServer_TransferSubscriptionsContext *  a_pTransferSubscriptionsContext 
)

Ends to Transfer subscriptions.

Parameters:
a_uStatusCode Error code.
a_pTransferSubscriptionContext a pointer to a context of available subscriptions to Transfer.
Returns:
the OPC UA Status code.

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

Sets the publishing mode.

Parameters:
a_hEndpoint handle to the endpoint.
a_hContext General context containing information like the session object.
a_ppRequest the request of the current send information.
a_pRequestType [in] The type of request.
Returns:
the OPC UA Status code.

OpcUa_StatusCode UaServer_Subscription_Create ( UaServer_Subscription **  a_ppSubscription,
UaServer_Session *  a_pSession,
OpcUa_UInt32  a_uPublishingInterval,
OpcUa_UInt32  a_uMaxKeepAliveCount,
OpcUa_UInt32  a_uMaxLifeTimeCount,
OpcUa_Boolean  a_bPublishingEnabled 
)

Create a Subscription Identifier.

Parameters:
a_ppSubscription a pointer to the subscription structure.
a_pSession a pointer to the actual sessionmanager.
a_uPublishingInterval the interval count of the publishing interval.
a_uMaxKeepAliveCount the maximum tick of a keep alive count.
a_bPublishingEnabled true if publishing is enabled false if not.
Returns:
the OPC UA Status code.

OpcUa_Void UaServer_Subscription_Delete ( UaServer_Subscription **  a_ppSubscription  ) 

Deletes the subscription itself.

Parameters:
a_ppSubscription a 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.