.NET Based OPC UA Client/Server SDK  2.6.1.422
UnifiedAutomation.UaBase.TransferSubscriptionsRequest Class Reference

Asynchronous call to transfer a subscription and its MonitoredItems from one Session to another. More...

Inherits UnifiedAutomation.UaBase.IServiceRequest, and UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 TransferSubscriptionsRequest ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
virtual void Decode (IDecoder decoder)
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 

Properties

RequestHeader RequestHeader [get, set]
 
UInt32Collection SubscriptionIds [get, set]
 List of identifiers for the Subscriptions to be transferred to the new Client. More...
 
bool SendInitialValues [get, set]
 A boolean parameter indicating whether the first publish response should contain current values of all monitored items. More...
 
virtual ExpandedNodeId TypeId [get]
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
virtual ExpandedNodeId XmlEncodingId [get]
 
- Properties inherited from UnifiedAutomation.UaBase.IServiceRequest
RequestHeader RequestHeader [get, set]
 The header for the request. More...
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. More...
 

Detailed Description

Asynchronous call to transfer a subscription and its MonitoredItems from one Session to another.

For example, a Client may need to reopen a Session and then transfer its Subscriptions to that Session. It may also be used by one Client to take over a Subscription from another Client by transferring the Subscription to its Session.

The authenticationToken contained in the request header identifies the Session to which the Subscription and MonitoredItems shall be transferred. The Server shall validate that the Client of that Session is operating on behalf of the same user and that the potentially new Client supports the Profiles that are necessary for the Subscription. If the Server transfers the Subscription, it returns the sequence numbers of the NotificationMessages that are available for retransmission. The Client should acknowledge all messages in this list for which it will not request retransmission.

If the Server transfers the Subscription to the new Session, the Server shall issue a StatusChangeNotification notificationMessage with the status code Good_SubscriptionTransferred to the old Session.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.TransferSubscriptionsRequest.TransferSubscriptionsRequest ( )
inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.TransferSubscriptionsRequest.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns

Implements UnifiedAutomation.UaBase.IEncodeable.

Property Documentation

RequestHeader UnifiedAutomation.UaBase.TransferSubscriptionsRequest.RequestHeader
getset

bool UnifiedAutomation.UaBase.TransferSubscriptionsRequest.SendInitialValues
getset

A boolean parameter indicating whether the first publish response should contain current values of all monitored items.

It has the following values:

TRUE
The first Publish response after the TransferSubscriptions call shall contain the current values of all Monitored Items in the Subscription where the Monitoring Mode is set to Reporting.
FALSE
The first Publish response after the TransferSubscriptions call shall contain only the value changes since the last Publish response was sent.

This parameter only applies to MonitoredItems used for monitoring Attribute changes.

UInt32Collection UnifiedAutomation.UaBase.TransferSubscriptionsRequest.SubscriptionIds
getset

List of identifiers for the Subscriptions to be transferred to the new Client.

These identifiers are transferred from the primary Client to a backup Client via external mechanisms.


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