UA Bundle SDK .NET
2.1.0.222
|
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. | |
Session (ApplicationInstance application) | |
Create a session for the specified client application. | |
void | Dispose () |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. | |
void | Connect (string endpointUrl, SecuritySelection securitySelection) |
| |
void | Connect (string endpointUrl, SecuritySelection securitySelection, RequestSettings settings) |
| |
void | Connect (string endpointUrl, SecuritySelection securitySelection, string transportProfileUri, RetryInitialConnect retryInitialConnect, RequestSettings settings) |
Connects the specified endpoint URL. | |
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 | |
void | Connect (EndpointDescription endpoint, RequestSettings settings) |
| |
void | Connect (EndpointDescription endpoint, RetryInitialConnect retryInitialConnect, RequestSettings settings) |
Connects the specified endpoint. | |
IAsyncResult | BeginConnect (EndpointDescription endpoint, RetryInitialConnect retryInitialConnect, RequestSettings settings, AsyncCallback callback, object userData) |
| |
void | EndConnect (IAsyncResult result) |
Completes an asynchronous connect operation. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
void | EndDisconnect (IAsyncResult result) |
Completes an asynchronous disconnect operation. | |
List< DataValue > | 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. | |
List< DataValue > | 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. | |
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. | |
IAsyncResult | BeginRead (IList< ReadValueId > nodesToRead, uint maxAge, TimestampsToReturn timestampsToReturn, AsyncCallback callback, Object userData) |
This is an overloaded function. See BeginRead for more details. | |
IAsyncResult | BeginRead (IList< ReadValueId > nodesToRead, uint maxAge, AsyncCallback callback, Object userData) |
This is an overloaded function. See BeginRead for more details. | |
List< DataValue > | EndRead (IAsyncResult result) |
Completes an asynchronous read operation. | |
List< StatusCode > | 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. | |
List< StatusCode > | Write (IList< WriteValue > nodesToWrite) |
This is an overloaded function. See Write for more details. | |
IAsyncResult | BeginWrite (IList< WriteValue > nodesToWrite, RequestSettings settings, AsyncCallback callback, object userData) |
Writes attributes asynchronously to a OPC UA server. | |
IAsyncResult | BeginWrite (IList< WriteValue > nodesToWrite, AsyncCallback callback, Object userData) |
This is an overloaded function. See Write for more details. | |
List< StatusCode > | EndWrite (IAsyncResult result) |
Ends the write. | |
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. | |
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. | |
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. | |
IAsyncResult | BeginChangeUser (AsyncCallback callback, Object userData) |
Change user for the connection to the OPC UA server asynchronously. | |
IAsyncResult | BeginChangeUser (UserIdentity userIdentity, RequestSettings settings, AsyncCallback callback, object userData) |
Change user for the connection to the OPC UA server asynchronously. | |
void | EndChangeUser (IAsyncResult result) |
Completes a change user request. | |
List< ReferenceDescription > | Browse (NodeId nodeToBrowse, BrowseContext browseContext, RequestSettings settings, out byte[] continuationPoint) |
| |
List< ReferenceDescription > | Browse (NodeId nodeToBrowse, BrowseContext browseContext, out byte[] continuationPoint) |
This is an overloaded function. See Browse for more details. | |
List< ReferenceDescription > | Browse (NodeId nodeToBrowse, out byte[] continuationPoint) |
This is an overloaded function. See Browse for more details. | |
IAsyncResult | BeginBrowse (NodeId nodeToBrowse, AsyncCallback callback, Object userData) |
| |
IAsyncResult | BeginBrowse (NodeId nodeToBrowse, BrowseContext browseContext, AsyncCallback callback, Object userData) |
This is an overloaded function. See BeginBrowse for more details. | |
IAsyncResult | BeginBrowse (NodeId nodeToBrowse, BrowseContext browseContext, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the browse. | |
List< ReferenceDescription > | EndBrowse (IAsyncResult result, out byte[] continuationPoint) |
Ends a browse. | |
List< ReferenceDescription > | BrowseNext (ref byte[] continuationPoint) |
Continues a browse operation. | |
List< ReferenceDescription > | 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. | |
IAsyncResult | BeginBrowseNext (byte[] continuationPoint, AsyncCallback callback, object userData) |
Begins a browse next operation. | |
IAsyncResult | BeginBrowseNext (byte[] continuationPoint, RequestSettings settings, AsyncCallback callback, object userData) |
Begins a browse next operation. | |
List< List < ReferenceDescription > > | BrowseList (List< BrowseDescription > nodesToBrowse) |
Browses the specified nodes. | |
List< List < ReferenceDescription > > | BrowseList (ViewDescription view, List< BrowseDescription > nodesToBrowse, uint maxReferencesPerBrowse, RequestSettings settings) |
Browses the specified nodes. | |
IAsyncResult | BeginBrowseList (List< BrowseDescription > nodesToBrowse, AsyncCallback callback, object userData) |
Begins the browse. | |
IAsyncResult | BeginBrowseList (ViewDescription view, List< BrowseDescription > nodesToBrowse, uint maxReferencesPerBrowse, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the browse. | |
List< List < ReferenceDescription > > | EndBrowseList (IAsyncResult result) |
Ends a browse. | |
void | ReleaseBrowseContinuationPoint (byte[] continuationPoint) |
Releases the browse continuation point. | |
void | ReleaseBrowseContinuationPoint (byte[] continuationPoint, RequestSettings settings) |
Releases the browse continuation point. | |
IAsyncResult | BeginReleaseBrowseContinuationPoint (byte[] continuationPoint, AsyncCallback callback, object userData) |
Begins a release browse continuation point operation. | |
IAsyncResult | BeginReleaseBrowseContinuationPoint (byte[] continuationPoint, RequestSettings settings, AsyncCallback callback, object userData) |
Begins a release browse continuation point operation. | |
void | EndReleaseBrowseContinuationPoint (IAsyncResult result) |
Ends the release browse continuation point operation. | |
List< BrowsePathResult > | 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. | |
List< BrowsePathResult > | TranslateBrowsePath (IList< BrowsePath > pathsToTranslate, RequestSettings settings) |
Translates the browse path. | |
List< BrowsePathResult > | TranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths) |
Translates the browse paths. | |
List< BrowsePathResult > | TranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths, NamespaceTable namespaceUris, RequestSettings settings) |
Translates the browse paths. | |
IAsyncResult | BeginTranslateBrowsePath (IList< BrowsePath > pathsToTranslate, AsyncCallback callback, object userData) |
Begins the translate browse path. | |
IAsyncResult | BeginTranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths, AsyncCallback callback, object userData) |
Begins the translate browse path. | |
IAsyncResult | BeginTranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths, NamespaceTable namespaceUris, RequestSettings settings, AsyncCallback callback, object userData) |
Begins a translate browse paths operation. | |
IAsyncResult | BeginTranslateBrowsePath (IList< BrowsePath > pathsToTranslate, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the translate browse path. | |
List< BrowsePathResult > | EndTranslateBrowsePath (IAsyncResult result) |
Ends the translate browse path. | |
List< Variant > | Call (NodeId objectToCall, NodeId methodToCall) |
Calls a method of an Object in the OPC server | |
StatusCode | Call (NodeId objectToCall, NodeId methodToCall, List< Variant > inputArguments, out List< StatusCode > inputArgumentErrors, out List< Variant > outputArguments) |
Calls the specified method. | |
StatusCode | Call (NodeId objectToCall, NodeId methodToCall, List< Variant > inputArguments, RequestSettings settings, out List< StatusCode > inputArgumentErrors, out List< Variant > outputArguments) |
Calls the specified method. | |
IAsyncResult | BeginCall (NodeId objectToCall, NodeId methodToCall, List< Variant > inputArguments, RequestSettings settings, AsyncCallback callback, object userData) |
Calls the specified method. | |
List< Variant > | EndCall (IAsyncResult result) |
Calls the specified method. | |
StatusCode | EndCall (IAsyncResult result, out List< StatusCode > inputArgumentErrors, out List< Variant > outputArguments) |
Calls the specified method. | |
List< CallMethodResult > | CallList (IList< CallMethodRequest > methodsToCall, RequestSettings settings) |
Calls the specified methods to call. | |
IAsyncResult | BeginCallList (IList< CallMethodRequest > methodsToCall, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the method call. | |
List< CallMethodResult > | EndCallList (IAsyncResult result) |
Ends a call method request. | |
List< HistoryDataReadResult > | HistoryReadRaw (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details) |
Histories the read raw. | |
List< HistoryDataReadResult > | HistoryReadRaw (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings) |
Histories the read raw. | |
IAsyncResult | BeginHistoryReadRaw (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, AsyncCallback callback, object userData) |
Begins the history read raw. | |
IAsyncResult | BeginHistoryReadRaw (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the history read raw. | |
List< HistoryDataReadResult > | EndHistoryReadRaw (IAsyncResult result) |
Ends the history read raw. | |
List< HistoryDataReadResult > | HistoryReadModified (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details) |
Histories the read raw. | |
List< HistoryDataReadResult > | HistoryReadModified (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings) |
Histories the read raw. | |
IAsyncResult | BeginHistoryReadModified (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, AsyncCallback callback, object userData) |
Begins the history read raw. | |
IAsyncResult | BeginHistoryReadModified (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the history read raw. | |
List< HistoryDataReadResult > | EndHistoryReadModified (IAsyncResult result) |
Ends the history read raw. | |
List< HistoryDataReadResult > | HistoryReadProcessed (IList< HistoryReadValueId > nodesToRead, ReadProcessedDetails details) |
Histories the read raw. | |
List< HistoryDataReadResult > | HistoryReadProcessed (IList< HistoryReadValueId > nodesToRead, ReadProcessedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings) |
Histories the read raw. | |
IAsyncResult | BeginHistoryReadProcessed (IList< HistoryReadValueId > nodesToRead, ReadProcessedDetails details, AsyncCallback callback, object userData) |
Begins the history read raw. | |
IAsyncResult | BeginHistoryReadProcessed (IList< HistoryReadValueId > nodesToRead, ReadProcessedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the history read raw. | |
List< HistoryDataReadResult > | EndHistoryReadProcessed (IAsyncResult result) |
Ends the history read raw. | |
List< HistoryDataReadResult > | HistoryReadAtTime (IList< HistoryReadValueId > nodesToRead, ReadAtTimeDetails details) |
Histories the read raw. | |
List< HistoryDataReadResult > | HistoryReadAtTime (IList< HistoryReadValueId > nodesToRead, ReadAtTimeDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings) |
Histories the read raw. | |
IAsyncResult | BeginHistoryReadAtTime (IList< HistoryReadValueId > nodesToRead, ReadAtTimeDetails details, AsyncCallback callback, object userData) |
Begins the history read raw. | |
IAsyncResult | BeginHistoryReadAtTime (IList< HistoryReadValueId > nodesToRead, ReadAtTimeDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the history read raw. | |
List< HistoryDataReadResult > | EndHistoryReadAtTime (IAsyncResult result) |
Ends the history read raw. | |
List< HistoryDataReadResult > | ReleaseHistoryContinuationPoints (IList< HistoryReadValueId > nodesToRead) |
Histories the read raw. | |
List< HistoryDataReadResult > | ReleaseHistoryContinuationPoints (IList< HistoryReadValueId > nodesToRead, RequestSettings settings) |
Histories the read raw. | |
IAsyncResult | BeginReleaseHistoryContinuationPoints (IList< HistoryReadValueId > nodesToRead, AsyncCallback callback, object userData) |
Begins the history read raw. | |
IAsyncResult | BeginReleaseHistoryContinuationPoints (IList< HistoryReadValueId > nodesToRead, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the history read raw. | |
List< HistoryDataReadResult > | EndReleaseHistoryContinuationPoints (IAsyncResult result) |
Ends the history read raw. | |
List< AddNodesResult > | AddNodes (IList< AddNodesItem > nodesToAdd, RequestSettings settings) |
Adds the nodes. | |
IAsyncResult | BeginAddNodes (IList< AddNodesItem > nodesToAdd, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the add nodes. | |
List< AddNodesResult > | EndAddNodes (IAsyncResult result) |
Ends the add nodes. | |
List< StatusCode > | AddReferences (IList< AddReferencesItem > referencesToAdd, RequestSettings settings) |
Adds the references. | |
IAsyncResult | BeginAddReferences (IList< AddReferencesItem > referencesToAdd, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the add references operation. | |
List< StatusCode > | EndAddReferences (IAsyncResult result) |
Ends the add nodes. | |
List< StatusCode > | DeleteNodes (IList< DeleteNodesItem > nodesToDelete, RequestSettings settings) |
Deletes the nodes. | |
IAsyncResult | BeginDeleteNodes (IList< DeleteNodesItem > nodesToDelete, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the delete nodes operation. | |
List< StatusCode > | EndDeleteNodes (IAsyncResult result) |
Ends the add nodes. | |
List< StatusCode > | DeleteReferences (IList< DeleteReferencesItem > referencesToDelete, RequestSettings settings) |
Deletes the references. | |
IAsyncResult | BeginDeleteReferences (IList< DeleteReferencesItem > referencesToDelete, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the delete references operation. | |
List< StatusCode > | EndDeleteReferences (IAsyncResult result) |
Ends the add nodes. | |
List< NodeId > | RegisterNodes (IList< NodeId > nodesToRegister, RequestSettings settings) |
Registers the nodes. | |
IAsyncResult | BeginRegisterNodes (IList< NodeId > nodesToRegister, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the add nodes. | |
List< NodeId > | EndRegisterNodes (IAsyncResult result) |
Ends the add nodes. | |
void | UnregisterNodes (IList< NodeId > nodesToUnregister, RequestSettings settings) |
Registers the nodes. | |
IAsyncResult | BeginUnregisterNodes (IList< NodeId > nodesToUnregister, RequestSettings settings, AsyncCallback callback, object userData) |
Begins the add nodes. | |
void | EndUnregisterNodes (IAsyncResult result) |
Ends the add nodes. | |
Properties | |
ApplicationInstance | Application [get, set] |
Gets the application. | |
NodeId | SessionId [get] |
Gets the session id. | |
CacheManager | Cache [get, set] |
Gets the cache manager. | |
ModelManager | Model [get, set] |
Gets the model manager. | |
Object | UserData [get, set] |
Gets or sets the user data. | |
RequestSettings | DefaultRequestSettings [get, set] |
Gets or sets the default request settings. | |
string | SessionName [get, set] |
Gets or sets the name of the session. | |
UserIdentity | UserIdentity [get, set] |
Gets or sets the user identity. | |
IList< string > | PreferredLocales [get, set] |
Gets or sets the preferred locales. | |
int | SecureChannelLifetime [get, set] |
Gets or sets the secure channel lifetime. | |
int | SecureChannelTimeout [get, set] |
Gets or sets the secure channel timeout. | |
int | SessionTimeout [get, set] |
Gets or sets the session timeout. | |
uint | WatchdogCycleTime [get, set] |
Gets or sets the watchdog cycle time. | |
uint | WatchdogTimeout [get, set] |
Gets or sets the watchdog timeout. | |
bool | AutomaticReconnect [get, set] |
Gets or sets a value indicating whether the session should automatically reconnect on error. | |
uint | ReconnectDelay [get, set] |
Gets or sets the delay between reconnect attempts. | |
uint | PublishPipelineDepth [get, set] |
Gets or sets the publish pipeline depth. | |
EndpointDescription | EndpointDescription [get, set] |
Gets or sets the endpoint description. | |
ServerConnectionStatus | ConnectionStatus [get, set] |
Gets the server connection status. | |
IList< string > | AlternativeEndpointUrls [get, set] |
Gets or sets the alternative endpoint urls. | |
TimestampsToReturn | DefaultTimestampToReturn [get, set] |
Gets or sets the default timestamp to return. | |
MessageContext | MessageContext [get] |
Gets the message context. | |
NamespaceTable | NamespaceUris [get] |
Gets the namespace uris. | |
StringTable | ServerUris [get] |
Gets the server uris. | |
EncodeableFactory | Factory [get] |
Gets the dictionary of data types known to the stack. | |
Events | |
ServerConnectionStatusUpdateEventHandler | ConnectionStatusUpdate |
Raised when the connection status has been updated. | |
SessionValidationEventHandler | SessionValidationError |
Raised when a non-fatal error occurs during session establishment. | |
A class that manages a session with an OPC UA server.
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.
List<AddNodesResult> UnifiedAutomation.UaClient.Session.AddNodes | ( | IList< AddNodesItem > | nodesToAdd, |
RequestSettings | settings | ||
) |
Adds the nodes.
nodesToAdd | The nodes to add. |
settings | The settings. |
List<StatusCode> UnifiedAutomation.UaClient.Session.AddReferences | ( | IList< AddReferencesItem > | referencesToAdd, |
RequestSettings | settings | ||
) |
Adds the references.
referencesToAdd | The references to add. |
settings | The settings. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginAddNodes | ( | IList< AddNodesItem > | nodesToAdd, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the add nodes.
nodesToAdd | The nodes to add. |
settings | The settings. |
callback | The callback. |
userData | The user data. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginAddReferences | ( | IList< AddReferencesItem > | referencesToAdd, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the add references operation.
referencesToAdd | The references to add. |
settings | The settings. |
callback | The callback. |
userData | The user data. |
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.
nodeToBrowse | The node to browse. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
This method returns only forward hierarchial references.
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowse | ( | NodeId | nodeToBrowse, |
BrowseContext | browseContext, | ||
AsyncCallback | callback, | ||
Object | userData | ||
) |
This is an overloaded function. See BeginBrowse for more details.
nodeToBrowse | The node to browse. |
browseContext | The browse context. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowse | ( | NodeId | nodeToBrowse, |
BrowseContext | browseContext, | ||
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the browse.
nodeToBrowse | The node to browse. |
browseContext | The browse context. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowseList | ( | List< BrowseDescription > | nodesToBrowse, |
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the browse.
nodesToBrowse | The nodes to browse. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowseList | ( | ViewDescription | view, |
List< BrowseDescription > | nodesToBrowse, | ||
uint | maxReferencesPerBrowse, | ||
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the browse.
view | The view. |
nodesToBrowse | The nodes to browse. |
maxReferencesPerBrowse | The max references per browse. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowseNext | ( | byte[] | continuationPoint, |
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins a browse next operation.
continuationPoint | The continuation point. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginBrowseNext | ( | byte[] | continuationPoint, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins a browse next operation.
continuationPoint | The continuation point. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginCall | ( | NodeId | objectToCall, |
NodeId | methodToCall, | ||
List< Variant > | inputArguments, | ||
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Calls the specified method.
objectToCall | The object to call. |
methodToCall | The method to call. |
inputArguments | The input arguments. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginCallList | ( | IList< CallMethodRequest > | methodsToCall, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the method call.
methodsToCall | The methods to call. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginChangeUser | ( | AsyncCallback | callback, |
Object | userData | ||
) |
Change user for the connection to the OPC UA server asynchronously.
callback | The callback to use when the async call completes. |
userData | The user data. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginChangeUser | ( | UserIdentity | userIdentity, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Change user for the connection to the OPC UA server asynchronously.
userIdentity | The user identity. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
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
endpointUrl | The URL of the server endpoint to connect to. |
UA TCP: opc.tcp://networknode:4840
WebService: https://networknode/ServerName
securitySelection | The requested security level. The option None disables security. The option BestAvailable selects the highest security level suported by the server. |
transportProfileUri | The transport profile URI to use (if null the default for the URL scheme is used). |
retryInitialConnect | The retry initial connect. |
settings | The generel settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
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
endpoint | The full definition of an OPC UA server endpoint. |
retryInitialConnect | The retry initial connect. |
settings | The generel settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginDeleteNodes | ( | IList< DeleteNodesItem > | nodesToDelete, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the delete nodes operation.
nodesToDelete | The nodes to delete. |
settings | The settings. |
callback | The callback. |
userData | The user data. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginDeleteReferences | ( | IList< DeleteReferencesItem > | referencesToDelete, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the delete references operation.
referencesToDelete | The references to delete. |
settings | The settings. |
callback | The callback. |
userData | The user data. |
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.
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
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.
cleanupPolicy | The 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. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
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.
cleanupPolicy | The 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. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadAtTime | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadAtTimeDetails | details, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the history read raw.
nodesToRead | The nodes to read. |
details | The details. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadAtTime | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadAtTimeDetails | details, | ||
TimestampsToReturn | timestampsToReturn, | ||
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the history read raw.
nodesToRead | The nodes to read. |
details | The details. |
timestampsToReturn | The timestamps to return. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadModified | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadRawModifiedDetails | details, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the history read raw.
nodesToRead | The nodes to read. |
details | The details. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadModified | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadRawModifiedDetails | details, | ||
TimestampsToReturn | timestampsToReturn, | ||
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the history read raw.
nodesToRead | The nodes to read. |
details | The details. |
timestampsToReturn | The timestamps to return. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadProcessed | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadProcessedDetails | details, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the history read raw.
nodesToRead | The nodes to read. |
details | The details. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadProcessed | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadProcessedDetails | details, | ||
TimestampsToReturn | timestampsToReturn, | ||
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the history read raw.
nodesToRead | The nodes to read. |
details | The details. |
timestampsToReturn | The timestamps to return. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadRaw | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadRawModifiedDetails | details, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the history read raw.
nodesToRead | The nodes to read. |
details | The details. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginHistoryReadRaw | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadRawModifiedDetails | details, | ||
TimestampsToReturn | timestampsToReturn, | ||
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the history read raw.
nodesToRead | The nodes to read. |
details | The details. |
timestampsToReturn | The timestamps to return. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
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.
nodesToRead | List of nodes and attributes to read. |
maxAge | The maximum age for any value. |
timestampsToReturn | OPC 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
|
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
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.
nodesToRead | The nodes to read. |
maxAge | The max age. |
timestampsToReturn | The timestamps to return. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginRead | ( | IList< ReadValueId > | nodesToRead, |
uint | maxAge, | ||
AsyncCallback | callback, | ||
Object | userData | ||
) |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginRegisterNodes | ( | IList< NodeId > | nodesToRegister, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the add nodes.
nodesToRegister | The nodes to register. |
settings | The settings. |
callback | The callback. |
userData | The user data. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginReleaseBrowseContinuationPoint | ( | byte[] | continuationPoint, |
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins a release browse continuation point operation.
continuationPoint | The continuation point. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginReleaseBrowseContinuationPoint | ( | byte[] | continuationPoint, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins a release browse continuation point operation.
continuationPoint | The continuation point. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginReleaseHistoryContinuationPoints | ( | IList< HistoryReadValueId > | nodesToRead, |
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the history read raw.
nodesToRead | The nodes to read. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginReleaseHistoryContinuationPoints | ( | IList< HistoryReadValueId > | nodesToRead, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the history read raw.
nodesToRead | The nodes to read. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginTranslateBrowsePath | ( | IList< BrowsePath > | pathsToTranslate, |
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the translate browse path.
pathsToTranslate | The paths to translate. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginTranslateBrowsePath | ( | NodeId | startingNodeId, |
IList< string > | browsePaths, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the translate browse path.
startingNodeId | The starting node. |
browsePaths | A list of browse paths to translate. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginTranslateBrowsePath | ( | NodeId | startingNodeId, |
IList< string > | browsePaths, | ||
NamespaceTable | namespaceUris, | ||
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins a translate browse paths operation.
startingNodeId | The starting node. |
browsePaths | A list of browse paths to translate. |
namespaceUris | The table of namespace referenced by the browse paths (if null the session namespace table is assumed). |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginTranslateBrowsePath | ( | IList< BrowsePath > | pathsToTranslate, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the translate browse path.
pathsToTranslate | The paths to translate. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginUnregisterNodes | ( | IList< NodeId > | nodesToUnregister, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Begins the add nodes.
nodesToUnregister | The nodes to unregister. |
settings | The settings. |
callback | The callback. |
userData | The user data. |
IAsyncResult UnifiedAutomation.UaClient.Session.BeginWrite | ( | IList< WriteValue > | nodesToWrite, |
RequestSettings | settings, | ||
AsyncCallback | callback, | ||
object | userData | ||
) |
Writes attributes asynchronously to a OPC UA server.
nodesToWrite | List of nodes and attributes to write. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
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.
nodeToBrowse | NodeId of the starting Node |
browseContext | Filter settings for the browse call. See BrowseContext for more details |
settings | |
continuationPoint | out: 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 |
List<ReferenceDescription> UnifiedAutomation.UaClient.Session.Browse | ( | NodeId | nodeToBrowse, |
BrowseContext | browseContext, | ||
out byte[] | continuationPoint | ||
) |
This is an overloaded function. See Browse for more details.
nodeToBrowse | The node to browse. |
browseContext | The browse context. |
continuationPoint | The continuation point. |
List<ReferenceDescription> UnifiedAutomation.UaClient.Session.Browse | ( | NodeId | nodeToBrowse, |
out byte[] | continuationPoint | ||
) |
This is an overloaded function. See Browse for more details.
nodeToBrowse | The node to browse. |
continuationPoint | The continuation point. |
This method returns only forward hierarchial references.
List<List<ReferenceDescription> > UnifiedAutomation.UaClient.Session.BrowseList | ( | List< BrowseDescription > | nodesToBrowse | ) |
Browses the specified nodes.
nodesToBrowse | The nodes to browse. |
List<List<ReferenceDescription> > UnifiedAutomation.UaClient.Session.BrowseList | ( | ViewDescription | view, |
List< BrowseDescription > | nodesToBrowse, | ||
uint | maxReferencesPerBrowse, | ||
RequestSettings | settings | ||
) |
Browses the specified nodes.
view | The view. |
nodesToBrowse | The nodes to browse. |
maxReferencesPerBrowse | The max references per browse. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
List<ReferenceDescription> UnifiedAutomation.UaClient.Session.BrowseNext | ( | ref byte[] | continuationPoint | ) |
Continues a browse operation.
continuationPoint | The continuation point. |
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.
settings | |
continuationPoint | ref: 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 |
Calls a method of an Object in the OPC server
objectToCall | The object to call. |
methodToCall | The method to call. |
StatusCode UnifiedAutomation.UaClient.Session.Call | ( | NodeId | objectToCall, |
NodeId | methodToCall, | ||
List< Variant > | inputArguments, | ||
out List< StatusCode > | inputArgumentErrors, | ||
out List< Variant > | outputArguments | ||
) |
Calls the specified method.
objectToCall | The object to call. |
methodToCall | The method to call. |
inputArguments | The input arguments. |
inputArgumentErrors | The input argument errors. |
outputArguments | The output arguments. |
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.
objectToCall | The object to call. |
methodToCall | The method to call. |
inputArguments | The input arguments. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
inputArgumentErrors | The input argument errors. |
outputArguments | The output arguments. |
List<CallMethodResult> UnifiedAutomation.UaClient.Session.CallList | ( | IList< CallMethodRequest > | methodsToCall, |
RequestSettings | settings | ||
) |
Calls the specified methods to call.
methodsToCall | The methods to call. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
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.
userIdentity | The 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.
userIdentity | The user identity. |
settings | The 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
endpointUrl | The URL of the server endpoint to connect to. |
UA TCP: opc.tcp://networknode:4840
WebService: https://networknode/ServerName
securitySelection | The 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
endpointUrl | The URL of the server endpoint to connect to. |
UA TCP: opc.tcp://networknode:4840
WebService: https://networknode/ServerName
securitySelection | The requested security level. The option None disables security. The option BestAvailable selects the highest security level suported by the server. |
settings | The 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.
endpointUrl | The endpoint URL. |
securitySelection | The security selection. |
transportProfileUri | The transport profile URI. |
retryInitialConnect | The retry initial connect. |
settings | The 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
endpoint | The full definition of an OPC UA server endpoint. |
settings | The 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.
endpoint | The endpoint. |
retryInitialConnect | The retry initial connect. |
settings | The settings. |
List<StatusCode> UnifiedAutomation.UaClient.Session.DeleteNodes | ( | IList< DeleteNodesItem > | nodesToDelete, |
RequestSettings | settings | ||
) |
Deletes the nodes.
nodesToDelete | The nodes to delete. |
settings | The settings. |
List<StatusCode> UnifiedAutomation.UaClient.Session.DeleteReferences | ( | IList< DeleteReferencesItem > | referencesToDelete, |
RequestSettings | settings | ||
) |
Deletes the references.
referencesToDelete | The references to delete. |
settings | The settings. |
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.
cleanupPolicy | The 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.
cleanupPolicy | The 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. |
settings | The 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.
result | The result. |
List<StatusCode> UnifiedAutomation.UaClient.Session.EndAddReferences | ( | IAsyncResult | result | ) |
Ends the add nodes.
result | The result. |
List<ReferenceDescription> UnifiedAutomation.UaClient.Session.EndBrowse | ( | IAsyncResult | result, |
out byte[] | continuationPoint | ||
) |
Ends a browse.
result | The result. |
continuationPoint | The continuation point. |
List<List<ReferenceDescription> > UnifiedAutomation.UaClient.Session.EndBrowseList | ( | IAsyncResult | result | ) |
Ends a browse.
result | The result. |
List<Variant> UnifiedAutomation.UaClient.Session.EndCall | ( | IAsyncResult | result | ) |
Calls the specified method.
result | The result. |
StatusCode UnifiedAutomation.UaClient.Session.EndCall | ( | IAsyncResult | result, |
out List< StatusCode > | inputArgumentErrors, | ||
out List< Variant > | outputArguments | ||
) |
Calls the specified method.
result | The result. |
inputArgumentErrors | The input argument errors. |
outputArguments | The output arguments. |
List<CallMethodResult> UnifiedAutomation.UaClient.Session.EndCallList | ( | IAsyncResult | result | ) |
Ends a call method request.
result | The result. |
void UnifiedAutomation.UaClient.Session.EndChangeUser | ( | IAsyncResult | result | ) |
Completes a change user request.
result | The result returned from BeginChangeUser method |
void UnifiedAutomation.UaClient.Session.EndConnect | ( | IAsyncResult | result | ) |
Completes an asynchronous connect operation.
result | The object returned from the BeginConnect method. |
List<StatusCode> UnifiedAutomation.UaClient.Session.EndDeleteNodes | ( | IAsyncResult | result | ) |
Ends the add nodes.
result | The result. |
List<StatusCode> UnifiedAutomation.UaClient.Session.EndDeleteReferences | ( | IAsyncResult | result | ) |
Ends the add nodes.
result | The result. |
void UnifiedAutomation.UaClient.Session.EndDisconnect | ( | IAsyncResult | result | ) |
Completes an asynchronous disconnect operation.
result | The object returned from the BeginDisconnect method. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.EndHistoryReadAtTime | ( | IAsyncResult | result | ) |
Ends the history read raw.
result | The result. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.EndHistoryReadModified | ( | IAsyncResult | result | ) |
Ends the history read raw.
result | The result. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.EndHistoryReadProcessed | ( | IAsyncResult | result | ) |
Ends the history read raw.
result | The result. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.EndHistoryReadRaw | ( | IAsyncResult | result | ) |
Ends the history read raw.
result | The result. |
List<DataValue> UnifiedAutomation.UaClient.Session.EndRead | ( | IAsyncResult | result | ) |
Completes an asynchronous read operation.
result | The object returned from the BeginRead method. |
List<NodeId> UnifiedAutomation.UaClient.Session.EndRegisterNodes | ( | IAsyncResult | result | ) |
Ends the add nodes.
result | The result. |
void UnifiedAutomation.UaClient.Session.EndReleaseBrowseContinuationPoint | ( | IAsyncResult | result | ) |
Ends the release browse continuation point operation.
result | The result. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.EndReleaseHistoryContinuationPoints | ( | IAsyncResult | result | ) |
Ends the history read raw.
result | The result. |
List<BrowsePathResult> UnifiedAutomation.UaClient.Session.EndTranslateBrowsePath | ( | IAsyncResult | result | ) |
Ends the translate browse path.
result | The result. |
void UnifiedAutomation.UaClient.Session.EndUnregisterNodes | ( | IAsyncResult | result | ) |
Ends the add nodes.
result | The result. |
List<StatusCode> UnifiedAutomation.UaClient.Session.EndWrite | ( | IAsyncResult | result | ) |
Ends the write.
result | The result returned from BeginWrite method. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadAtTime | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadAtTimeDetails | details | ||
) |
Histories the read raw.
nodesToRead | The nodes to read. |
details | The details. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadAtTime | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadAtTimeDetails | details, | ||
TimestampsToReturn | timestampsToReturn, | ||
RequestSettings | settings | ||
) |
Histories the read raw.
nodesToRead | The nodes to read. |
details | The details. |
timestampsToReturn | The timestamps to return. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadModified | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadRawModifiedDetails | details | ||
) |
Histories the read raw.
nodesToRead | The nodes to read. |
details | The details. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadModified | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadRawModifiedDetails | details, | ||
TimestampsToReturn | timestampsToReturn, | ||
RequestSettings | settings | ||
) |
Histories the read raw.
nodesToRead | The nodes to read. |
details | The details. |
timestampsToReturn | The timestamps to return. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadProcessed | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadProcessedDetails | details | ||
) |
Histories the read raw.
nodesToRead | The nodes to read. |
details | The details. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadProcessed | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadProcessedDetails | details, | ||
TimestampsToReturn | timestampsToReturn, | ||
RequestSettings | settings | ||
) |
Histories the read raw.
nodesToRead | The nodes to read. |
details | The details. |
timestampsToReturn | The timestamps to return. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadRaw | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadRawModifiedDetails | details | ||
) |
Histories the read raw.
nodesToRead | The nodes to read. |
details | The details. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.HistoryReadRaw | ( | IList< HistoryReadValueId > | nodesToRead, |
ReadRawModifiedDetails | details, | ||
TimestampsToReturn | timestampsToReturn, | ||
RequestSettings | settings | ||
) |
Histories the read raw.
nodesToRead | The nodes to read. |
details | The details. |
timestampsToReturn | The timestamps to return. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
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.
nodesToRead | List of nodes and attributes to read. |
maxAge | The 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. |
timestampsToReturn | OPC 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
|
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
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.
nodesToRead | List of nodes and attributes to read. |
List<NodeId> UnifiedAutomation.UaClient.Session.RegisterNodes | ( | IList< NodeId > | nodesToRegister, |
RequestSettings | settings | ||
) |
Registers the nodes.
nodesToRegister | The nodes to register. |
settings | The settings. |
void UnifiedAutomation.UaClient.Session.ReleaseBrowseContinuationPoint | ( | byte[] | continuationPoint | ) |
Releases the browse continuation point.
continuationPoint | The continuation point. |
void UnifiedAutomation.UaClient.Session.ReleaseBrowseContinuationPoint | ( | byte[] | continuationPoint, |
RequestSettings | settings | ||
) |
Releases the browse continuation point.
continuationPoint | The continuation point. |
settings | The 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.
nodesToRead | The nodes to read. |
List<HistoryDataReadResult> UnifiedAutomation.UaClient.Session.ReleaseHistoryContinuationPoints | ( | IList< HistoryReadValueId > | nodesToRead, |
RequestSettings | settings | ||
) |
Histories the read raw.
nodesToRead | The nodes to read. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
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.
pathsToTranslate | The list of browse paths for which NodeIds are requested |
List<BrowsePathResult> UnifiedAutomation.UaClient.Session.TranslateBrowsePath | ( | IList< BrowsePath > | pathsToTranslate, |
RequestSettings | settings | ||
) |
Translates the browse path.
pathsToTranslate | The paths to translate. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
List<BrowsePathResult> UnifiedAutomation.UaClient.Session.TranslateBrowsePath | ( | NodeId | startingNodeId, |
IList< string > | browsePaths | ||
) |
Translates the browse paths.
startingNodeId | The starting node. |
browsePaths | A list of browse paths to translate. |
List<BrowsePathResult> UnifiedAutomation.UaClient.Session.TranslateBrowsePath | ( | NodeId | startingNodeId, |
IList< string > | browsePaths, | ||
NamespaceTable | namespaceUris, | ||
RequestSettings | settings | ||
) |
Translates the browse paths.
startingNodeId | The starting node. |
browsePaths | A list of browse paths to translate. |
namespaceUris | The table of namespace referenced by the browse paths (if null the session namespace table is assumed). |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
void UnifiedAutomation.UaClient.Session.UnregisterNodes | ( | IList< NodeId > | nodesToUnregister, |
RequestSettings | settings | ||
) |
Registers the nodes.
nodesToUnregister | The nodes to unregister. |
settings | The 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.
nodesToWrite | List of nodes and attributes to write. |
settings | The general settings for the request. If null the default settings from poperty DefaultRequestSettings are used. |
List<StatusCode> UnifiedAutomation.UaClient.Session.Write | ( | IList< WriteValue > | nodesToWrite | ) |
This is an overloaded function. See Write for more details.
nodesToWrite | The nodes to write. |
|
getset |
Gets or sets the alternative endpoint urls.
The alternative endpoint urls.
|
getset |
Gets the application.
|
getset |
Gets or sets a value indicating whether the session should automatically reconnect on error.
true
if the session should automatically reconnect; otherwise, false
.
|
getset |
Gets the cache manager.
|
getset |
Gets the server connection status.
The server connection status.
|
getset |
Gets or sets the default request settings.
The default request settings.
|
getset |
Gets or sets the default timestamp to return.
The default timestamp to return.
|
getset |
Gets or sets the endpoint description.
The endpoint description.
|
get |
Gets the dictionary of data types known to the stack.
|
get |
Gets the message context.
|
getset |
Gets the model manager.
|
get |
Gets the namespace uris.
|
getset |
Gets or sets the preferred locales.
The preferred locales.
|
getset |
Gets or sets the publish pipeline depth.
The publish pipeline depth.
|
getset |
Gets or sets the delay between reconnect attempts.
The delay between reconnect attempts.
|
getset |
Gets or sets the secure channel lifetime.
The secure channel lifetime.
|
getset |
Gets or sets the secure channel timeout.
The secure channel timeout.
|
get |
Gets the server uris.
|
get |
Gets the session id.
|
getset |
Gets or sets the name of the session.
The name of the session.
|
getset |
Gets or sets the session timeout.
The session timeout.
|
getset |
Gets or sets the user data.
The user data.
|
getset |
Gets or sets the user identity.
The user identity.
|
getset |
Gets or sets the watchdog cycle time.
The watchdog cycle time.
|
getset |
Gets or sets the watchdog timeout.
The watchdog timeout.
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.