UA Bundle SDK .NET  2.1.2.227
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaClient.Session Class Reference

A class that manages a session with an OPC UA server. More...

Inherits IDisposable, and UnifiedAutomation.UaBase.IMapperContext.

Public Member Functions

 Session ()
 Create a session for the default client application. More...
 
 Session (ApplicationInstance application)
 Create a session for the specified client application. More...
 
void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 
void Connect (string endpointUrl, SecuritySelection securitySelection)
  More...
 
void Connect (string endpointUrl, SecuritySelection securitySelection, RequestSettings settings)
  More...
 
void Connect (string endpointUrl, SecuritySelection securitySelection, string transportProfileUri, RetryInitialConnect retryInitialConnect, RequestSettings settings)
 Connects the specified endpoint URL. More...
 
IAsyncResult BeginConnect (string endpointUrl, SecuritySelection securitySelection, string transportProfileUri, RetryInitialConnect retryInitialConnect, RequestSettings settings, AsyncCallback callback, object userData)
 Establish a connection to the OPC UA server Calling this function successfully creates a secure channel to the server endpoint and it creates and activates an application session in the server application.The SDK is managing the connection to the server by More...
 
void Connect (EndpointDescription endpoint, RequestSettings settings)
  More...
 
void Connect (EndpointDescription endpoint, RetryInitialConnect retryInitialConnect, RequestSettings settings)
 Connects the specified endpoint. More...
 
IAsyncResult BeginConnect (EndpointDescription endpoint, RetryInitialConnect retryInitialConnect, RequestSettings settings, AsyncCallback callback, object userData)
  More...
 
void EndConnect (IAsyncResult result)
 Completes an asynchronous connect operation. More...
 
void Disconnect ()
 Disconnect client application from OPC UA server. Calling this function closes the session and the secure channel connection to the server. The subscriptions assigned to the session are also deleted. More...
 
void Disconnect (SubscriptionCleanupPolicy cleanupPolicy)
 Disconnect client application from OPC UA server. Calling this function closes the session and the secure channel connection to the server. The subscriptions assigned to the session are also deleted if the cleanupPolicy is set to Delete. More...
 
void Disconnect (SubscriptionCleanupPolicy cleanupPolicy, RequestSettings settings)
 Disconnect client application from OPC UA server. Calling this function closes the session and the secure channel connection to the server. The subscriptions assigned to the session are also deleted if the cleanupPolicy is set to Delete. More...
 
IAsyncResult BeginDisconnect (AsyncCallback callback, object userData)
 Disconnect client application from OPC UA server. Calling this function closes the session and the secure channel connection to the server. The subscriptions assigned the session are also deleted. More...
 
IAsyncResult BeginDisconnect (SubscriptionCleanupPolicy cleanupPolicy, AsyncCallback callback, object userData)
 Disconnect client application from OPC UA server. Calling this function closes the session and the secure channel connection to the server. The subscriptions assigned the session are also deleted if the cleanupPolicy is set to Delete. More...
 
IAsyncResult BeginDisconnect (SubscriptionCleanupPolicy cleanupPolicy, RequestSettings settings, AsyncCallback callback, object userData)
 Disconnect client application from OPC UA server. Calling this function closes the session and the secure channel connection to the server. The subscriptions assigned the session are also deleted if the cleanupPolicy is set to Delete. More...
 
void EndDisconnect (IAsyncResult result)
 Completes an asynchronous disconnect operation. More...
 
List< DataValueRead (IList< ReadValueId > nodesToRead, uint maxAge, TimestampsToReturn timestampsToReturn, RequestSettings settings)
 Reads attribute values synchronous from OPC server. The Read Service is used to read one or more attributes of one or more nodes. It allows also reading subsets or single elements of array values and to define a valid age of values to be returned to reduce the need for device reads. Like most other services, the read is optimized for bulk read operations and not for reading single Attribute values. Typically all Node Attributes are readable. For the Value Attribute the Read rights are indicated by the AccessLevel and UserAccessLevel Attribute of the Variable. More...
 
List< DataValueRead (IList< ReadValueId > nodesToRead)
 Reads attribute values synchronous from OPC server. The Read Service is used to read one or more attributes of one or more nodes. It allows also reading subsets or single elements of array values and to define a valid age of values to be returned to reduce the need for device reads. Like most other services, the read is optimized for bulk read operations and not for reading single Attribute values. Typically all Node Attributes are readable. For the Value Attribute the Read rights are indicated by the AccessLevel and UserAccessLevel Attribute of the Variable. More...
 
IAsyncResult BeginRead (IList< ReadValueId > nodesToRead, uint maxAge, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData)
 Reads values and attributes asynchronously from OPC server. The Read Service is used to read one or more attributes of one or more nodes. It allows also reading subsets or single elements of array values and to define a valid age of values to be returned to reduce the need for device reads. Like most other services, the read is optimized for bulk read operations and not for reading single Attribute values. Typically all Node Attributes are readable. For the Value Attribute the Read rights are indicated by the AccessLevel and UserAccessLevel Attribute of the Variable. More...
 
IAsyncResult BeginRead (IList< ReadValueId > nodesToRead, uint maxAge, TimestampsToReturn timestampsToReturn, AsyncCallback callback, Object userData)
 This is an overloaded function. See BeginRead for more details. More...
 
IAsyncResult BeginRead (IList< ReadValueId > nodesToRead, uint maxAge, AsyncCallback callback, Object userData)
 This is an overloaded function. See BeginRead for more details. More...
 
List< DataValueEndRead (IAsyncResult result)
 Completes an asynchronous read operation. More...
 
List< StatusCodeWrite (IList< WriteValue > nodesToWrite, RequestSettings settings)
 Writes attributes synchronously to OPC server. The Write Service is used to write one or more attributes of one or more nodes. For the Value Attribute the Write rights are indicated by the AccessLevel and UserAccessLevel Attribute of the Variable. More...
 
List< StatusCodeWrite (IList< WriteValue > nodesToWrite)
 This is an overloaded function. See Write for more details. More...
 
IAsyncResult BeginWrite (IList< WriteValue > nodesToWrite, RequestSettings settings, AsyncCallback callback, object userData)
 Writes attributes asynchronously to a OPC UA server. More...
 
IAsyncResult BeginWrite (IList< WriteValue > nodesToWrite, AsyncCallback callback, Object userData)
 This is an overloaded function. See Write for more details. More...
 
List< StatusCodeEndWrite (IAsyncResult result)
 Ends the write. More...
 
void ChangeUser ()
 Change user for the connection to the OPC UA server. Calling this function changes the user of the session by calling ActivateSession with the new user identity. More...
 
void ChangeUser (UserIdentity userIdentity)
 Change user for the connection to the OPC UA server. Calling this function changes the user of the session by calling ActivateSession with the new user identity. More...
 
void ChangeUser (UserIdentity userIdentity, RequestSettings settings)
 Change user for the connection to the OPC UA server. Calling this function changes the user of the session by calling ActivateSession with the new user identity. More...
 
IAsyncResult BeginChangeUser (AsyncCallback callback, Object userData)
 Change user for the connection to the OPC UA server asynchronously. More...
 
IAsyncResult BeginChangeUser (UserIdentity userIdentity, RequestSettings settings, AsyncCallback callback, object userData)
 Change user for the connection to the OPC UA server asynchronously. More...
 
void EndChangeUser (IAsyncResult result)
 Completes a change user request. More...
 
List< ReferenceDescriptionBrowse (NodeId nodeToBrowse, BrowseContext browseContext, RequestSettings settings, out byte[] continuationPoint)
  More...
 
List< ReferenceDescriptionBrowse (NodeId nodeToBrowse, BrowseContext browseContext, out byte[] continuationPoint)
 This is an overloaded function. See Browse for more details. More...
 
List< ReferenceDescriptionBrowse (NodeId nodeToBrowse, out byte[] continuationPoint)
 This is an overloaded function. See Browse for more details. More...
 
IAsyncResult BeginBrowse (NodeId nodeToBrowse, AsyncCallback callback, Object userData)
  More...
 
IAsyncResult BeginBrowse (NodeId nodeToBrowse, BrowseContext browseContext, AsyncCallback callback, Object userData)
 This is an overloaded function. See BeginBrowse for more details. More...
 
IAsyncResult BeginBrowse (NodeId nodeToBrowse, BrowseContext browseContext, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the browse. More...
 
List< ReferenceDescriptionEndBrowse (IAsyncResult result, out byte[] continuationPoint)
 Ends a browse. More...
 
List< ReferenceDescriptionBrowseNext (ref byte[] continuationPoint)
 Continues a browse operation. More...
 
List< ReferenceDescriptionBrowseNext (RequestSettings settings, ref byte[] continuationPoint)
 Continue a previous Browse request.This method is only used to continue a browse started with the browse method if not all results could be returned by the browse or a following browseNext call. The number of Nodes to return can be limited by the client in the browse request or by the Server during processing the Browse Service call. More...
 
IAsyncResult BeginBrowseNext (byte[] continuationPoint, AsyncCallback callback, object userData)
 Begins a browse next operation. More...
 
IAsyncResult BeginBrowseNext (byte[] continuationPoint, RequestSettings settings, AsyncCallback callback, object userData)
 Begins a browse next operation. More...
 
List< List
< ReferenceDescription > > 
BrowseList (List< BrowseDescription > nodesToBrowse)
 Browses the specified nodes. More...
 
List< List
< ReferenceDescription > > 
BrowseList (ViewDescription view, List< BrowseDescription > nodesToBrowse, uint maxReferencesPerBrowse, RequestSettings settings)
 Browses the specified nodes. More...
 
IAsyncResult BeginBrowseList (List< BrowseDescription > nodesToBrowse, AsyncCallback callback, object userData)
 Begins the browse. More...
 
IAsyncResult BeginBrowseList (ViewDescription view, List< BrowseDescription > nodesToBrowse, uint maxReferencesPerBrowse, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the browse. More...
 
List< List
< ReferenceDescription > > 
EndBrowseList (IAsyncResult result)
 Ends a browse. More...
 
void ReleaseBrowseContinuationPoint (byte[] continuationPoint)
 Releases the browse continuation point. More...
 
void ReleaseBrowseContinuationPoint (byte[] continuationPoint, RequestSettings settings)
 Releases the browse continuation point. More...
 
IAsyncResult BeginReleaseBrowseContinuationPoint (byte[] continuationPoint, AsyncCallback callback, object userData)
 Begins a release browse continuation point operation. More...
 
IAsyncResult BeginReleaseBrowseContinuationPoint (byte[] continuationPoint, RequestSettings settings, AsyncCallback callback, object userData)
 Begins a release browse continuation point operation. More...
 
void EndReleaseBrowseContinuationPoint (IAsyncResult result)
 Ends the release browse continuation point operation. More...
 
List< BrowsePathResultTranslateBrowsePath (IList< BrowsePath > pathsToTranslate)
 Translate a browse path to a NodeId. This Service is used to access components of an Object based on the knowledge about the ObjectType. Since the NodeId of a Node is needed to access information provided by the Node like subscribing for Variable Value changes or to call a Method , it is necessary to know the NodeIds of components of Objects. Since OPC UA allows programming software components with built-in knowledge of ObjectTypes , UA needs to provide a mechanism to return the NodeIds for components of an Object instance based on the knowledge about the ObjectType. This mechanism is built on the requirement that the BrowseNames of components in the instance must be the same like BrowseNames of components in the type. More...
 
List< BrowsePathResultTranslateBrowsePath (IList< BrowsePath > pathsToTranslate, RequestSettings settings)
 Translates the browse path. More...
 
List< BrowsePathResultTranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths)
 Translates the browse paths. More...
 
List< BrowsePathResultTranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths, NamespaceTable namespaceUris, RequestSettings settings)
 Translates the browse paths. More...
 
IAsyncResult BeginTranslateBrowsePath (IList< BrowsePath > pathsToTranslate, AsyncCallback callback, object userData)
 Begins the translate browse path. More...
 
IAsyncResult BeginTranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths, AsyncCallback callback, object userData)
 Begins the translate browse path. More...
 
IAsyncResult BeginTranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths, NamespaceTable namespaceUris, RequestSettings settings, AsyncCallback callback, object userData)
 Begins a translate browse paths operation. More...
 
IAsyncResult BeginTranslateBrowsePath (IList< BrowsePath > pathsToTranslate, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the translate browse path. More...
 
List< BrowsePathResultEndTranslateBrowsePath (IAsyncResult result)
 Ends the translate browse path. More...
 
List< VariantCall (NodeId objectToCall, NodeId methodToCall)
 Calls a method of an Object in the OPC server More...
 
StatusCode Call (NodeId objectToCall, NodeId methodToCall, List< Variant > inputArguments, out List< StatusCode > inputArgumentErrors, out List< Variant > outputArguments)
 Calls the specified method. More...
 
StatusCode Call (NodeId objectToCall, NodeId methodToCall, List< Variant > inputArguments, RequestSettings settings, out List< StatusCode > inputArgumentErrors, out List< Variant > outputArguments)
 Calls the specified method. More...
 
IAsyncResult BeginCall (NodeId objectToCall, NodeId methodToCall, List< Variant > inputArguments, RequestSettings settings, AsyncCallback callback, object userData)
 Calls the specified method. More...
 
List< VariantEndCall (IAsyncResult result)
 Calls the specified method. More...
 
StatusCode EndCall (IAsyncResult result, out List< StatusCode > inputArgumentErrors, out List< Variant > outputArguments)
 Calls the specified method. More...
 
List< CallMethodResultCallList (IList< CallMethodRequest > methodsToCall, RequestSettings settings)
 Calls the specified methods to call. More...
 
IAsyncResult BeginCallList (IList< CallMethodRequest > methodsToCall, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the method call. More...
 
List< CallMethodResultEndCallList (IAsyncResult result)
 Ends a call method request. More...
 
List< HistoryDataReadResultHistoryReadRaw (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details)
 Histories the read raw. More...
 
List< HistoryDataReadResultHistoryReadRaw (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings)
 Histories the read raw. More...
 
IAsyncResult BeginHistoryReadRaw (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, AsyncCallback callback, object userData)
 Begins the history read raw. More...
 
IAsyncResult BeginHistoryReadRaw (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the history read raw. More...
 
List< HistoryDataReadResultEndHistoryReadRaw (IAsyncResult result)
 Ends the history read raw. More...
 
List< HistoryDataReadResultHistoryReadModified (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details)
 Histories the read raw. More...
 
List< HistoryDataReadResultHistoryReadModified (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings)
 Histories the read raw. More...
 
IAsyncResult BeginHistoryReadModified (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, AsyncCallback callback, object userData)
 Begins the history read raw. More...
 
IAsyncResult BeginHistoryReadModified (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the history read raw. More...
 
List< HistoryDataReadResultEndHistoryReadModified (IAsyncResult result)
 Ends the history read raw. More...
 
List< HistoryDataReadResultHistoryReadProcessed (IList< HistoryReadValueId > nodesToRead, ReadProcessedDetails details)
 Histories the read raw. More...
 
List< HistoryDataReadResultHistoryReadProcessed (IList< HistoryReadValueId > nodesToRead, ReadProcessedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings)
 Histories the read raw. More...
 
IAsyncResult BeginHistoryReadProcessed (IList< HistoryReadValueId > nodesToRead, ReadProcessedDetails details, AsyncCallback callback, object userData)
 Begins the history read raw. More...
 
IAsyncResult BeginHistoryReadProcessed (IList< HistoryReadValueId > nodesToRead, ReadProcessedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the history read raw. More...
 
List< HistoryDataReadResultEndHistoryReadProcessed (IAsyncResult result)
 Ends the history read raw. More...
 
List< HistoryDataReadResultHistoryReadAtTime (IList< HistoryReadValueId > nodesToRead, ReadAtTimeDetails details)
 Histories the read raw. More...
 
List< HistoryDataReadResultHistoryReadAtTime (IList< HistoryReadValueId > nodesToRead, ReadAtTimeDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings)
 Histories the read raw. More...
 
IAsyncResult BeginHistoryReadAtTime (IList< HistoryReadValueId > nodesToRead, ReadAtTimeDetails details, AsyncCallback callback, object userData)
 Begins the history read raw. More...
 
IAsyncResult BeginHistoryReadAtTime (IList< HistoryReadValueId > nodesToRead, ReadAtTimeDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the history read raw. More...
 
List< HistoryDataReadResultEndHistoryReadAtTime (IAsyncResult result)
 Ends the history read raw. More...
 
List< HistoryDataReadResultReleaseHistoryContinuationPoints (IList< HistoryReadValueId > nodesToRead)
 Histories the read raw. More...
 
List< HistoryDataReadResultReleaseHistoryContinuationPoints (IList< HistoryReadValueId > nodesToRead, RequestSettings settings)
 Histories the read raw. More...
 
IAsyncResult BeginReleaseHistoryContinuationPoints (IList< HistoryReadValueId > nodesToRead, AsyncCallback callback, object userData)
 Begins the history read raw. More...
 
IAsyncResult BeginReleaseHistoryContinuationPoints (IList< HistoryReadValueId > nodesToRead, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the history read raw. More...
 
List< HistoryDataReadResultEndReleaseHistoryContinuationPoints (IAsyncResult result)
 Ends the history read raw. More...
 
List< AddNodesResultAddNodes (IList< AddNodesItem > nodesToAdd, RequestSettings settings)
 Adds the nodes. More...
 
IAsyncResult BeginAddNodes (IList< AddNodesItem > nodesToAdd, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the add nodes. More...
 
List< AddNodesResultEndAddNodes (IAsyncResult result)
 Ends the add nodes. More...
 
List< StatusCodeAddReferences (IList< AddReferencesItem > referencesToAdd, RequestSettings settings)
 Adds the references. More...
 
IAsyncResult BeginAddReferences (IList< AddReferencesItem > referencesToAdd, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the add references operation. More...
 
List< StatusCodeEndAddReferences (IAsyncResult result)
 Ends the add nodes. More...
 
List< StatusCodeDeleteNodes (IList< DeleteNodesItem > nodesToDelete, RequestSettings settings)
 Deletes the nodes. More...
 
IAsyncResult BeginDeleteNodes (IList< DeleteNodesItem > nodesToDelete, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the delete nodes operation. More...
 
List< StatusCodeEndDeleteNodes (IAsyncResult result)
 Ends the add nodes. More...
 
List< StatusCodeDeleteReferences (IList< DeleteReferencesItem > referencesToDelete, RequestSettings settings)
 Deletes the references. More...
 
IAsyncResult BeginDeleteReferences (IList< DeleteReferencesItem > referencesToDelete, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the delete references operation. More...
 
List< StatusCodeEndDeleteReferences (IAsyncResult result)
 Ends the add nodes. More...
 
List< NodeIdRegisterNodes (IList< NodeId > nodesToRegister, RequestSettings settings)
 Registers the nodes. More...
 
IAsyncResult BeginRegisterNodes (IList< NodeId > nodesToRegister, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the add nodes. More...
 
List< NodeIdEndRegisterNodes (IAsyncResult result)
 Ends the add nodes. More...
 
void UnregisterNodes (IList< NodeId > nodesToUnregister, RequestSettings settings)
 Registers the nodes. More...
 
IAsyncResult BeginUnregisterNodes (IList< NodeId > nodesToUnregister, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the add nodes. More...
 
void EndUnregisterNodes (IAsyncResult result)
 Ends the add nodes. More...
 

Properties

ApplicationInstance Application [get, set]
 Gets the application. More...
 
NodeId SessionId [get]
 Gets the session id. More...
 
CacheManager Cache [get, set]
 Gets the cache manager. More...
 
ModelManager Model [get, set]
 Gets the model manager. More...
 
Object UserData [get, set]
 Gets or sets the user data. More...
 
RequestSettings DefaultRequestSettings [get, set]
 Gets or sets the default request settings. More...
 
string SessionName [get, set]
 Gets or sets the name of the session. More...
 
UserIdentity UserIdentity [get, set]
 Gets or sets the user identity. More...
 
IList< string > PreferredLocales [get, set]
 Gets or sets the preferred locales. More...
 
int SecureChannelLifetime [get, set]
 Gets or sets the secure channel lifetime. More...
 
int SecureChannelTimeout [get, set]
 Gets or sets the secure channel timeout. More...
 
int SessionTimeout [get, set]
 Gets or sets the session timeout. More...
 
uint WatchdogCycleTime [get, set]
 Gets or sets the watchdog cycle time. More...
 
uint WatchdogTimeout [get, set]
 Gets or sets the watchdog timeout. More...
 
bool AutomaticReconnect [get, set]
 Gets or sets a value indicating whether the session should automatically reconnect on error. More...
 
uint ReconnectDelay [get, set]
 Gets or sets the delay between reconnect attempts. More...
 
uint PublishPipelineDepth [get, set]
 Gets or sets the publish pipeline depth. More...
 
EndpointDescription EndpointDescription [get, set]
 Gets or sets the endpoint description. More...
 
ServerConnectionStatus ConnectionStatus [get, set]
 Gets the server connection status. More...
 
IList< string > AlternativeEndpointUrls [get, set]
 Gets or sets the alternative endpoint urls. More...
 
TimestampsToReturn DefaultTimestampToReturn [get, set]
 Gets or sets the default timestamp to return. More...
 
MessageContext MessageContext [get]
 Gets the message context. More...
 
NamespaceTable NamespaceUris [get]
 Gets the namespace uris. More...
 
StringTable ServerUris [get]
 Gets the server uris. More...
 
EncodeableFactory Factory [get]
 Gets the dictionary of data types known to the stack. More...
 

Events

ServerConnectionStatusUpdateEventHandler ConnectionStatusUpdate
 Raised when the connection status has been updated. More...
 
SessionValidationEventHandler SessionValidationError
 Raised when a non-fatal error occurs during session establishment. More...
 

Detailed Description

A class that manages a session with an OPC UA server.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.Session.Session ( )

Create a session for the default client application.

UnifiedAutomation.UaClient.Session.Session ( ApplicationInstance  application)

Create a session for the specified client application.

Member Function Documentation

List<AddNodesResult> UnifiedAutomation.UaClient.Session.AddNodes ( IList< AddNodesItem nodesToAdd,
RequestSettings  settings 
)

Adds the nodes.

Parameters
nodesToAddThe nodes to add.
settingsThe settings.
Returns
List<StatusCode> UnifiedAutomation.UaClient.Session.AddReferences ( IList< AddReferencesItem referencesToAdd,
RequestSettings  settings 
)

Adds the references.

Parameters
referencesToAddThe references to add.
settingsThe settings.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginAddNodes ( IList< AddNodesItem nodesToAdd,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the add nodes.

Parameters
nodesToAddThe nodes to add.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginAddReferences ( IList< AddReferencesItem referencesToAdd,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the add references operation.

Parameters
referencesToAddThe references to add.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowse ( NodeId  nodeToBrowse,
AsyncCallback  callback,
Object  userData 
)

Browse OPC server address space with one starting node asnchonously. The Browse Service is used by a client to navigate through the Address Space by passing a starting Node and browse filters. The server returns the list of referenced nodes matching the filter criteria.

The Browse Service takes a list of starting Nodes and returns a list of connected Nodes for each starting Node. Nevertheless , most clients will only pass one starting Node for the main purpose of building a tree hierarchy. Since the OPC UA Address Space can be a full-meshed network and is not limited to a pure hierarchy , the capability to pass in a list of starting Nodes is mainly used to browse metadata like the Properties of a list of Variables. The client SDK provides different browse methods , one for a single starting Node and one for a list of starting Nodes.

This simplified browse method is used for a single starting node.

Parameters
nodeToBrowseThe node to browse.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.

This method returns only forward hierarchial references.

Returns
An object which must be passed to the EndBrowse method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowse ( NodeId  nodeToBrowse,
BrowseContext  browseContext,
AsyncCallback  callback,
Object  userData 
)

This is an overloaded function. See BeginBrowse for more details.

Parameters
nodeToBrowseThe node to browse.
browseContextThe browse context.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowse ( NodeId  nodeToBrowse,
BrowseContext  browseContext,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the browse.

Parameters
nodeToBrowseThe node to browse.
browseContextThe browse context.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowseList ( List< BrowseDescription nodesToBrowse,
AsyncCallback  callback,
object  userData 
)

Begins the browse.

Parameters
nodesToBrowseThe nodes to browse.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowseList ( ViewDescription  view,
List< BrowseDescription nodesToBrowse,
uint  maxReferencesPerBrowse,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the browse.

Parameters
viewThe view.
nodesToBrowseThe nodes to browse.
maxReferencesPerBrowseThe max references per browse.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowseNext ( byte[]  continuationPoint,
AsyncCallback  callback,
object  userData 
)

Begins a browse next operation.

Parameters
continuationPointThe continuation point.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndBrowseNext method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowseNext ( byte[]  continuationPoint,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins a browse next operation.

Parameters
continuationPointThe continuation point.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndBrowse method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginCall ( NodeId  objectToCall,
NodeId  methodToCall,
List< Variant inputArguments,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Calls the specified method.

Parameters
objectToCallThe object to call.
methodToCallThe method to call.
inputArgumentsThe input arguments.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginCallList ( IList< CallMethodRequest methodsToCall,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the method call.

Parameters
methodsToCallThe methods to call.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginChangeUser ( AsyncCallback  callback,
Object  userData 
)

Change user for the connection to the OPC UA server asynchronously.

Parameters
callbackThe callback to use when the async call completes.
userDataThe user data.
Returns
An object which must be passed to the EndChangeUser method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginChangeUser ( UserIdentity  userIdentity,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Change user for the connection to the OPC UA server asynchronously.

Parameters
userIdentityThe user identity.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndChangeUser method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginConnect ( string  endpointUrl,
SecuritySelection  securitySelection,
string  transportProfileUri,
RetryInitialConnect  retryInitialConnect,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Establish a connection to the OPC UA server Calling this function successfully creates a secure channel to the server endpoint and it creates and activates an application session in the server application.The SDK is managing the connection to the server by

  • Monitoring the status of the session with read calls to the server status variable. The frequency of the read calls can be controlled with the property WatchdogCycleTime
  • Reconnect on TCP/IP or SecureChannel level if the connection was lost
  • Recreation of the session if the session timed out or the server was restarted
  • The callback ConnectionStatusUpdate provides information about the current status of the session
Parameters
endpointUrlThe URL of the server endpoint to connect to.

UA TCP: opc.tcp://networknode:4840

WebService: https://networknode/ServerName

Parameters
securitySelectionThe requested security level. The option None disables security. The option BestAvailable selects the highest security level suported by the server.
transportProfileUriThe transport profile URI to use (if null the default for the URL scheme is used).
retryInitialConnectThe retry initial connect.
settingsThe generel settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndConnect() method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginConnect ( EndpointDescription  endpoint,
RetryInitialConnect  retryInitialConnect,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Establish a connection to the OPC UA server

Connects to the specified endpoint provided by a server or stored in configuration. The available endpoints can be requested through Discovery::GetEndpoints

Parameters
endpointThe full definition of an OPC UA server endpoint.
retryInitialConnectThe retry initial connect.
settingsThe generel settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndConnect() method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginDeleteNodes ( IList< DeleteNodesItem nodesToDelete,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the delete nodes operation.

Parameters
nodesToDeleteThe nodes to delete.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginDeleteReferences ( IList< DeleteReferencesItem referencesToDelete,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the delete references operation.

Parameters
referencesToDeleteThe references to delete.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginDisconnect ( AsyncCallback  callback,
object  userData 
)

Disconnect client application from OPC UA server. Calling this function closes the session and the secure channel connection to the server. The subscriptions assigned the session are also deleted.

Parameters
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndDisconnect() method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginDisconnect ( SubscriptionCleanupPolicy  cleanupPolicy,
AsyncCallback  callback,
object  userData 
)

Disconnect client application from OPC UA server. Calling this function closes the session and the secure channel connection to the server. The subscriptions assigned the session are also deleted if the cleanupPolicy is set to Delete.

Parameters
cleanupPolicyThe cleanup policy for the subscription. The option Delete removes the subscription together with the session. The sbscriptions are not deleted when option Keep is used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndDisconnect() method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginDisconnect ( SubscriptionCleanupPolicy  cleanupPolicy,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Disconnect client application from OPC UA server. Calling this function closes the session and the secure channel connection to the server. The subscriptions assigned the session are also deleted if the cleanupPolicy is set to Delete.

Parameters
cleanupPolicyThe cleanup policy for the subscription. The option Delete removes the subscription together with the session. The sbscriptions are not deleted when option Keep is used.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndDisconnect() method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadAtTime ( IList< HistoryReadValueId nodesToRead,
ReadAtTimeDetails  details,
AsyncCallback  callback,
object  userData 
)

Begins the history read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadAtTime ( IList< HistoryReadValueId nodesToRead,
ReadAtTimeDetails  details,
TimestampsToReturn  timestampsToReturn,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the history read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
timestampsToReturnThe timestamps to return.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadModified ( IList< HistoryReadValueId nodesToRead,
ReadRawModifiedDetails  details,
AsyncCallback  callback,
object  userData 
)

Begins the history read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadModified ( IList< HistoryReadValueId nodesToRead,
ReadRawModifiedDetails  details,
TimestampsToReturn  timestampsToReturn,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the history read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
timestampsToReturnThe timestamps to return.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadProcessed ( IList< HistoryReadValueId nodesToRead,
ReadProcessedDetails  details,
AsyncCallback  callback,
object  userData 
)

Begins the history read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadProcessed ( IList< HistoryReadValueId nodesToRead,
ReadProcessedDetails  details,
TimestampsToReturn  timestampsToReturn,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the history read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
timestampsToReturnThe timestamps to return.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadRaw ( IList< HistoryReadValueId nodesToRead,
ReadRawModifiedDetails  details,
AsyncCallback  callback,
object  userData 
)

Begins the history read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadRaw ( IList< HistoryReadValueId nodesToRead,
ReadRawModifiedDetails  details,
TimestampsToReturn  timestampsToReturn,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the history read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
timestampsToReturnThe timestamps to return.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginRead ( IList< ReadValueId nodesToRead,
uint  maxAge,
TimestampsToReturn  timestampsToReturn,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Reads values and attributes asynchronously from OPC server. The Read Service is used to read one or more attributes of one or more nodes. It allows also reading subsets or single elements of array values and to define a valid age of values to be returned to reduce the need for device reads. Like most other services, the read is optimized for bulk read operations and not for reading single Attribute values. Typically all Node Attributes are readable. For the Value Attribute the Read rights are indicated by the AccessLevel and UserAccessLevel Attribute of the Variable.

Parameters
nodesToReadList of nodes and attributes to read.
maxAgeThe maximum age for any value.
timestampsToReturnOPC UA defines two timestamps, the source and the server timestamp. This parameter allows the client to define which timestamps the server should return with the value.
The source timestamp is only available for Value Attributes. The source timestamp is used to reflect the timestamp that was applied to a Variable value by the data source. It should indicate the last change of the value or status code. The source timestamp must be always generated by the same physical clock. This timestamp type was added for OPC UA to cover the use case to get the timestamp of the last value change which is different than the server timestamp definition.
The server timestamp is used to reflect the time that the server received a Variable value or knew it to be accurate if the changes are reported by exception and the connection to the data source is operating. This is the behavior expected by Classic OPC
Possible values are
  • TimestampsToReturn.Source
  • TimestampsToReturn.Server
  • TimestampsToReturn.Both
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndRead() method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginRead ( IList< ReadValueId nodesToRead,
uint  maxAge,
TimestampsToReturn  timestampsToReturn,
AsyncCallback  callback,
Object  userData 
)

This is an overloaded function. See BeginRead for more details.

Parameters
nodesToReadThe nodes to read.
maxAgeThe max age.
timestampsToReturnThe timestamps to return.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndRead() method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginRead ( IList< ReadValueId nodesToRead,
uint  maxAge,
AsyncCallback  callback,
Object  userData 
)

This is an overloaded function. See BeginRead for more details.

Parameters
nodesToReadThe nodes to read.
maxAgeThe max age.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndRead() method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginRegisterNodes ( IList< NodeId nodesToRegister,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the add nodes.

Parameters
nodesToRegisterThe nodes to register.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginReleaseBrowseContinuationPoint ( byte[]  continuationPoint,
AsyncCallback  callback,
object  userData 
)

Begins a release browse continuation point operation.

Parameters
continuationPointThe continuation point.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginReleaseBrowseContinuationPoint ( byte[]  continuationPoint,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins a release browse continuation point operation.

Parameters
continuationPointThe continuation point.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginReleaseHistoryContinuationPoints ( IList< HistoryReadValueId nodesToRead,
AsyncCallback  callback,
object  userData 
)

Begins the history read raw.

Parameters
nodesToReadThe nodes to read.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginReleaseHistoryContinuationPoints ( IList< HistoryReadValueId nodesToRead,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the history read raw.

Parameters
nodesToReadThe nodes to read.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginTranslateBrowsePath ( IList< BrowsePath pathsToTranslate,
AsyncCallback  callback,
object  userData 
)

Begins the translate browse path.

Parameters
pathsToTranslateThe paths to translate.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginTranslateBrowsePath ( NodeId  startingNodeId,
IList< string >  browsePaths,
AsyncCallback  callback,
object  userData 
)

Begins the translate browse path.

Parameters
startingNodeIdThe starting node.
browsePathsA list of browse paths to translate.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginTranslateBrowsePath ( NodeId  startingNodeId,
IList< string >  browsePaths,
NamespaceTable  namespaceUris,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins a translate browse paths operation.

Parameters
startingNodeIdThe starting node.
browsePathsA list of browse paths to translate.
namespaceUrisThe table of namespace referenced by the browse paths (if null the session namespace table is assumed).
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginTranslateBrowsePath ( IList< BrowsePath pathsToTranslate,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the translate browse path.

Parameters
pathsToTranslateThe paths to translate.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginUnregisterNodes ( IList< NodeId nodesToUnregister,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Begins the add nodes.

Parameters
nodesToUnregisterThe nodes to unregister.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
IAsyncResult UnifiedAutomation.UaClient.Session.BeginWrite ( IList< WriteValue nodesToWrite,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)

Writes attributes asynchronously to a OPC UA server.

Parameters
nodesToWriteList of nodes and attributes to write.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
callbackThe callback to use when the async call completes.
userDataThe user data that is passed to the callback.
Returns
An object which must be passed to the EndWrite() method.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginWrite ( IList< WriteValue nodesToWrite,
AsyncCallback  callback,
Object  userData 
)

This is an overloaded function. See Write for more details.

List<ReferenceDescription> UnifiedAutomation.UaClient.Session.Browse ( NodeId  nodeToBrowse,
BrowseContext  browseContext,
RequestSettings  settings,
out byte[]  continuationPoint 
)

Browse OPC server address space with one starting node. The Browse Service is used by a client to navigate through the Address Space by passing a starting Node and browse filters. The server returns the list of referenced nodes matching the filter criteria.

The Browse Service takes a list of starting Nodes and returns a list of connected Nodes for each starting Node. Nevertheless , most clients will only pass one starting Node for the main purpose of building a tree hierarchy. Since the OPC UA Address Space can be a full-meshed network and is not limited to a pure hierarchy , the capability to pass in a list of starting Nodes is mainly used to browse metadata like the Properties of a list of Variables. The client SDK provides different browse methods , one for a single starting Node and one for a list of starting Nodes.

This simplified browse method is used for a single starting node.

Parameters
nodeToBrowseNodeId of the starting Node
browseContextFilter settings for the browse call. See BrowseContext for more details
settings
continuationPointout: A continuation point is returned when the server was not able to deliver all results in the Browse response. The limitation can be set by the client in the request or by the server during Browse processing. The continuation point can be passed to browseNext to get the remaining results
Returns
List of references and target Node information for the Nodes passing the filter criteria set in the request.
List<ReferenceDescription> UnifiedAutomation.UaClient.Session.Browse ( NodeId  nodeToBrowse,
BrowseContext  browseContext,
out byte[]  continuationPoint 
)

This is an overloaded function. See Browse for more details.

Parameters
nodeToBrowseThe node to browse.
browseContextThe browse context.
continuationPointThe continuation point.
Returns
List<ReferenceDescription> UnifiedAutomation.UaClient.Session.Browse ( NodeId  nodeToBrowse,
out byte[]  continuationPoint 
)

This is an overloaded function. See Browse for more details.

Parameters
nodeToBrowseThe node to browse.
continuationPointThe continuation point.

This method returns only forward hierarchial references.

Returns
List<List<ReferenceDescription> > UnifiedAutomation.UaClient.Session.BrowseList ( List< BrowseDescription nodesToBrowse)

Browses the specified nodes.

Parameters
nodesToBrowseThe nodes to browse.
Returns
List<List<ReferenceDescription> > UnifiedAutomation.UaClient.Session.BrowseList ( ViewDescription  view,
List< BrowseDescription nodesToBrowse,
uint  maxReferencesPerBrowse,
RequestSettings  settings 
)

Browses the specified nodes.

Parameters
viewThe view.
nodesToBrowseThe nodes to browse.
maxReferencesPerBrowseThe max references per browse.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
Returns
List<ReferenceDescription> UnifiedAutomation.UaClient.Session.BrowseNext ( ref byte[]  continuationPoint)

Continues a browse operation.

Parameters
continuationPointThe continuation point.
Returns
List of references and target Node information for the Nodes passing the filter criteria set in the request.
List<ReferenceDescription> UnifiedAutomation.UaClient.Session.BrowseNext ( RequestSettings  settings,
ref byte[]  continuationPoint 
)

Continue a previous Browse request.This method is only used to continue a browse started with the browse method if not all results could be returned by the browse or a following browseNext call. The number of Nodes to return can be limited by the client in the browse request or by the Server during processing the Browse Service call.

Parameters
settings
continuationPointref: Continuation points returned from a previous browse or browseNext call. A continuation point is returned when the server was not able to deliver all results in the BrowseNext response. The limitation can be set by the client in the browse or by the server during
Returns
List of references and target Node information for the Nodes passing the filter criteria set in the first browse call
List<Variant> UnifiedAutomation.UaClient.Session.Call ( NodeId  objectToCall,
NodeId  methodToCall 
)

Calls a method of an Object in the OPC server

Parameters
objectToCallThe object to call.
methodToCallThe method to call.
Returns
StatusCode UnifiedAutomation.UaClient.Session.Call ( NodeId  objectToCall,
NodeId  methodToCall,
List< Variant inputArguments,
out List< StatusCode inputArgumentErrors,
out List< Variant outputArguments 
)

Calls the specified method.

Parameters
objectToCallThe object to call.
methodToCallThe method to call.
inputArgumentsThe input arguments.
inputArgumentErrorsThe input argument errors.
outputArgumentsThe output arguments.
Returns
StatusCode UnifiedAutomation.UaClient.Session.Call ( NodeId  objectToCall,
NodeId  methodToCall,
List< Variant inputArguments,
RequestSettings  settings,
out List< StatusCode inputArgumentErrors,
out List< Variant outputArguments 
)

Calls the specified method.

Parameters
objectToCallThe object to call.
methodToCallThe method to call.
inputArgumentsThe input arguments.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
inputArgumentErrorsThe input argument errors.
outputArgumentsThe output arguments.
Returns
List<CallMethodResult> UnifiedAutomation.UaClient.Session.CallList ( IList< CallMethodRequest methodsToCall,
RequestSettings  settings 
)

Calls the specified methods to call.

Parameters
methodsToCallThe methods to call.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
Returns
void UnifiedAutomation.UaClient.Session.ChangeUser ( )

Change user for the connection to the OPC UA server. Calling this function changes the user of the session by calling ActivateSession with the new user identity.

void UnifiedAutomation.UaClient.Session.ChangeUser ( UserIdentity  userIdentity)

Change user for the connection to the OPC UA server. Calling this function changes the user of the session by calling ActivateSession with the new user identity.

Parameters
userIdentityThe user identity.
void UnifiedAutomation.UaClient.Session.ChangeUser ( UserIdentity  userIdentity,
RequestSettings  settings 
)

Change user for the connection to the OPC UA server. Calling this function changes the user of the session by calling ActivateSession with the new user identity.

Parameters
userIdentityThe user identity.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
void UnifiedAutomation.UaClient.Session.Connect ( string  endpointUrl,
SecuritySelection  securitySelection 
)

Establish a connection to the OPC UA server.

Calling this function successfully creates a secure channel to the server endpoint and it creates and activates an application session in the server application.

The SDK is managing the connection to the server by

  • Monitoring the status of the session with read calls to the server status variable. The frequency of the read calls can be controlled with the property WatchdogCycleTime
  • Reconnect on TCP/IP or SecureChannel level if the connection was lost
  • Recreation of the session if the session timed out or the server was restarted
  • The callback ConnectionStatusUpdate provides information about the current status of the session
Parameters
endpointUrlThe URL of the server endpoint to connect to.

UA TCP: opc.tcp://networknode:4840

WebService: https://networknode/ServerName

Parameters
securitySelectionThe requested security level. The option None disables security. The option BestAvailable selects the highest security level suported by the server.
void UnifiedAutomation.UaClient.Session.Connect ( string  endpointUrl,
SecuritySelection  securitySelection,
RequestSettings  settings 
)

Establish a connection to the OPC UA server.

Calling this function successfully creates a secure channel to the server endpoint and it creates and activates an application session in the server application.

The SDK is managing the connection to the server by

  • Monitoring the status of the session with read calls to the server status variable. The frequency of the read calls can be controlled with the property WatchdogCycleTime
  • Reconnect on TCP/IP or SecureChannel level if the connection was lost
  • Recreation of the session if the session timed out or the server was restarted
  • The callback ConnectionStatusUpdate provides information about the current status of the session
Parameters
endpointUrlThe URL of the server endpoint to connect to.

UA TCP: opc.tcp://networknode:4840

WebService: https://networknode/ServerName

Parameters
securitySelectionThe requested security level. The option None disables security. The option BestAvailable selects the highest security level suported by the server.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
void UnifiedAutomation.UaClient.Session.Connect ( string  endpointUrl,
SecuritySelection  securitySelection,
string  transportProfileUri,
RetryInitialConnect  retryInitialConnect,
RequestSettings  settings 
)

Connects the specified endpoint URL.

Parameters
endpointUrlThe endpoint URL.
securitySelectionThe security selection.
transportProfileUriThe transport profile URI.
retryInitialConnectThe retry initial connect.
settingsThe settings.
void UnifiedAutomation.UaClient.Session.Connect ( EndpointDescription  endpoint,
RequestSettings  settings 
)

Establish a connection to the OPC UA server

Connects to the specified endpoint provided by a server or stored in configuration. The available endpoints can be requested through Discovery::GetEndpoints

Parameters
endpointThe full definition of an OPC UA server endpoint.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
void UnifiedAutomation.UaClient.Session.Connect ( EndpointDescription  endpoint,
RetryInitialConnect  retryInitialConnect,
RequestSettings  settings 
)

Connects the specified endpoint.

Parameters
endpointThe endpoint.
retryInitialConnectThe retry initial connect.
settingsThe settings.
List<StatusCode> UnifiedAutomation.UaClient.Session.DeleteNodes ( IList< DeleteNodesItem nodesToDelete,
RequestSettings  settings 
)

Deletes the nodes.

Parameters
nodesToDeleteThe nodes to delete.
settingsThe settings.
Returns
List<StatusCode> UnifiedAutomation.UaClient.Session.DeleteReferences ( IList< DeleteReferencesItem referencesToDelete,
RequestSettings  settings 
)

Deletes the references.

Parameters
referencesToDeleteThe references to delete.
settingsThe settings.
Returns
void UnifiedAutomation.UaClient.Session.Disconnect ( )

Disconnect client application from OPC UA server. Calling this function closes the session and the secure channel connection to the server. The subscriptions assigned to the session are also deleted.

void UnifiedAutomation.UaClient.Session.Disconnect ( SubscriptionCleanupPolicy  cleanupPolicy)

Disconnect client application from OPC UA server. Calling this function closes the session and the secure channel connection to the server. The subscriptions assigned to the session are also deleted if the cleanupPolicy is set to Delete.

Parameters
cleanupPolicyThe cleanup policy for the subscription. The option Delete removes the subscription together with the session. The sbscriptions are not deleted when option Keep is used.
void UnifiedAutomation.UaClient.Session.Disconnect ( SubscriptionCleanupPolicy  cleanupPolicy,
RequestSettings  settings 
)

Disconnect client application from OPC UA server. Calling this function closes the session and the secure channel connection to the server. The subscriptions assigned to the session are also deleted if the cleanupPolicy is set to Delete.

Parameters
cleanupPolicyThe cleanup policy for the subscription. The option Delete removes the subscription together with the session. The sbscriptions are not deleted when option Keep is used.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
void UnifiedAutomation.UaClient.Session.Dispose ( )

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

List<AddNodesResult> UnifiedAutomation.UaClient.Session.EndAddNodes ( IAsyncResult  result)

Ends the add nodes.

Parameters
resultThe result.
Returns
List<StatusCode> UnifiedAutomation.UaClient.Session.EndAddReferences ( IAsyncResult  result)

Ends the add nodes.

Parameters
resultThe result.
Returns
List<ReferenceDescription> UnifiedAutomation.UaClient.Session.EndBrowse ( IAsyncResult  result,
out byte[]  continuationPoint 
)

Ends a browse.

Parameters
resultThe result.
continuationPointThe continuation point.
Returns
List of references and target Node information for the Nodes passing the filter criteria set in the request.
List<List<ReferenceDescription> > UnifiedAutomation.UaClient.Session.EndBrowseList ( IAsyncResult  result)

Ends a browse.

Parameters
resultThe result.
Returns
List<Variant> UnifiedAutomation.UaClient.Session.EndCall ( IAsyncResult  result)

Calls the specified method.

Parameters
resultThe result.
Returns
StatusCode UnifiedAutomation.UaClient.Session.EndCall ( IAsyncResult  result,
out List< StatusCode inputArgumentErrors,
out List< Variant outputArguments 
)

Calls the specified method.

Parameters
resultThe result.
inputArgumentErrorsThe input argument errors.
outputArgumentsThe output arguments.
Returns
List<CallMethodResult> UnifiedAutomation.UaClient.Session.EndCallList ( IAsyncResult  result)

Ends a call method request.

Parameters
resultThe result.
Returns
void UnifiedAutomation.UaClient.Session.EndChangeUser ( IAsyncResult  result)

Completes a change user request.

Parameters
resultThe result returned from BeginChangeUser method
void UnifiedAutomation.UaClient.Session.EndConnect ( IAsyncResult  result)

Completes an asynchronous connect operation.

Parameters
resultThe object returned from the BeginConnect method.
List<StatusCode> UnifiedAutomation.UaClient.Session.EndDeleteNodes ( IAsyncResult  result)

Ends the add nodes.

Parameters
resultThe result.
Returns
List<StatusCode> UnifiedAutomation.UaClient.Session.EndDeleteReferences ( IAsyncResult  result)

Ends the add nodes.

Parameters
resultThe result.
Returns
void UnifiedAutomation.UaClient.Session.EndDisconnect ( IAsyncResult  result)

Completes an asynchronous disconnect operation.

Parameters
resultThe object returned from the BeginDisconnect method.
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.EndHistoryReadAtTime ( IAsyncResult  result)

Ends the history read raw.

Parameters
resultThe result.
Returns
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.EndHistoryReadModified ( IAsyncResult  result)

Ends the history read raw.

Parameters
resultThe result.
Returns
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.EndHistoryReadProcessed ( IAsyncResult  result)

Ends the history read raw.

Parameters
resultThe result.
Returns
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.EndHistoryReadRaw ( IAsyncResult  result)

Ends the history read raw.

Parameters
resultThe result.
Returns
List<DataValue> UnifiedAutomation.UaClient.Session.EndRead ( IAsyncResult  result)

Completes an asynchronous read operation.

Parameters
resultThe object returned from the BeginRead method.
Returns
List of read results.
List<NodeId> UnifiedAutomation.UaClient.Session.EndRegisterNodes ( IAsyncResult  result)

Ends the add nodes.

Parameters
resultThe result.
Returns
void UnifiedAutomation.UaClient.Session.EndReleaseBrowseContinuationPoint ( IAsyncResult  result)

Ends the release browse continuation point operation.

Parameters
resultThe result.
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.EndReleaseHistoryContinuationPoints ( IAsyncResult  result)

Ends the history read raw.

Parameters
resultThe result.
Returns
List<BrowsePathResult> UnifiedAutomation.UaClient.Session.EndTranslateBrowsePath ( IAsyncResult  result)

Ends the translate browse path.

Parameters
resultThe result.
Returns
void UnifiedAutomation.UaClient.Session.EndUnregisterNodes ( IAsyncResult  result)

Ends the add nodes.

Parameters
resultThe result.
Returns
List<StatusCode> UnifiedAutomation.UaClient.Session.EndWrite ( IAsyncResult  result)

Ends the write.

Parameters
resultThe result returned from BeginWrite method.
Returns
List of StatusCode that indicate the successes of the writes to each node.
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadAtTime ( IList< HistoryReadValueId nodesToRead,
ReadAtTimeDetails  details 
)

Histories the read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
Returns
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadAtTime ( IList< HistoryReadValueId nodesToRead,
ReadAtTimeDetails  details,
TimestampsToReturn  timestampsToReturn,
RequestSettings  settings 
)

Histories the read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
timestampsToReturnThe timestamps to return.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
Returns
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadModified ( IList< HistoryReadValueId nodesToRead,
ReadRawModifiedDetails  details 
)

Histories the read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
Returns
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadModified ( IList< HistoryReadValueId nodesToRead,
ReadRawModifiedDetails  details,
TimestampsToReturn  timestampsToReturn,
RequestSettings  settings 
)

Histories the read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
timestampsToReturnThe timestamps to return.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
Returns
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadProcessed ( IList< HistoryReadValueId nodesToRead,
ReadProcessedDetails  details 
)

Histories the read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
Returns
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadProcessed ( IList< HistoryReadValueId nodesToRead,
ReadProcessedDetails  details,
TimestampsToReturn  timestampsToReturn,
RequestSettings  settings 
)

Histories the read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
timestampsToReturnThe timestamps to return.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
Returns
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadRaw ( IList< HistoryReadValueId nodesToRead,
ReadRawModifiedDetails  details 
)

Histories the read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
Returns
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadRaw ( IList< HistoryReadValueId nodesToRead,
ReadRawModifiedDetails  details,
TimestampsToReturn  timestampsToReturn,
RequestSettings  settings 
)

Histories the read raw.

Parameters
nodesToReadThe nodes to read.
detailsThe details.
timestampsToReturnThe timestamps to return.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
Returns
List<DataValue> UnifiedAutomation.UaClient.Session.Read ( IList< ReadValueId nodesToRead,
uint  maxAge,
TimestampsToReturn  timestampsToReturn,
RequestSettings  settings 
)

Reads attribute values synchronous from OPC server. The Read Service is used to read one or more attributes of one or more nodes. It allows also reading subsets or single elements of array values and to define a valid age of values to be returned to reduce the need for device reads. Like most other services, the read is optimized for bulk read operations and not for reading single Attribute values. Typically all Node Attributes are readable. For the Value Attribute the Read rights are indicated by the AccessLevel and UserAccessLevel Attribute of the Variable.

Parameters
nodesToReadList of nodes and attributes to read.
maxAgeThe maximum age of the value to be read in milliseconds. This parameter allows clients to reduce the communication between server and data source by allowing the server to return a cached value that is not older than the defined time period. Setting a value of 0 forces the server to obtain the current value. This is similar to a device read in Classic OPC.
timestampsToReturnOPC UA defines two timestamps, the source and the server timestamp. This parameter allows the client to define which timestamps the server should return with the value.
The source timestamp is only available for Value Attributes. The source timestamp is used to reflect the timestamp that was applied to a Variable value by the data source. It should indicate the last change of the value or status code. The source timestamp must be always generated by the same physical clock. This timestamp type was added for OPC UA to cover the use case to get the timestamp of the last value change which is different than the server timestamp definition.
The server timestamp is used to reflect the time that the server received a Variable value or knew it to be accurate if the changes are reported by exception and the connection to the data source is operating. This is the behavior expected by Classic OPC
Possible values are
  • TimestampsToReturn.Source
  • TimestampsToReturn.Server
  • TimestampsToReturn.Both
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
Returns
List of read results.
List<DataValue> UnifiedAutomation.UaClient.Session.Read ( IList< ReadValueId nodesToRead)

Reads attribute values synchronous from OPC server. The Read Service is used to read one or more attributes of one or more nodes. It allows also reading subsets or single elements of array values and to define a valid age of values to be returned to reduce the need for device reads. Like most other services, the read is optimized for bulk read operations and not for reading single Attribute values. Typically all Node Attributes are readable. For the Value Attribute the Read rights are indicated by the AccessLevel and UserAccessLevel Attribute of the Variable.

Parameters
nodesToReadList of nodes and attributes to read.
Returns
List of read results.
List<NodeId> UnifiedAutomation.UaClient.Session.RegisterNodes ( IList< NodeId nodesToRegister,
RequestSettings  settings 
)

Registers the nodes.

Parameters
nodesToRegisterThe nodes to register.
settingsThe settings.
Returns
void UnifiedAutomation.UaClient.Session.ReleaseBrowseContinuationPoint ( byte[]  continuationPoint)

Releases the browse continuation point.

Parameters
continuationPointThe continuation point.
void UnifiedAutomation.UaClient.Session.ReleaseBrowseContinuationPoint ( byte[]  continuationPoint,
RequestSettings  settings 
)

Releases the browse continuation point.

Parameters
continuationPointThe continuation point.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.ReleaseHistoryContinuationPoints ( IList< HistoryReadValueId nodesToRead)

Histories the read raw.

Parameters
nodesToReadThe nodes to read.
Returns
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.ReleaseHistoryContinuationPoints ( IList< HistoryReadValueId nodesToRead,
RequestSettings  settings 
)

Histories the read raw.

Parameters
nodesToReadThe nodes to read.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
Returns
List<BrowsePathResult> UnifiedAutomation.UaClient.Session.TranslateBrowsePath ( IList< BrowsePath pathsToTranslate)

Translate a browse path to a NodeId. This Service is used to access components of an Object based on the knowledge about the ObjectType. Since the NodeId of a Node is needed to access information provided by the Node like subscribing for Variable Value changes or to call a Method , it is necessary to know the NodeIds of components of Objects. Since OPC UA allows programming software components with built-in knowledge of ObjectTypes , UA needs to provide a mechanism to return the NodeIds for components of an Object instance based on the knowledge about the ObjectType. This mechanism is built on the requirement that the BrowseNames of components in the instance must be the same like BrowseNames of components in the type.

Parameters
pathsToTranslateThe list of browse paths for which NodeIds are requested
Returns
List<BrowsePathResult> UnifiedAutomation.UaClient.Session.TranslateBrowsePath ( IList< BrowsePath pathsToTranslate,
RequestSettings  settings 
)

Translates the browse path.

Parameters
pathsToTranslateThe paths to translate.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
Returns
List<BrowsePathResult> UnifiedAutomation.UaClient.Session.TranslateBrowsePath ( NodeId  startingNodeId,
IList< string >  browsePaths 
)

Translates the browse paths.

Parameters
startingNodeIdThe starting node.
browsePathsA list of browse paths to translate.
Returns
List<BrowsePathResult> UnifiedAutomation.UaClient.Session.TranslateBrowsePath ( NodeId  startingNodeId,
IList< string >  browsePaths,
NamespaceTable  namespaceUris,
RequestSettings  settings 
)

Translates the browse paths.

Parameters
startingNodeIdThe starting node.
browsePathsA list of browse paths to translate.
namespaceUrisThe table of namespace referenced by the browse paths (if null the session namespace table is assumed).
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
Returns
void UnifiedAutomation.UaClient.Session.UnregisterNodes ( IList< NodeId nodesToUnregister,
RequestSettings  settings 
)

Registers the nodes.

Parameters
nodesToUnregisterThe nodes to unregister.
settingsThe settings.
List<StatusCode> UnifiedAutomation.UaClient.Session.Write ( IList< WriteValue nodesToWrite,
RequestSettings  settings 
)

Writes attributes synchronously to OPC server. The Write Service is used to write one or more attributes of one or more nodes. For the Value Attribute the Write rights are indicated by the AccessLevel and UserAccessLevel Attribute of the Variable.

Parameters
nodesToWriteList of nodes and attributes to write.
settingsThe general settings for the request. If null the default settings from poperty DefaultRequestSettings are used.
Returns
List of StatusCode that indicate the successes of the writes to each node.
List<StatusCode> UnifiedAutomation.UaClient.Session.Write ( IList< WriteValue nodesToWrite)

This is an overloaded function. See Write for more details.

Parameters
nodesToWriteThe nodes to write.
Returns

Property Documentation

IList<string> UnifiedAutomation.UaClient.Session.AlternativeEndpointUrls
getset

Gets or sets the alternative endpoint urls.

The alternative endpoint urls.

ApplicationInstance UnifiedAutomation.UaClient.Session.Application
getset

Gets the application.

bool UnifiedAutomation.UaClient.Session.AutomaticReconnect
getset

Gets or sets a value indicating whether the session should automatically reconnect on error.

true if the session should automatically reconnect; otherwise, false.

CacheManager UnifiedAutomation.UaClient.Session.Cache
getset

Gets the cache manager.

ServerConnectionStatus UnifiedAutomation.UaClient.Session.ConnectionStatus
getset

Gets the server connection status.

The server connection status.

RequestSettings UnifiedAutomation.UaClient.Session.DefaultRequestSettings
getset

Gets or sets the default request settings.

The default request settings.

TimestampsToReturn UnifiedAutomation.UaClient.Session.DefaultTimestampToReturn
getset

Gets or sets the default timestamp to return.

The default timestamp to return.

EndpointDescription UnifiedAutomation.UaClient.Session.EndpointDescription
getset

Gets or sets the endpoint description.

The endpoint description.

EncodeableFactory UnifiedAutomation.UaClient.Session.Factory
get

Gets the dictionary of data types known to the stack.

MessageContext UnifiedAutomation.UaClient.Session.MessageContext
get

Gets the message context.

ModelManager UnifiedAutomation.UaClient.Session.Model
getset

Gets the model manager.

NamespaceTable UnifiedAutomation.UaClient.Session.NamespaceUris
get

Gets the namespace uris.

IList<string> UnifiedAutomation.UaClient.Session.PreferredLocales
getset

Gets or sets the preferred locales.

The preferred locales.

uint UnifiedAutomation.UaClient.Session.PublishPipelineDepth
getset

Gets or sets the publish pipeline depth.

The publish pipeline depth.

uint UnifiedAutomation.UaClient.Session.ReconnectDelay
getset

Gets or sets the delay between reconnect attempts.

The delay between reconnect attempts.

int UnifiedAutomation.UaClient.Session.SecureChannelLifetime
getset

Gets or sets the secure channel lifetime.

The secure channel lifetime.

int UnifiedAutomation.UaClient.Session.SecureChannelTimeout
getset

Gets or sets the secure channel timeout.

The secure channel timeout.

StringTable UnifiedAutomation.UaClient.Session.ServerUris
get

Gets the server uris.

NodeId UnifiedAutomation.UaClient.Session.SessionId
get

Gets the session id.

string UnifiedAutomation.UaClient.Session.SessionName
getset

Gets or sets the name of the session.

The name of the session.

int UnifiedAutomation.UaClient.Session.SessionTimeout
getset

Gets or sets the session timeout.

The session timeout.

Object UnifiedAutomation.UaClient.Session.UserData
getset

Gets or sets the user data.

The user data.

UserIdentity UnifiedAutomation.UaClient.Session.UserIdentity
getset

Gets or sets the user identity.

The user identity.

uint UnifiedAutomation.UaClient.Session.WatchdogCycleTime
getset

Gets or sets the watchdog cycle time.

The watchdog cycle time.

uint UnifiedAutomation.UaClient.Session.WatchdogTimeout
getset

Gets or sets the watchdog timeout.

The watchdog timeout.

Event Documentation

ServerConnectionStatusUpdateEventHandler UnifiedAutomation.UaClient.Session.ConnectionStatusUpdate

Raised when the connection status has been updated.

SessionValidationEventHandler UnifiedAutomation.UaClient.Session.SessionValidationError

Raised when a non-fatal error occurs during session establishment.


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