A subscription with the server. More...

Public Member Functions
	Subscription (Session session)
	Initializes a new instance of the Subscription class. More...

virtual void	Save (IEncoder encoder)
	Saves Subscription using the specified encoder. More...

virtual void	Load (IDecoder decoder)
	Initializes the Subscription using the specified decoder. More...

void	Create ()
	Creates a new subscription on the server. More...

void	Create (RequestSettings settings)
	Creates a new subscription on the server. More...

IAsyncResult	BeginCreate (RequestSettings settings, AsyncCallback callback, object userData)
	Creates a new subscription on the server. More...

void	EndCreate (IAsyncResult result)
	Ends a create operation. More...

void	Modify ()
	Modifys a new subscription on the server. More...

void	Modify (RequestSettings settings)
	Modifys a new subscription on the server. More...

IAsyncResult	BeginModify (RequestSettings settings, AsyncCallback callback, object userData)
	Modifys a new subscription on the server. More...

void	EndModify (IAsyncResult result)
	Ends a modify operation. More...

void	Delete ()
	Modifys a new subscription on the server. More...

void	Delete (RequestSettings settings)
	Modifys a new subscription on the server. More...

IAsyncResult	BeginDelete (RequestSettings settings, AsyncCallback callback, object userData)
	Modifys a new subscription on the server. More...

void	EndDelete (IAsyncResult result)
	Ends a delete operation. More...

void	Transfer (uint subscriptionId, List< uint > availableSequenceNumbers, RequestSettings settings)
	Transfers the specified subscription id. More...

void	Recreate (RequestSettings settings)
	Recreates the subcription. More...

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. More...

List< StatusCode >	CreateMonitoredItems (IList< MonitoredItem > monitoredItems, RequestSettings settings)
	Creates the monitored items. More...

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. More...

List< StatusCode >	EndCreateMonitoredItems (IAsyncResult result)
	Ends a create monitored items operation. More...

List< StatusCode >	ModifyMonitoredItems (IList< MonitoredItem > monitoredItems)
	Modifies the monitored items. More...

List< StatusCode >	ModifyMonitoredItems (IList< MonitoredItem > monitoredItems, RequestSettings settings)
	Modifies the monitored items. More...

IAsyncResult	BeginModifyMonitoredItems (IList< MonitoredItem > monitoredItems, RequestSettings settings, AsyncCallback callback, object userData)
	Modifies the monitored items. More...

List< StatusCode >	EndModifyMonitoredItems (IAsyncResult result)
	Ends a modify monitored items operation. More...

List< StatusCode >	DeleteMonitoredItems (IList< MonitoredItem > monitoredItems)
	Deletes the monitored items. More...

List< StatusCode >	DeleteMonitoredItems (IList< MonitoredItem > monitoredItems, RequestSettings settings)
	Deletes the monitored items. More...

IAsyncResult	BeginDeleteMonitoredItems (IList< MonitoredItem > monitoredItems, RequestSettings settings, AsyncCallback callback, object userData)
	Deletes the monitored items. More...

List< StatusCode >	EndDeleteMonitoredItems (IAsyncResult result)
	Ends a delete monitored items operation. More...

List< StatusCode >	SetMonitoringMode (MonitoringMode monitoringMode, IList< MonitoredItem > monitoredItems)
	Modifies the monitored items. More...

List< StatusCode >	SetMonitoringMode (MonitoringMode monitoringMode, IList< MonitoredItem > monitoredItems, RequestSettings settings)
	Modifies the monitored items. More...

IAsyncResult	BeginSetMonitoringMode (MonitoringMode monitoringMode, IList< MonitoredItem > monitoredItems, RequestSettings settings, AsyncCallback callback, object userData)
	Modifies the monitored items. More...

List< StatusCode >	EndSetMonitoringMode (IAsyncResult result)
	Ends a set monitoring mode operation. More...

NotificationMessage	Republish (uint retransmitSequenceNumber)
	Republishes the specified message. More...

NotificationMessage	Republish (uint retransmitSequenceNumber, RequestSettings settings)
	Republishes the specified message. More...

IAsyncResult	BeginRepublish (uint retransmitSequenceNumber, RequestSettings settings, AsyncCallback callback, object userData)
	Republishes the specified retransmit sequence number. More...

NotificationMessage	EndRepublish (IAsyncResult result)
	Ends a republish operation. More...

Properties
Session	Session `[get]`
	Gets the session. More...

SubscriptionConnectionStatus	ConnectionStatus `[get, set]`
	Gets the connection status for the subscription. More...

uint	SubscriptionId `[get, set]`
	Gets the subscription id. More...

Object	UserData `[get, set]`
	Gets or sets the user data. More...

TimestampsToReturn	DefaultTimestampsToReturn `[get, set]`
	Gets or sets the default timestamp to return. More...

RequestSettings	DefaultRequestSettings `[get, set]`
	Gets or sets the default request settings. More...

double	PublishingInterval `[get, set]`
	Gets or sets the publishing interval (in milliseconds). More...

double	CurrentPublishingInterval `[get, set]`
	Gets the current publishing interval (in milliseconds). More...

double	Lifetime `[get, set]`
	Gets or sets the lifetime (in milliseconds). More...

double	CurrentLifetime `[get, set]`
	Gets the current life time (in milliseconds). More...

double	MaxKeepAliveTime `[get, set]`
	Gets or sets the max keep alive time (in milliseconds). More...

double	CurrentMaxKeepAliveTime `[get, set]`
	Gets the current max keep alive time (in milliseconds). More...

uint	MaxNotificationsPerPublish `[get, set]`
	Gets or sets the max notifications per publish. More...

uint	CurrentMaxNotificationsPerPublish `[get, set]`
	Gets the current max notifications per publish. More...

bool	PublishingEnabled `[get, set]`
	Gets or sets a value indicating whether publishing is enabled. More...

bool	CurrentPublishingEnabled `[get, set]`
	Gets a value indicating whether publishing is currently enabled. More...

byte	Priority `[get, set]`
	Gets or sets the priority. More...

byte	CurrentPriority `[get, set]`
	Gets the current priority. More...

MonitoredItem[]	MonitoredItems `[get]`
	Gets the monitored items in the subscription. More...

Events
DataChangedEventHandler	DataChanged
	Occurs when any subscribed data values have changed. More...

NewEventsEventHandler	NewEvents
	Occurs when any new events have arrived. More...

SubscriptionStatusChangedEventHandler	StatusChanged
	Occurs when the status of subscription changes. More...

NotificationMessageReceivedEventHandler	NotificationMessageReceived
	Occurs when a new notification message arrives. More...

MissingSequenceNumberEventHandler	MissingSequenceNumber
	Occurs when a sequence number is missing. More...

Detailed Description

A subscription with the server.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.Subscription.Subscription ( Session session )

inline

Initializes a new instance of the Subscription class.

Parameters

session The session.

Member Function Documentation

IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginCreate	(	RequestSettings	settings,
		AsyncCallback	callback,
		object	userData
	)

inline

Creates a new subscription on the server.

Parameters

settings	The settings.
callback	The callback.
userData	The user data.

Returns

IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginCreateMonitoredItems	(	IList< MonitoredItem >	monitoredItems,
		RequestSettings	settings,
		AsyncCallback	callback,
		object	userData
	)

inline

Asynchronous call to create a list of monitored items in the subscriptions. The monitored items could be data monitored items or event monitored items.

Parameters

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.

Returns

IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginDelete	(	RequestSettings	settings,
		AsyncCallback	callback,
		object	userData
	)

inline

Modifys a new subscription on the server.

IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginDeleteMonitoredItems	(	IList< MonitoredItem >	monitoredItems,
		RequestSettings	settings,
		AsyncCallback	callback,
		object	userData
	)

inline

Deletes the monitored items.

Parameters

monitoredItems	The monitored items.
settings	The settings.
callback	The callback.
userData	The user data.

Returns

IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginModify	(	RequestSettings	settings,
		AsyncCallback	callback,
		object	userData
	)

inline

Modifys a new subscription on the server.

IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginModifyMonitoredItems	(	IList< MonitoredItem >	monitoredItems,
		RequestSettings	settings,
		AsyncCallback	callback,
		object	userData
	)

inline

Modifies the monitored items.

Parameters

monitoredItems	The monitored items.
settings	The settings.
callback	The callback.
userData	The user data.

Returns

IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginRepublish	(	uint	retransmitSequenceNumber,
		RequestSettings	settings,
		AsyncCallback	callback,
		object	userData
	)

inline

Republishes the specified retransmit sequence number.

Parameters

retransmitSequenceNumber	The retransmit sequence number.
settings	The settings.
callback	The callback.
userData	The user data.

Returns

IAsyncResult UnifiedAutomation.UaClient.Subscription.BeginSetMonitoringMode	(	MonitoringMode	monitoringMode,
		IList< MonitoredItem >	monitoredItems,
		RequestSettings	settings,
		AsyncCallback	callback,
		object	userData
	)

inline

Modifies the monitored items.

Parameters

monitoringMode	The monitoring mode.
monitoredItems	The monitored items.
settings	The settings.
callback	The callback.
userData	The user data.

Returns

void UnifiedAutomation.UaClient.Subscription.Create ( )

inline

Creates a new subscription on the server.

void UnifiedAutomation.UaClient.Subscription.Create ( RequestSettings settings )

inline

Creates a new subscription on the server.

Parameters

settings The settings.

List<StatusCode> UnifiedAutomation.UaClient.Subscription.CreateMonitoredItems ( IList< MonitoredItem > monitoredItems )

inline

Creates a list of monitored items in the subscriptions. The monitored items could be data monitored items or event monitored items.

Parameters

monitoredItems ref:

Returns

List<StatusCode> UnifiedAutomation.UaClient.Subscription.CreateMonitoredItems	(	IList< MonitoredItem >	monitoredItems,
		RequestSettings	settings
	)

inline

Creates the monitored items.

Parameters

monitoredItems	The monitored items.
settings	The settings.

Returns

void UnifiedAutomation.UaClient.Subscription.Delete ( )

inline

Modifys a new subscription on the server.

void UnifiedAutomation.UaClient.Subscription.Delete ( RequestSettings settings )

inline

Modifys a new subscription on the server.

List<StatusCode> UnifiedAutomation.UaClient.Subscription.DeleteMonitoredItems ( IList< MonitoredItem > monitoredItems )

inline

Deletes the monitored items.

Parameters

monitoredItems The monitored items.

Returns

List<StatusCode> UnifiedAutomation.UaClient.Subscription.DeleteMonitoredItems	(	IList< MonitoredItem >	monitoredItems,
		RequestSettings	settings
	)

inline

Deletes the monitored items.

Parameters

monitoredItems	The monitored items.
settings	The settings.

Returns

void UnifiedAutomation.UaClient.Subscription.EndCreate ( IAsyncResult result )

inline

Ends a create operation.

Parameters

result The result.

List<StatusCode> UnifiedAutomation.UaClient.Subscription.EndCreateMonitoredItems ( IAsyncResult result )

inline

Ends a create monitored items operation.

Parameters

result The result.

Returns

void UnifiedAutomation.UaClient.Subscription.EndDelete ( IAsyncResult result )

inline

Ends a delete operation.

Parameters

result The result.

List<StatusCode> UnifiedAutomation.UaClient.Subscription.EndDeleteMonitoredItems ( IAsyncResult result )

inline

Ends a delete monitored items operation.

Parameters

result The result.

Returns

void UnifiedAutomation.UaClient.Subscription.EndModify ( IAsyncResult result )

inline

Ends a modify operation.

Parameters

result The result.

List<StatusCode> UnifiedAutomation.UaClient.Subscription.EndModifyMonitoredItems ( IAsyncResult result )

inline

Ends a modify monitored items operation.

Parameters

result The result.

Returns

NotificationMessage UnifiedAutomation.UaClient.Subscription.EndRepublish ( IAsyncResult result )

inline

Ends a republish operation.

Parameters

result The result.

Returns

List<StatusCode> UnifiedAutomation.UaClient.Subscription.EndSetMonitoringMode ( IAsyncResult result )

inline

Ends a set monitoring mode operation.

Parameters

result The result.

Returns

virtual void UnifiedAutomation.UaClient.Subscription.Load ( IDecoder decoder )

inlinevirtual

Initializes the Subscription using the specified decoder.

Parameters

decoder The decoder.

void UnifiedAutomation.UaClient.Subscription.Modify ( )

inline

Modifys a new subscription on the server.

void UnifiedAutomation.UaClient.Subscription.Modify ( RequestSettings settings )

inline

Modifys a new subscription on the server.

List<StatusCode> UnifiedAutomation.UaClient.Subscription.ModifyMonitoredItems ( IList< MonitoredItem > monitoredItems )

inline

Modifies the monitored items.

Parameters

monitoredItems The monitored items.

Returns

List<StatusCode> UnifiedAutomation.UaClient.Subscription.ModifyMonitoredItems	(	IList< MonitoredItem >	monitoredItems,
		RequestSettings	settings
	)

inline

Modifies the monitored items.

Parameters

monitoredItems	The monitored items.
settings	The settings.

Returns

void UnifiedAutomation.UaClient.Subscription.Recreate ( RequestSettings settings )

inline

Recreates the subcription.

Parameters

settings The settings.

NotificationMessage UnifiedAutomation.UaClient.Subscription.Republish ( uint retransmitSequenceNumber )

inline

Republishes the specified message.

Parameters

retransmitSequenceNumber The retransmit sequence number.

Returns

NotificationMessage UnifiedAutomation.UaClient.Subscription.Republish	(	uint	retransmitSequenceNumber,
		RequestSettings	settings
	)

inline

Republishes the specified message.

Parameters

retransmitSequenceNumber	The retransmit sequence number.
settings	The settings.

Returns

virtual void UnifiedAutomation.UaClient.Subscription.Save ( IEncoder encoder )

inlinevirtual

Saves Subscription using the specified encoder.

Parameters

encoder The encoder.

List<StatusCode> UnifiedAutomation.UaClient.Subscription.SetMonitoringMode	(	MonitoringMode	monitoringMode,
		IList< MonitoredItem >	monitoredItems
	)

inline

Modifies the monitored items.

Parameters

monitoringMode	The monitoring mode.
monitoredItems	The monitored items.

Returns

List<StatusCode> UnifiedAutomation.UaClient.Subscription.SetMonitoringMode	(	MonitoringMode	monitoringMode,
		IList< MonitoredItem >	monitoredItems,
		RequestSettings	settings
	)

inline

Modifies the monitored items.

Parameters

monitoringMode	The monitoring mode.
monitoredItems	The monitored items.
settings	The settings.

Returns

void UnifiedAutomation.UaClient.Subscription.Transfer	(	uint	subscriptionId,
		List< uint >	availableSequenceNumbers,
		RequestSettings	settings
	)

inline

Transfers the specified subscription id.

Parameters

subscriptionId	The subscription id.
availableSequenceNumbers	The available sequence numbers.
settings	The settings.

Property Documentation

SubscriptionConnectionStatus UnifiedAutomation.UaClient.Subscription.ConnectionStatus

getset

Gets the connection status for the subscription.

double UnifiedAutomation.UaClient.Subscription.CurrentLifetime

getset

Gets the current life time (in milliseconds).

The current life time.

double UnifiedAutomation.UaClient.Subscription.CurrentMaxKeepAliveTime

getset

Gets the current max keep alive time (in milliseconds).

The current max keep alive time.

uint UnifiedAutomation.UaClient.Subscription.CurrentMaxNotificationsPerPublish

getset

Gets the current max notifications per publish.

The current max notifications per publish.

byte UnifiedAutomation.UaClient.Subscription.CurrentPriority

getset

Gets the current priority.

The current priority.

bool UnifiedAutomation.UaClient.Subscription.CurrentPublishingEnabled

getset

Gets a value indicating whether publishing is currently enabled.

true if publishing is currently enabled; otherwise, false.

double UnifiedAutomation.UaClient.Subscription.CurrentPublishingInterval

getset

Gets the current publishing interval (in milliseconds).

The current publishing interval.

RequestSettings UnifiedAutomation.UaClient.Subscription.DefaultRequestSettings

getset

Gets or sets the default request settings.

The default request settings.

TimestampsToReturn UnifiedAutomation.UaClient.Subscription.DefaultTimestampsToReturn

getset

Gets or sets the default timestamp to return.

The default timestamp to return.

double UnifiedAutomation.UaClient.Subscription.Lifetime

getset

Gets or sets the lifetime (in milliseconds).

The lifetime.

double UnifiedAutomation.UaClient.Subscription.MaxKeepAliveTime

getset

Gets or sets the max keep alive time (in milliseconds).

The max keep alive time.

uint UnifiedAutomation.UaClient.Subscription.MaxNotificationsPerPublish

getset

Gets or sets the max notifications per publish.

The max notifications per publish.

MonitoredItem [] UnifiedAutomation.UaClient.Subscription.MonitoredItems

get

Gets the monitored items in the subscription.

byte UnifiedAutomation.UaClient.Subscription.Priority

getset

Gets or sets the priority.

The priority.

bool UnifiedAutomation.UaClient.Subscription.PublishingEnabled

getset

Gets or sets a value indicating whether publishing is enabled.

true if publishing is enabled; otherwise, false.

double UnifiedAutomation.UaClient.Subscription.PublishingInterval

getset

Gets or sets the publishing interval (in milliseconds).

The publishing interval.

Session UnifiedAutomation.UaClient.Subscription.Session

get

Gets the session.

uint UnifiedAutomation.UaClient.Subscription.SubscriptionId

getset

Gets the subscription id.

Object UnifiedAutomation.UaClient.Subscription.UserData

getset

Gets or sets the user data.

The user data.

Event Documentation

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.

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

C:/work/uasdknet/src/UaClient/Subscription.cs

Public Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation

Event Documentation