UA Bundle SDK .NET
2.1.0.222
|
A generic session manager object for a server. More...
Inherits IDisposable, and UnifiedAutomation.UaServer.ISubscriptionManager.
Public Member Functions | |
SubscriptionManager (ServerManager server) | |
Initializes the manager with its configuration. | |
void | Dispose () |
Frees any unmanaged resources. | |
IList< Subscription > | GetSubscriptions (NodeId sessionId) |
Returns all of the subscriptions known to the subscription manager. | |
virtual void | Startup () |
Starts up the manager makes it ready to create subscriptions. | |
virtual void | Shutdown () |
Closes all subscriptions and rejects any new requests. | |
void | SessionOpened (Session session) |
Called when a new session is created. | |
void | SessionActivated (Session session, bool identityChanged) |
Called when a session is activated. | |
void | SessionClosed (Session session, bool deleteSubscriptions) |
Called when a new session is closed. | |
void | ConditionRefresh (RequestContext context, uint subscriptionId) |
Refreshes the conditions for the specified subscription. | |
StatusCode | DeleteSubscription (RequestContext context, uint subscriptionId) |
Deletes the specified subscription. | |
virtual void | CreateSubscription (RequestContext context, double requestedPublishingInterval, uint requestedLifetimeCount, uint requestedMaxKeepAliveCount, uint maxNotificationsPerPublish, bool publishingEnabled, byte priority, out uint subscriptionId, out double revisedPublishingInterval, out uint revisedLifetimeCount, out uint revisedMaxKeepAliveCount) |
Creates a new subscription. | |
void | DeleteSubscriptions (RequestContext context, List< uint > subscriptionIds, out StatusCodeCollection results) |
Deletes group of subscriptions. | |
PublishResponse | Publish (RequestContext context, SubscriptionAcknowledgementCollection subscriptionAcknowledgements, IEndpointIncomingRequest reqeuest) |
Publishes a subscription. | |
PublishResponse | CompletePublish (RequestContext context, IEndpointIncomingRequest incoming, StatusCode error, object callbackData) |
Completes the publish. | |
void | ModifySubscription (RequestContext context, uint subscriptionId, double requestedPublishingInterval, uint requestedLifetimeCount, uint requestedMaxKeepAliveCount, uint maxNotificationsPerPublish, byte priority, out double revisedPublishingInterval, out uint revisedLifetimeCount, out uint revisedMaxKeepAliveCount) |
Modifies an existing subscription. | |
void | SetPublishingMode (RequestContext context, bool publishingEnabled, List< uint > subscriptionIds, out StatusCodeCollection results) |
Sets the publishing mode for a set of subscriptions. | |
void | TransferSubscriptions (RequestContext context, List< uint > subscriptionIds, bool sendInitialValues, out TransferResultCollection results) |
Attaches a groups a subscriptions to a different sesssion. | |
NotificationMessage | Republish (RequestContext context, uint subscriptionId, uint retransmitSequenceNumber) |
Republishes a previously published notification message. | |
void | SetTriggering (RequestContext context, uint subscriptionId, uint triggeringItemId, UInt32Collection linksToAdd, UInt32Collection linksToRemove, out StatusCodeCollection addResults, out StatusCodeCollection removeResults) |
Updates the triggers for the monitored item. | |
Subscription | GetSubscription (RequestContext context, uint subscriptionId) |
Gets the subcription. | |
Protected Member Functions | |
virtual void | Dispose (bool disposing) |
An overrideable version of the Dispose. | |
virtual void | RaiseSubscriptionEvent (Subscription subscription, bool deleted) |
Raises an event related to a subscription. | |
virtual double | CalculatePublishingInterval (double publishingInterval) |
Calculates the publishing interval. | |
virtual uint | CalculateKeepAliveCount (double publishingInterval, uint keepAliveCount) |
Calculates the keep alive count. | |
virtual uint | CalculateLifetimeCount (double publishingInterval, uint keepAliveCount, uint lifetimeCount) |
Calculates the lifetime count. | |
virtual uint | CalculateMaxNotificationsPerPublish (uint maxNotificationsPerPublish) |
Calculates the maximum number of notifications per publish. | |
virtual Subscription | CreateSubscription (RequestContext context, uint subscriptionId, double publishingInterval, uint lifetimeCount, uint keepAliveCount, uint maxNotificationsPerPublish, byte priority, bool publishingEnabled) |
Creates a new instance of a subscription. | |
Properties | |
SubscriptionEventHandler | SubscriptionCreated |
Raised after a new subscription is created. | |
SubscriptionEventHandler | SubscriptionDeleted |
Raised before a subscription is deleted. | |
Additional Inherited Members | |
Events inherited from UnifiedAutomation.UaServer.ISubscriptionManager | |
SubscriptionEventHandler | SubscriptionCreated |
Raised after a new subscription is created. | |
SubscriptionEventHandler | SubscriptionDeleted |
Raised before a subscription is deleted. | |
A generic session manager object for a server.
UnifiedAutomation.UaServer.SubscriptionManager.SubscriptionManager | ( | ServerManager | server | ) |
Initializes the manager with its configuration.
|
protectedvirtual |
Calculates the keep alive count.
|
protectedvirtual |
Calculates the lifetime count.
|
protectedvirtual |
Calculates the maximum number of notifications per publish.
|
protectedvirtual |
Calculates the publishing interval.
PublishResponse UnifiedAutomation.UaServer.SubscriptionManager.CompletePublish | ( | RequestContext | context, |
IEndpointIncomingRequest | incoming, | ||
StatusCode | error, | ||
object | callbackData | ||
) |
Completes the publish.
context | The request context. |
incoming | The incoming. |
error | The error. |
callbackData | The callback data. |
void UnifiedAutomation.UaServer.SubscriptionManager.ConditionRefresh | ( | RequestContext | context, |
uint | subscriptionId | ||
) |
Refreshes the conditions for the specified subscription.
|
virtual |
Creates a new subscription.
|
protectedvirtual |
Creates a new instance of a subscription.
StatusCode UnifiedAutomation.UaServer.SubscriptionManager.DeleteSubscription | ( | RequestContext | context, |
uint | subscriptionId | ||
) |
Deletes the specified subscription.
void UnifiedAutomation.UaServer.SubscriptionManager.DeleteSubscriptions | ( | RequestContext | context, |
List< uint > | subscriptionIds, | ||
out StatusCodeCollection | results | ||
) |
Deletes group of subscriptions.
void UnifiedAutomation.UaServer.SubscriptionManager.Dispose | ( | ) |
Frees any unmanaged resources.
|
protectedvirtual |
An overrideable version of the Dispose.
Subscription UnifiedAutomation.UaServer.SubscriptionManager.GetSubscription | ( | RequestContext | context, |
uint | subscriptionId | ||
) |
Gets the subcription.
context | The request context. |
subscriptionId | The subscription id. |
IList<Subscription> UnifiedAutomation.UaServer.SubscriptionManager.GetSubscriptions | ( | NodeId | sessionId | ) |
Returns all of the subscriptions known to the subscription manager.
void UnifiedAutomation.UaServer.SubscriptionManager.ModifySubscription | ( | RequestContext | context, |
uint | subscriptionId, | ||
double | requestedPublishingInterval, | ||
uint | requestedLifetimeCount, | ||
uint | requestedMaxKeepAliveCount, | ||
uint | maxNotificationsPerPublish, | ||
byte | priority, | ||
out double | revisedPublishingInterval, | ||
out uint | revisedLifetimeCount, | ||
out uint | revisedMaxKeepAliveCount | ||
) |
Modifies an existing subscription.
PublishResponse UnifiedAutomation.UaServer.SubscriptionManager.Publish | ( | RequestContext | context, |
SubscriptionAcknowledgementCollection | subscriptionAcknowledgements, | ||
IEndpointIncomingRequest | reqeuest | ||
) |
Publishes a subscription.
|
protectedvirtual |
Raises an event related to a subscription.
NotificationMessage UnifiedAutomation.UaServer.SubscriptionManager.Republish | ( | RequestContext | context, |
uint | subscriptionId, | ||
uint | retransmitSequenceNumber | ||
) |
Republishes a previously published notification message.
void UnifiedAutomation.UaServer.SubscriptionManager.SessionActivated | ( | Session | session, |
bool | identityChanged | ||
) |
Called when a session is activated.
session | The session. |
identityChanged | if set to true [identity changed]. |
void UnifiedAutomation.UaServer.SubscriptionManager.SessionClosed | ( | Session | session, |
bool | deleteSubscriptions | ||
) |
Called when a new session is closed.
session | The session. |
deleteSubscriptions | if set to true [delete subscriptions]. |
void UnifiedAutomation.UaServer.SubscriptionManager.SessionOpened | ( | Session | session | ) |
Called when a new session is created.
session | The session. |
void UnifiedAutomation.UaServer.SubscriptionManager.SetPublishingMode | ( | RequestContext | context, |
bool | publishingEnabled, | ||
List< uint > | subscriptionIds, | ||
out StatusCodeCollection | results | ||
) |
Sets the publishing mode for a set of subscriptions.
void UnifiedAutomation.UaServer.SubscriptionManager.SetTriggering | ( | RequestContext | context, |
uint | subscriptionId, | ||
uint | triggeringItemId, | ||
UInt32Collection | linksToAdd, | ||
UInt32Collection | linksToRemove, | ||
out StatusCodeCollection | addResults, | ||
out StatusCodeCollection | removeResults | ||
) |
Updates the triggers for the monitored item.
|
virtual |
Closes all subscriptions and rejects any new requests.
|
virtual |
Starts up the manager makes it ready to create subscriptions.
void UnifiedAutomation.UaServer.SubscriptionManager.TransferSubscriptions | ( | RequestContext | context, |
List< uint > | subscriptionIds, | ||
bool | sendInitialValues, | ||
out TransferResultCollection | results | ||
) |
Attaches a groups a subscriptions to a different sesssion.
|
addremove |
Raised after a new subscription is created.
|
addremove |
Raised before a subscription is deleted.