UaServerPublish


Typedefs

typedef
typedefOPCUA_BEGIN_EXTERN_C
struct
_UaServer_PublishContext 		UaServer_PublishContext
 Holds all data to handle the PublishRequest.
typedef struct
_UaServer_RepublishContext 		UaServer_RepublishContext
 Holds all data to handle the RepublishRequest.

Functions

OpcUa_Void UaServer_PublishContext_Delete (UaServer_PublishContext **a_ppPublishContext)
 Delete the publish context.
OpcUa_StatusCode UaServer_PublishContext_Create (UaServer_PublishContext **a_ppPublishContext)
 Create a new publish context.
OpcUa_Void UaServer_RepublishContext_Delete (UaServer_RepublishContext **a_ppRepublishContext)
 Delete the republish context.
OpcUa_StatusCode UaServer_RepublishContext_Create (UaServer_RepublishContext **a_ppRepublishContext)
 Create a new republish context.
OpcUa_StatusCode UaServer_EndPublish (OpcUa_StatusCode a_uStatusCode, UaServer_PublishContext *a_pPublishContext)
 Ends to publish the context.
OpcUa_StatusCode UaServer_EndRepublish (OpcUa_StatusCode a_uStatusCode, UaServer_RepublishContext *a_pRepublishContext)
 Ends to republish the context.
OpcUa_StatusCode UaServer_Publish (UaServer_PublishContext *a_pPublishContext, UaServer_Subscription *a_pSubscription)
 Gets called only by the subscriptionmanager, if it determines that it is time to publish.
OpcUa_StatusCode UaServer_QueuePublish (UaServer_PublishContext *a_pPublishContext)
 Queues up the publish.
OpcUa_StatusCode UaServer_DequeuePublish (UaServer_Session *a_pSession, UaServer_PublishContext **a_ppPublishContext)
 dequeues the publish.
OpcUa_StatusCode UaServer_DeleteAllPublish (UaServer_Session *a_pSession)
 Deletes all publishes.
OpcUa_StatusCode UaServer_BeginPublish (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
 Starts to publish.
OpcUa_StatusCode UaServer_BeginRepublish (OpcUa_Endpoint a_hEndpoint, OpcUa_Handle a_hContext, OpcUa_Void **a_ppRequest, OpcUa_EncodeableType *a_pRequestType)
 Republish.

Typedef Documentation

typedef typedefOPCUA_BEGIN_EXTERN_C struct _UaServer_PublishContext UaServer_PublishContext

Holds all data to handle the PublishRequest.

typedef struct _UaServer_RepublishContext UaServer_RepublishContext

Holds all data to handle the RepublishRequest.

Function Documentation

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

Starts to publish.

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_BeginRepublish ( OpcUa_Endpoint  a_hEndpoint,
OpcUa_Handle  a_hContext,
OpcUa_Void **  a_ppRequest,
OpcUa_EncodeableType *  a_pRequestType 
)

Republish.

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_DeleteAllPublish ( UaServer_Session *  a_pSession  ) 

Deletes all publishes.

Parameters:
a_pSession a pointer to the actual session.
Returns:
the OPC UA Status code.

OpcUa_StatusCode UaServer_DequeuePublish ( UaServer_Session *  a_pSession,
UaServer_PublishContext **  a_ppPublishContext 
)

dequeues the publish.

Parameters:
a_pSession a pointer to the actual session.
a_ppPublishContext a pointer to the information of the PublishContext.
Returns:
the OPC UA Status code.

OpcUa_StatusCode UaServer_EndPublish ( OpcUa_StatusCode  a_uStatusCode,
UaServer_PublishContext *  a_pPublishContext 
)

Ends to publish the context.

Parameters:
a_uStatusCode Error code.
a_pPublishContext a pointer to the information of the PublishContext.
Returns:
the OPC UA Status code.

OpcUa_StatusCode UaServer_EndRepublish ( OpcUa_StatusCode  a_uStatusCode,
UaServer_RepublishContext *  a_pRepublishContext 
)

Ends to republish the context.

Parameters:
a_uStatusCode Error code.
a_pRepublishContext a pointer to the information of the RepublishContext.
Returns:
the OPC UA Status code.

OpcUa_StatusCode UaServer_Publish ( UaServer_PublishContext *  a_pPublishContext,
UaServer_Subscription *  a_pSubscription 
)

Gets called only by the subscriptionmanager, if it determines that it is time to publish.

Parameters:
a_pPublishContext a pointer to the information of the PublishContext.
a_pSubscription a pointer to the subscription structure.
Returns:
the OPC UA Status code.

OpcUa_StatusCode UaServer_PublishContext_Create ( UaServer_PublishContext **  a_ppPublishContext  ) 

Create a new publish context.

Parameters:
a_ppPublishContext a pointer to the information of the PublishContext.
Returns:
the OPC UA Status code.

OpcUa_Void UaServer_PublishContext_Delete ( UaServer_PublishContext **  a_ppPublishContext  ) 

Delete the publish context.

Parameters:
a_ppPublishContext a pointer to the information of the PublishContext.

OpcUa_StatusCode UaServer_QueuePublish ( UaServer_PublishContext *  a_pPublishContext  ) 

Queues up the publish.

Parameters:
a_pPublishContext a pointer to the information of the PublishContext.
Returns:
the OPC UA Status code.

OpcUa_StatusCode UaServer_RepublishContext_Create ( UaServer_RepublishContext **  a_ppRepublishContext  ) 

Create a new republish context.

Parameters:
a_ppRepublishContext a pointer to the information of the RepublishContext.
Returns:
the OPC UA Status code.

OpcUa_Void UaServer_RepublishContext_Delete ( UaServer_RepublishContext **  a_ppRepublishContext  ) 

Delete the republish context.

Parameters:
a_ppRepublishContext a pointer to the information of the RepublishContext.