UA Bundle SDK .NET
2.1.0.222
|
Manages a subscription created by a client. More...
Inherits IDisposable.
Public Member Functions | |
Subscription (ServerManager server, Session session, SubscriptionLimits limits, uint subscriptionId, double publishingInterval, uint maxLifetimeCount, uint maxKeepAliveCount, uint maxNotificationsPerPublish, byte priority, bool publishingEnabled) | |
Initializes the object. | |
void | Dispose () |
Frees any unmanaged resources. | |
void | Delete (RequestContext context) |
Deletes the subscription. | |
PublishingState | PublishTimerExpired () |
Checks if the subscription is ready to publish. | |
void | SessionClosed () |
Tells the subscription that the owning session is being closed. | |
TransferResult | Transfer (RequestContext context, bool sendInitialValues) |
Transfers the subscription to a new sesssion. | |
StatusCode | Acknowledge (RequestContext context, uint sequenceNumber) |
Removes a message from the message queue. | |
NotificationMessage | Publish (RequestContext context, out UInt32Collection availableSequenceNumbers, out bool moreNotifications) |
Returns all available notifications. | |
void | PublishTimeout () |
Indicates that the subscription has expired. | |
NotificationMessage | NewStatusMessage (StatusCode status) |
Publishes a timeout status message. | |
NotificationMessage | Republish (RequestContext context, uint retransmitSequenceNumber) |
Returns a cached notification message. | |
void | Modify (RequestContext context, double publishingInterval, uint maxLifetimeCount, uint maxKeepAliveCount, uint maxNotificationsPerPublish, byte priority) |
Updates the publishing parameters for the subscription. | |
void | SetPublishingMode (RequestContext context, bool publishingEnabled) |
Enables/disables publishing for the subscription. | |
void | SetTriggering (RequestContext context, uint triggeringItemId, UInt32Collection linksToAdd, UInt32Collection linksToRemove, out StatusCodeCollection addResults, out StatusCodeCollection removeResults) |
Updates the triggers for the monitored item. | |
void | OnReadyToPublish (object userData) |
Called when [ready to publish]. | |
MonitoredItemHandle | GetMonitoredItem (uint monitoredItemId) |
Gets the monitored item. | |
StatusCode | CreateDataMonitoredItem (RequestContext context, TimestampsToReturn timestampsToReturn, NodeAttributeOperationHandle nodeHandle, uint monitoredItemId, MonitoredItemCreateRequest settings) |
Creates the data monitored item. | |
MonitoredItemCreateResult | CreateDataMonitoredItemComplete (RequestContext context, MonitoredItemHandle itemHandle, DataMonitoringResult result) |
Creates the data monitored item complete. | |
StatusCode | ModifyDataMonitoredItem (RequestContext context, TimestampsToReturn timestampsToReturn, MonitoredItemOperationHandle itemHandle, MonitoredItemModifyRequest settings) |
Modifies the data monitored item. | |
MonitoredItemModifyResult | ModifyDataMonitoredItemComplete (RequestContext context, MonitoredItemOperationHandle itemHandle, TimestampsToReturn timestampsToReturn, DataMonitoringResult result) |
Modifies the data monitored item complete. | |
StatusCode | SetMonitoringMode (RequestContext context, MonitoredItemOperationHandle itemHandle, MonitoringMode monitoringMode) |
Sets the monitoring mode. | |
StatusCode | SetMonitoringModeComplete (RequestContext context, MonitoredItemOperationHandle itemHandle, StatusCode result) |
Modifies the data monitored item complete. | |
StatusCode | DeleteMonitoredItem (RequestContext context, MonitoredItemOperationHandle itemHandle) |
Deletes the monitored item. | |
StatusCode | DeleteMonitoredItemComplete (RequestContext context, MonitoredItemOperationHandle itemHandle, StatusCode result) |
Deletes the monitored item complete. | |
StatusCode | CreateEventMonitoredItem (RequestContext context, NotifierOperationHandle notifierHandle, uint monitoredItemId, MonitoredItemCreateRequest settings) |
Creates the event monitored item. | |
MonitoredItemCreateResult | CreateEventMonitoredItemComplete (RequestContext context, MonitoredItemHandle itemHandle, EventMonitoringResult result) |
Creates the event monitored item complete. | |
StatusCode | ModifyEventMonitoredItem (RequestContext context, MonitoredItemOperationHandle itemHandle, MonitoredItemModifyRequest settings) |
Creates the event monitored item. | |
MonitoredItemModifyResult | ModifyEventMonitoredItemComplete (RequestContext context, MonitoredItemOperationHandle itemHandle, EventMonitoringResult result) |
Creates the event monitored item complete. | |
void | ValidateConditionRefresh (RequestContext context) |
Verifies that a condition refresh operation is permitted. | |
void | ConditionRefresh () |
Refreshes the conditions. | |
void | GetMonitoredItems (out uint[] serverHandles, out uint[] clientHandles) |
Gets the monitored items for the subscription. | |
Protected Member Functions | |
virtual void | Dispose (bool disposing) |
An overrideable version of the Dispose. | |
Properties | |
Session | Session [get] |
The session that owns the monitored item. | |
uint | Id [get] |
The unique identifier assigned to the subscription. | |
NodeId | SessionId [get] |
The identifier for the session that owns the subscription. | |
object | DiagnosticsLock [get] |
Gets the lock that must be acquired before accessing the contents of the Diagnostics property. | |
SubscriptionDiagnosticsModel | Diagnostics [get] |
Gets the current diagnostics for the subscription. | |
double | PublishingInterval [get] |
The publishing rate for the subscription. | |
int | MonitoredItemCount [get] |
The number of monitored items. | |
byte | Priority [get] |
The priority assigned to the subscription. | |
Manages a subscription created by a client.
UnifiedAutomation.UaServer.Subscription.Subscription | ( | ServerManager | server, |
Session | session, | ||
SubscriptionLimits | limits, | ||
uint | subscriptionId, | ||
double | publishingInterval, | ||
uint | maxLifetimeCount, | ||
uint | maxKeepAliveCount, | ||
uint | maxNotificationsPerPublish, | ||
byte | priority, | ||
bool | publishingEnabled | ||
) |
Initializes the object.
StatusCode UnifiedAutomation.UaServer.Subscription.Acknowledge | ( | RequestContext | context, |
uint | sequenceNumber | ||
) |
Removes a message from the message queue.
void UnifiedAutomation.UaServer.Subscription.ConditionRefresh | ( | ) |
Refreshes the conditions.
StatusCode UnifiedAutomation.UaServer.Subscription.CreateDataMonitoredItem | ( | RequestContext | context, |
TimestampsToReturn | timestampsToReturn, | ||
NodeAttributeOperationHandle | nodeHandle, | ||
uint | monitoredItemId, | ||
MonitoredItemCreateRequest | settings | ||
) |
Creates the data monitored item.
context | The request context. |
timestampsToReturn | The timestamps to return. |
nodeHandle | The node handle. |
monitoredItemId | The monitored item id. |
settings | The settings. |
MonitoredItemCreateResult UnifiedAutomation.UaServer.Subscription.CreateDataMonitoredItemComplete | ( | RequestContext | context, |
MonitoredItemHandle | itemHandle, | ||
DataMonitoringResult | result | ||
) |
Creates the data monitored item complete.
context | The request context. |
itemHandle | The item handle. |
result | The result. |
StatusCode UnifiedAutomation.UaServer.Subscription.CreateEventMonitoredItem | ( | RequestContext | context, |
NotifierOperationHandle | notifierHandle, | ||
uint | monitoredItemId, | ||
MonitoredItemCreateRequest | settings | ||
) |
Creates the event monitored item.
context | The request context. |
notifierHandle | The notifier handle. |
monitoredItemId | The monitored item id. |
settings | The settings. |
MonitoredItemCreateResult UnifiedAutomation.UaServer.Subscription.CreateEventMonitoredItemComplete | ( | RequestContext | context, |
MonitoredItemHandle | itemHandle, | ||
EventMonitoringResult | result | ||
) |
Creates the event monitored item complete.
context | The request context. |
itemHandle | The item handle. |
result | The result. |
void UnifiedAutomation.UaServer.Subscription.Delete | ( | RequestContext | context | ) |
Deletes the subscription.
StatusCode UnifiedAutomation.UaServer.Subscription.DeleteMonitoredItem | ( | RequestContext | context, |
MonitoredItemOperationHandle | itemHandle | ||
) |
Deletes the monitored item.
context | The request context. |
itemHandle | The item handle. |
StatusCode UnifiedAutomation.UaServer.Subscription.DeleteMonitoredItemComplete | ( | RequestContext | context, |
MonitoredItemOperationHandle | itemHandle, | ||
StatusCode | result | ||
) |
Deletes the monitored item complete.
context | The request context. |
itemHandle | The item handle. |
result | The result. |
void UnifiedAutomation.UaServer.Subscription.Dispose | ( | ) |
Frees any unmanaged resources.
|
protectedvirtual |
An overrideable version of the Dispose.
MonitoredItemHandle UnifiedAutomation.UaServer.Subscription.GetMonitoredItem | ( | uint | monitoredItemId | ) |
Gets the monitored item.
monitoredItemId | The monitored item id. |
void UnifiedAutomation.UaServer.Subscription.GetMonitoredItems | ( | out uint[] | serverHandles, |
out uint[] | clientHandles | ||
) |
Gets the monitored items for the subscription.
void UnifiedAutomation.UaServer.Subscription.Modify | ( | RequestContext | context, |
double | publishingInterval, | ||
uint | maxLifetimeCount, | ||
uint | maxKeepAliveCount, | ||
uint | maxNotificationsPerPublish, | ||
byte | priority | ||
) |
Updates the publishing parameters for the subscription.
StatusCode UnifiedAutomation.UaServer.Subscription.ModifyDataMonitoredItem | ( | RequestContext | context, |
TimestampsToReturn | timestampsToReturn, | ||
MonitoredItemOperationHandle | itemHandle, | ||
MonitoredItemModifyRequest | settings | ||
) |
Modifies the data monitored item.
context | The request context. |
timestampsToReturn | The timestamps to return. |
itemHandle | The item handle. |
settings | The settings. |
MonitoredItemModifyResult UnifiedAutomation.UaServer.Subscription.ModifyDataMonitoredItemComplete | ( | RequestContext | context, |
MonitoredItemOperationHandle | itemHandle, | ||
TimestampsToReturn | timestampsToReturn, | ||
DataMonitoringResult | result | ||
) |
Modifies the data monitored item complete.
context | The request context. |
itemHandle | The item handle. |
timestampsToReturn | The timestamps to return. |
result | The result. |
StatusCode UnifiedAutomation.UaServer.Subscription.ModifyEventMonitoredItem | ( | RequestContext | context, |
MonitoredItemOperationHandle | itemHandle, | ||
MonitoredItemModifyRequest | settings | ||
) |
Creates the event monitored item.
context | The request context. |
itemHandle | The item handle. |
settings | The settings. |
MonitoredItemModifyResult UnifiedAutomation.UaServer.Subscription.ModifyEventMonitoredItemComplete | ( | RequestContext | context, |
MonitoredItemOperationHandle | itemHandle, | ||
EventMonitoringResult | result | ||
) |
Creates the event monitored item complete.
context | The request context. |
itemHandle | The item handle. |
result | The result. |
NotificationMessage UnifiedAutomation.UaServer.Subscription.NewStatusMessage | ( | StatusCode | status | ) |
Publishes a timeout status message.
void UnifiedAutomation.UaServer.Subscription.OnReadyToPublish | ( | object | userData | ) |
Called when [ready to publish].
userData | The user data. |
NotificationMessage UnifiedAutomation.UaServer.Subscription.Publish | ( | RequestContext | context, |
out UInt32Collection | availableSequenceNumbers, | ||
out bool | moreNotifications | ||
) |
Returns all available notifications.
void UnifiedAutomation.UaServer.Subscription.PublishTimeout | ( | ) |
Indicates that the subscription has expired.
PublishingState UnifiedAutomation.UaServer.Subscription.PublishTimerExpired | ( | ) |
Checks if the subscription is ready to publish.
NotificationMessage UnifiedAutomation.UaServer.Subscription.Republish | ( | RequestContext | context, |
uint | retransmitSequenceNumber | ||
) |
Returns a cached notification message.
void UnifiedAutomation.UaServer.Subscription.SessionClosed | ( | ) |
Tells the subscription that the owning session is being closed.
StatusCode UnifiedAutomation.UaServer.Subscription.SetMonitoringMode | ( | RequestContext | context, |
MonitoredItemOperationHandle | itemHandle, | ||
MonitoringMode | monitoringMode | ||
) |
Sets the monitoring mode.
context | The request context. |
itemHandle | The item handle. |
monitoringMode | The monitoring mode. |
StatusCode UnifiedAutomation.UaServer.Subscription.SetMonitoringModeComplete | ( | RequestContext | context, |
MonitoredItemOperationHandle | itemHandle, | ||
StatusCode | result | ||
) |
Modifies the data monitored item complete.
context | The request context. |
itemHandle | The item handle. |
result | The result. |
void UnifiedAutomation.UaServer.Subscription.SetPublishingMode | ( | RequestContext | context, |
bool | publishingEnabled | ||
) |
Enables/disables publishing for the subscription.
void UnifiedAutomation.UaServer.Subscription.SetTriggering | ( | RequestContext | context, |
uint | triggeringItemId, | ||
UInt32Collection | linksToAdd, | ||
UInt32Collection | linksToRemove, | ||
out StatusCodeCollection | addResults, | ||
out StatusCodeCollection | removeResults | ||
) |
Updates the triggers for the monitored item.
TransferResult UnifiedAutomation.UaServer.Subscription.Transfer | ( | RequestContext | context, |
bool | sendInitialValues | ||
) |
Transfers the subscription to a new sesssion.
void UnifiedAutomation.UaServer.Subscription.ValidateConditionRefresh | ( | RequestContext | context | ) |
Verifies that a condition refresh operation is permitted.
|
get |
Gets the current diagnostics for the subscription.
|
get |
Gets the lock that must be acquired before accessing the contents of the Diagnostics property.
|
get |
The unique identifier assigned to the subscription.
|
get |
The number of monitored items.
|
get |
The priority assigned to the subscription.
|
get |
The publishing rate for the subscription.
|
get |
The session that owns the monitored item.
|
get |
The identifier for the session that owns the subscription.