UA Bundle SDK .NET
2.1.0.222
|
A subscription with the server. More...
Public Member Functions | |
Subscription (Session session) | |
Initializes a new instance of the Subscription class. | |
virtual void | Save (IEncoder encoder) |
Saves Subscription using the specified encoder. | |
virtual void | Load (IDecoder decoder) |
Initializes the Subscription using the specified decoder. | |
void | Create () |
Creates a new subscription on the server. | |
void | Create (RequestSettings settings) |
Creates a new subscription on the server. | |
IAsyncResult | BeginCreate (RequestSettings settings, AsyncCallback callback, object userData) |
Creates a new subscription on the server. | |
void | EndCreate (IAsyncResult result) |
Ends a create operation. | |
void | Modify () |
Modifys a new subscription on the server. | |
void | Modify (RequestSettings settings) |
Modifys a new subscription on the server. | |
IAsyncResult | BeginModify (RequestSettings settings, AsyncCallback callback, object userData) |
Modifys a new subscription on the server. | |
void | EndModify (IAsyncResult result) |
Ends a modify operation. | |
void | Delete () |
Modifys a new subscription on the server. | |
void | Delete (RequestSettings settings) |
Modifys a new subscription on the server. | |
IAsyncResult | BeginDelete (RequestSettings settings, AsyncCallback callback, object userData) |
Modifys a new subscription on the server. | |
void | EndDelete (IAsyncResult result) |
Ends a delete operation. | |
void | Transfer (uint subscriptionId, List< uint > availableSequenceNumbers, RequestSettings settings) |
Transfers the specified subscription id. | |
void | Recreate (RequestSettings settings) |
Recreates the subcription. | |
List< StatusCode > | CreateMonitoredItems (IList< MonitoredItem > monitoredItems) |
Creates a list of monitored items in the subscriptions. The monitored items could be data monitored items or event monitored items. | |
List< StatusCode > | CreateMonitoredItems (IList< MonitoredItem > monitoredItems, RequestSettings settings) |
Creates the monitored items. | |
IAsyncResult | BeginCreateMonitoredItems (IList< MonitoredItem > monitoredItems, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronous call to create a list of monitored items in the subscriptions. The monitored items could be data monitored items or event monitored items. | |
List< StatusCode > | EndCreateMonitoredItems (IAsyncResult result) |
Ends a create monitored items operation. | |
List< StatusCode > | ModifyMonitoredItems (IList< MonitoredItem > monitoredItems) |
Modifies the monitored items. | |
List< StatusCode > | ModifyMonitoredItems (IList< MonitoredItem > monitoredItems, RequestSettings settings) |
Modifies the monitored items. | |
IAsyncResult | BeginModifyMonitoredItems (IList< MonitoredItem > monitoredItems, RequestSettings settings, AsyncCallback callback, object userData) |
Modifies the monitored items. | |
List< StatusCode > | EndModifyMonitoredItems (IAsyncResult result) |
Ends a modify monitored items operation. | |
List< StatusCode > | DeleteMonitoredItems (IList< MonitoredItem > monitoredItems) |
Deletes the monitored items. | |
List< StatusCode > | DeleteMonitoredItems (IList< MonitoredItem > monitoredItems, RequestSettings settings) |
Deletes the monitored items. | |
IAsyncResult | BeginDeleteMonitoredItems (IList< MonitoredItem > monitoredItems, RequestSettings settings, AsyncCallback callback, object userData) |
Deletes the monitored items. | |
List< StatusCode > | EndDeleteMonitoredItems (IAsyncResult result) |
Ends a delete monitored items operation. | |
List< StatusCode > | SetMonitoringMode (MonitoringMode monitoringMode, IList< MonitoredItem > monitoredItems) |
Modifies the monitored items. | |
List< StatusCode > | SetMonitoringMode (MonitoringMode monitoringMode, IList< MonitoredItem > monitoredItems, RequestSettings settings) |
Modifies the monitored items. | |
IAsyncResult | BeginSetMonitoringMode (MonitoringMode monitoringMode, IList< MonitoredItem > monitoredItems, RequestSettings settings, AsyncCallback callback, object userData) |
Modifies the monitored items. | |
List< StatusCode > | EndSetMonitoringMode (IAsyncResult result) |
Ends a set monitoring mode operation. | |
NotificationMessage | Republish (uint retransmitSequenceNumber) |
Republishes the specified message. | |
NotificationMessage | Republish (uint retransmitSequenceNumber, RequestSettings settings) |
Republishes the specified message. | |
IAsyncResult | BeginRepublish (uint retransmitSequenceNumber, RequestSettings settings, AsyncCallback callback, object userData) |
Republishes the specified retransmit sequence number. | |
NotificationMessage | EndRepublish (IAsyncResult result) |
Ends a republish operation. | |
Properties | |
Session | Session [get] |
Gets the session. | |
SubscriptionConnectionStatus | ConnectionStatus [get, set] |
Gets the connection status for the subscription. | |
uint | SubscriptionId [get, set] |
Gets the subscription id. | |
Object | UserData [get, set] |
Gets or sets the user data. | |
TimestampsToReturn | DefaultTimestampsToReturn [get, set] |
Gets or sets the default timestamp to return. | |
RequestSettings | DefaultRequestSettings [get, set] |
Gets or sets the default request settings. | |
double | PublishingInterval [get, set] |
Gets or sets the publishing interval (in milliseconds). | |
double | CurrentPublishingInterval [get, set] |
Gets the current publishing interval (in milliseconds). | |
double | Lifetime [get, set] |
Gets or sets the lifetime (in milliseconds). | |
double | CurrentLifetime [get, set] |
Gets the current life time (in milliseconds). | |
double | MaxKeepAliveTime [get, set] |
Gets or sets the max keep alive time (in milliseconds). | |
double | CurrentMaxKeepAliveTime [get, set] |
Gets the current max keep alive time (in milliseconds). | |
uint | MaxNotificationsPerPublish [get, set] |
Gets or sets the max notifications per publish. | |
uint | CurrentMaxNotificationsPerPublish [get, set] |
Gets the current max notifications per publish. | |
bool | PublishingEnabled [get, set] |
Gets or sets a value indicating whether publishing is enabled. | |
bool | CurrentPublishingEnabled [get, set] |
Gets a value indicating whether publishing is currently enabled. | |
byte | Priority [get, set] |
Gets or sets the priority. | |
byte | CurrentPriority [get, set] |
Gets the current priority. | |
MonitoredItem[] | MonitoredItems [get] |
Gets the monitored items in the subscription. | |
Events | |
DataChangedEventHandler | DataChanged |
Occurs when any subscribed data values have changed. | |
NewEventsEventHandler | NewEvents |
Occurs when any new events have arrived. | |
SubscriptionStatusChangedEventHandler | StatusChanged |
Occurs when the status of subscription changes. | |
NotificationMessageReceivedEventHandler | NotificationMessageReceived |
Occurs when a new notification message arrives. | |
MissingSequenceNumberEventHandler | MissingSequenceNumber |
Occurs when a sequence number is missing. | |
A subscription with the server.
UnifiedAutomation.UaClient.Subscription.Subscription | ( | Session | session | ) |
Initializes a new instance of the Subscription class.
session | The session. |
IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginCreate | ( | RequestSettings | settings, |
AsyncCallback | callback, | ||
object | userData | ||
) |
Creates a new subscription on the server.
settings | The settings. |
callback | The callback. |
userData | The user data. |
IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginCreateMonitoredItems | ( | IList< MonitoredItem > | monitoredItems, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Asynchronous call to create a list of monitored items in the subscriptions. The monitored items could be data monitored items or event monitored items.
monitoredItems | The monitored items. |
settings | The settings. |
callback | The callback. |
userData | The user data. |
If this method is called before the Subscription is created the MonitoredItems are saved and the return status is GoodCallAgain. The MonitoredItems will be automatically created after the Subscription is created. Any errors are reported in the LastError property of the MonitoredItem object.
IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginDelete | ( | RequestSettings | settings, |
AsyncCallback | callback, | ||
object | userData | ||
) |
Modifys a new subscription on the server.
IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginDeleteMonitoredItems | ( | IList< MonitoredItem > | monitoredItems, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Deletes the monitored items.
monitoredItems | The monitored items. |
settings | The settings. |
callback | The callback. |
userData | The user data. |
IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginModify | ( | RequestSettings | settings, |
AsyncCallback | callback, | ||
object | userData | ||
) |
Modifys a new subscription on the server.
IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginModifyMonitoredItems | ( | IList< MonitoredItem > | monitoredItems, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Modifies the monitored items.
monitoredItems | The monitored items. |
settings | The settings. |
callback | The callback. |
userData | The user data. |
IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginRepublish | ( | uint | retransmitSequenceNumber, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Republishes the specified retransmit sequence number.
retransmitSequenceNumber | The retransmit sequence number. |
settings | The settings. |
callback | The callback. |
userData | The user data. |
IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginSetMonitoringMode | ( | MonitoringMode | monitoringMode, |
IList< MonitoredItem > | monitoredItems, | ||
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Modifies the monitored items.
monitoringMode | The monitoring mode. |
monitoredItems | The monitored items. |
settings | The settings. |
callback | The callback. |
userData | The user data. |
void UnifiedAutomation.UaClient.Subscription.Create | ( | ) |
Creates a new subscription on the server.
void UnifiedAutomation.UaClient.Subscription.Create | ( | RequestSettings | settings | ) |
Creates a new subscription on the server.
settings | The settings. |
List<StatusCode> UnifiedAutomation.UaClient.Subscription.CreateMonitoredItems | ( | IList< MonitoredItem > | monitoredItems | ) |
Creates a list of monitored items in the subscriptions. The monitored items could be data monitored items or event monitored items.
monitoredItems | ref: |
List<StatusCode> UnifiedAutomation.UaClient.Subscription.CreateMonitoredItems | ( | IList< MonitoredItem > | monitoredItems, |
RequestSettings | settings | ||
) |
Creates the monitored items.
monitoredItems | The monitored items. |
settings | The settings. |
void UnifiedAutomation.UaClient.Subscription.Delete | ( | ) |
Modifys a new subscription on the server.
void UnifiedAutomation.UaClient.Subscription.Delete | ( | RequestSettings | settings | ) |
Modifys a new subscription on the server.
List<StatusCode> UnifiedAutomation.UaClient.Subscription.DeleteMonitoredItems | ( | IList< MonitoredItem > | monitoredItems | ) |
Deletes the monitored items.
monitoredItems | The monitored items. |
List<StatusCode> UnifiedAutomation.UaClient.Subscription.DeleteMonitoredItems | ( | IList< MonitoredItem > | monitoredItems, |
RequestSettings | settings | ||
) |
Deletes the monitored items.
monitoredItems | The monitored items. |
settings | The settings. |
void UnifiedAutomation.UaClient.Subscription.EndCreate | ( | IAsyncResult | result | ) |
Ends a create operation.
result | The result. |
List<StatusCode> UnifiedAutomation.UaClient.Subscription.EndCreateMonitoredItems | ( | IAsyncResult | result | ) |
Ends a create monitored items operation.
result | The result. |
void UnifiedAutomation.UaClient.Subscription.EndDelete | ( | IAsyncResult | result | ) |
Ends a delete operation.
result | The result. |
List<StatusCode> UnifiedAutomation.UaClient.Subscription.EndDeleteMonitoredItems | ( | IAsyncResult | result | ) |
Ends a delete monitored items operation.
result | The result. |
void UnifiedAutomation.UaClient.Subscription.EndModify | ( | IAsyncResult | result | ) |
Ends a modify operation.
result | The result. |
List<StatusCode> UnifiedAutomation.UaClient.Subscription.EndModifyMonitoredItems | ( | IAsyncResult | result | ) |
Ends a modify monitored items operation.
result | The result. |
NotificationMessage UnifiedAutomation.UaClient.Subscription.EndRepublish | ( | IAsyncResult | result | ) |
Ends a republish operation.
result | The result. |
List<StatusCode> UnifiedAutomation.UaClient.Subscription.EndSetMonitoringMode | ( | IAsyncResult | result | ) |
Ends a set monitoring mode operation.
result | The result. |
|
virtual |
Initializes the Subscription using the specified decoder.
decoder | The decoder. |
void UnifiedAutomation.UaClient.Subscription.Modify | ( | ) |
Modifys a new subscription on the server.
void UnifiedAutomation.UaClient.Subscription.Modify | ( | RequestSettings | settings | ) |
Modifys a new subscription on the server.
List<StatusCode> UnifiedAutomation.UaClient.Subscription.ModifyMonitoredItems | ( | IList< MonitoredItem > | monitoredItems | ) |
Modifies the monitored items.
monitoredItems | The monitored items. |
List<StatusCode> UnifiedAutomation.UaClient.Subscription.ModifyMonitoredItems | ( | IList< MonitoredItem > | monitoredItems, |
RequestSettings | settings | ||
) |
Modifies the monitored items.
monitoredItems | The monitored items. |
settings | The settings. |
void UnifiedAutomation.UaClient.Subscription.Recreate | ( | RequestSettings | settings | ) |
Recreates the subcription.
settings | The settings. |
NotificationMessage UnifiedAutomation.UaClient.Subscription.Republish | ( | uint | retransmitSequenceNumber | ) |
Republishes the specified message.
retransmitSequenceNumber | The retransmit sequence number. |
NotificationMessage UnifiedAutomation.UaClient.Subscription.Republish | ( | uint | retransmitSequenceNumber, |
RequestSettings | settings | ||
) |
Republishes the specified message.
retransmitSequenceNumber | The retransmit sequence number. |
settings | The settings. |
|
virtual |
Saves Subscription using the specified encoder.
encoder | The encoder. |
List<StatusCode> UnifiedAutomation.UaClient.Subscription.SetMonitoringMode | ( | MonitoringMode | monitoringMode, |
IList< MonitoredItem > | monitoredItems | ||
) |
Modifies the monitored items.
monitoringMode | The monitoring mode. |
monitoredItems | The monitored items. |
List<StatusCode> UnifiedAutomation.UaClient.Subscription.SetMonitoringMode | ( | MonitoringMode | monitoringMode, |
IList< MonitoredItem > | monitoredItems, | ||
RequestSettings | settings | ||
) |
Modifies the monitored items.
monitoringMode | The monitoring mode. |
monitoredItems | The monitored items. |
settings | The settings. |
void UnifiedAutomation.UaClient.Subscription.Transfer | ( | uint | subscriptionId, |
List< uint > | availableSequenceNumbers, | ||
RequestSettings | settings | ||
) |
Transfers the specified subscription id.
subscriptionId | The subscription id. |
availableSequenceNumbers | The available sequence numbers. |
settings | The settings. |
|
getset |
Gets the connection status for the subscription.
|
getset |
Gets the current life time (in milliseconds).
The current life time.
|
getset |
Gets the current max keep alive time (in milliseconds).
The current max keep alive time.
|
getset |
Gets the current max notifications per publish.
The current max notifications per publish.
|
getset |
Gets the current priority.
The current priority.
|
getset |
Gets a value indicating whether publishing is currently enabled.
true
if publishing is currently enabled; otherwise, false
.
|
getset |
Gets the current publishing interval (in milliseconds).
The current publishing interval.
|
getset |
Gets or sets the default request settings.
The default request settings.
|
getset |
Gets or sets the default timestamp to return.
The default timestamp to return.
|
getset |
Gets or sets the lifetime (in milliseconds).
The lifetime.
|
getset |
Gets or sets the max keep alive time (in milliseconds).
The max keep alive time.
|
getset |
Gets or sets the max notifications per publish.
The max notifications per publish.
|
get |
Gets the monitored items in the subscription.
|
getset |
Gets or sets the priority.
The priority.
|
getset |
Gets or sets a value indicating whether publishing is enabled.
true
if publishing is enabled; otherwise, false
.
|
getset |
Gets or sets the publishing interval (in milliseconds).
The publishing interval.
|
get |
Gets the session.
|
getset |
Gets the subscription id.
|
getset |
Gets or sets the user data.
The user data.
DataChangedEventHandler UnifiedAutomation.UaClient.Subscription.DataChanged |
Occurs when any subscribed data values have changed.
MissingSequenceNumberEventHandler UnifiedAutomation.UaClient.Subscription.MissingSequenceNumber |
Occurs when a sequence number is missing.
NewEventsEventHandler UnifiedAutomation.UaClient.Subscription.NewEvents |
Occurs when any new events have arrived.
NotificationMessageReceivedEventHandler UnifiedAutomation.UaClient.Subscription.NotificationMessageReceived |
Occurs when a new notification message arrives.
SubscriptionStatusChangedEventHandler UnifiedAutomation.UaClient.Subscription.StatusChanged |
Occurs when the status of subscription changes.