UA Bundle SDK .NET  2.2.3.276
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaServer.SessionPublishQueue Class Reference

Manages the publish queues for a session. More...

Inherits IDisposable.

Public Member Functions

 SessionPublishQueue (ServerManager server, Session session, uint maxPublishRequests)
 Creates a new queue. More...
 
void Dispose ()
 Frees any unmanaged resources. More...
 
IList< SubscriptionClose ()
 Clears the queues because the session is closing. More...
 
void Add (Subscription subscription)
 Adds a subscription from the publish queue. More...
 
void Remove (Subscription subscription)
 Removes a subscription from the publish queue. More...
 
void SubscriptionStatusChange (Subscription subscription, StatusCode status)
 Subscriptions the status change. More...
 
NotificationMessage NextStatusChange (out uint subscriptionId)
 Nexts the status change on the queue. More...
 
void Acknowledge (RequestContext context, SubscriptionAcknowledgementCollection subscriptionAcknowledgements, out StatusCodeCollection acknowledgeResults)
 Processes acknowledgements for previously published messages. More...
 
Subscription Publish (RequestContext context, bool requeue, IEndpointIncomingRequest incoming)
 Returns a subscription that is ready to publish. More...
 
Subscription CompletePublish (bool requeue, StatusCode error, object callbackData)
 Completes the publish. More...
 
void PublishCompleted (Subscription subscription, bool moreNotifications)
 Adds a subscription back into the queue because it has more notifications to publish. More...
 
void PublishTimerExpired ()
 Checks the state of the subscriptions. More...
 

Protected Member Functions

virtual void Dispose (bool disposing)
 An overrideable version of the Dispose. More...
 

Detailed Description

Manages the publish queues for a session.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.SessionPublishQueue.SessionPublishQueue ( ServerManager  server,
Session  session,
uint  maxPublishRequests 
)
inline

Creates a new queue.

Member Function Documentation

void UnifiedAutomation.UaServer.SessionPublishQueue.Acknowledge ( RequestContext  context,
SubscriptionAcknowledgementCollection  subscriptionAcknowledgements,
out StatusCodeCollection  acknowledgeResults 
)
inline

Processes acknowledgements for previously published messages.

void UnifiedAutomation.UaServer.SessionPublishQueue.Add ( Subscription  subscription)
inline

Adds a subscription from the publish queue.

IList<Subscription> UnifiedAutomation.UaServer.SessionPublishQueue.Close ( )
inline

Clears the queues because the session is closing.

Returns
The list of subscriptions in the queue.
Subscription UnifiedAutomation.UaServer.SessionPublishQueue.CompletePublish ( bool  requeue,
StatusCode  error,
object  callbackData 
)
inline

Completes the publish.

Parameters
requeueif set to true the request must be requeued.
errorThe error.
callbackDataThe callback data.
Returns
void UnifiedAutomation.UaServer.SessionPublishQueue.Dispose ( )
inline

Frees any unmanaged resources.

virtual void UnifiedAutomation.UaServer.SessionPublishQueue.Dispose ( bool  disposing)
inlineprotectedvirtual

An overrideable version of the Dispose.

NotificationMessage UnifiedAutomation.UaServer.SessionPublishQueue.NextStatusChange ( out uint  subscriptionId)
inline

Nexts the status change on the queue.

Parameters
subscriptionIdThe subscription id.
Subscription UnifiedAutomation.UaServer.SessionPublishQueue.Publish ( RequestContext  context,
bool  requeue,
IEndpointIncomingRequest  incoming 
)
inline

Returns a subscription that is ready to publish.

void UnifiedAutomation.UaServer.SessionPublishQueue.PublishCompleted ( Subscription  subscription,
bool  moreNotifications 
)
inline

Adds a subscription back into the queue because it has more notifications to publish.

void UnifiedAutomation.UaServer.SessionPublishQueue.PublishTimerExpired ( )
inline

Checks the state of the subscriptions.

void UnifiedAutomation.UaServer.SessionPublishQueue.Remove ( Subscription  subscription)
inline

Removes a subscription from the publish queue.

void UnifiedAutomation.UaServer.SessionPublishQueue.SubscriptionStatusChange ( Subscription  subscription,
StatusCode  status 
)
inline

Subscriptions the status change.

Parameters
subscriptionThe subscription.
statusThe status.

The documentation for this class was generated from the following file: