UA Bundle SDK .NET
2.2.2.260
|
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) |
Establish a connection to the OPC UA server. More... | |
void | Connect (string endpointUrl, SecuritySelection securitySelection, RequestSettings settings) |
Establish a connection to the OPC UA server. More... | |
void | Connect (string endpointUrl, SecuritySelection securitySelection, string transportProfileUri, RetryInitialConnect retryInitialConnect, RequestSettings settings) |
Establish a connection to the OPC UA server. More... | |
IAsyncResult | BeginConnect (string endpointUrl, SecuritySelection securitySelection, string transportProfileUri, RetryInitialConnect retryInitialConnect, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously establish a connection to the OPC UA server. More... | |
void | Connect (EndpointDescription endpoint, RequestSettings settings) |
Establish a connection to the OPC UA server. More... | |
void | Connect (EndpointDescription endpoint, RetryInitialConnect retryInitialConnect, RequestSettings settings) |
Establish a connection to the OPC UA server. More... | |
IAsyncResult | BeginConnect (EndpointDescription endpoint, RetryInitialConnect retryInitialConnect, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously establish a connection to the OPC UA server. More... | |
void | EndConnect (IAsyncResult result) |
Completes an asynchronous connect operation. More... | |
void | Disconnect () |
Disconnect client application from OPC UA server. More... | |
void | Disconnect (SubscriptionCleanupPolicy cleanupPolicy) |
Disconnect client application from OPC UA server. More... | |
void | Disconnect (SubscriptionCleanupPolicy cleanupPolicy, RequestSettings settings) |
Disconnect client application from OPC UA server. More... | |
IAsyncResult | BeginDisconnect (AsyncCallback callback, object userData) |
Asynchronously disconnect client application from OPC UA server. More... | |
IAsyncResult | BeginDisconnect (SubscriptionCleanupPolicy cleanupPolicy, AsyncCallback callback, object userData) |
Asynchronously disconnect client application from OPC UA server. More... | |
IAsyncResult | BeginDisconnect (SubscriptionCleanupPolicy cleanupPolicy, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously disconnect client application from OPC UA server. More... | |
void | EndDisconnect (IAsyncResult result) |
Completes an asynchronous disconnect operation. More... | |
uint | Cancel (uint requestHandle, RequestSettings settings) |
Cancels all requests with the specified handle. More... | |
IAsyncResult | BeginCancel (uint requestHandle, RequestSettings settings, AsyncCallback callback, object userData) |
Begins an operation to cancel a request. More... | |
uint | EndCancel (IAsyncResult result) |
Completes a cancel operation. More... | |
List< DataValue > | Read (IList< ReadValueId > nodesToRead, uint maxAge, TimestampsToReturn timestampsToReturn, RequestSettings settings) |
Reads attribute values synchronous from OPC server. More... | |
List< DataValue > | Read (IList< ReadValueId > nodesToRead) |
Reads attribute values synchronous from OPC server. More... | |
IAsyncResult | BeginRead (IList< ReadValueId > nodesToRead, uint maxAge, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData) |
Reads values and attributes asynchronously from OPC server. 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< DataValue > | EndRead (IAsyncResult result) |
Completes an asynchronous read operation. More... | |
List< StatusCode > | Write (IList< WriteValue > nodesToWrite, RequestSettings settings) |
Writes attributes synchronously to OPC server. More... | |
List< StatusCode > | Write (IList< WriteValue > nodesToWrite) |
Writes attributes synchronously to OPC server. 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 BeginWrite for more details. More... | |
List< StatusCode > | EndWrite (IAsyncResult result) |
Ends an asynchronous write operation. More... | |
void | ChangeUser () |
Change user for the connection to the OPC UA server. More... | |
void | ChangeUser (UserIdentity userIdentity) |
Change user for the connection to the OPC UA server. More... | |
void | ChangeUser (UserIdentity userIdentity, RequestSettings settings) |
Change user for the connection to the OPC UA server. 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 an asynchronous change user request. More... | |
List< ReferenceDescription > | Browse (NodeId nodeToBrowse, BrowseContext browseContext, RequestSettings settings, out byte[] continuationPoint) |
Browse OPC server address space with one starting node. More... | |
List< ReferenceDescription > | Browse (NodeId nodeToBrowse, BrowseContext browseContext, out byte[] continuationPoint) |
This is an overloaded function. See Browse for more details. More... | |
List< ReferenceDescription > | Browse (NodeId nodeToBrowse, out byte[] continuationPoint) |
This is an overloaded function. See Browse for more details. More... | |
IAsyncResult | BeginBrowse (NodeId nodeToBrowse, AsyncCallback callback, Object userData) |
Browse OPC server address space with one starting node asnchonously. 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) |
This is an overloaded function. See BeginBrowse for more details. More... | |
List< ReferenceDescription > | EndBrowse (IAsyncResult result, out byte[] continuationPoint) |
Completes an ansynchronous browse operation. More... | |
List< ReferenceDescription > | BrowseNext (ref byte[] continuationPoint) |
Continues a previous Browse request. More... | |
List< ReferenceDescription > | BrowseNext (RequestSettings settings, ref byte[] continuationPoint) |
Continues a previous Browse request. More... | |
IAsyncResult | BeginBrowseNext (byte[] continuationPoint, AsyncCallback callback, object userData) |
Continues a previous Browse request asynchronously. More... | |
IAsyncResult | BeginBrowseNext (byte[] continuationPoint, RequestSettings settings, AsyncCallback callback, object userData) |
Continues a previous Browse request asynchronously. More... | |
List< List < ReferenceDescription > > | BrowseList (List< BrowseDescription > nodesToBrowse) |
Browse OPC server address space with a list of starting nodes. More... | |
List< List < ReferenceDescription > > | BrowseList (ViewDescription view, List< BrowseDescription > nodesToBrowse, uint maxReferencesPerBrowse, RequestSettings settings) |
Browse OPC server address space with a list of starting nodes. More... | |
IAsyncResult | BeginBrowseList (List< BrowseDescription > nodesToBrowse, AsyncCallback callback, object userData) |
Browse OPC server address space with a list of starting nodes asnchonously. More... | |
IAsyncResult | BeginBrowseList (ViewDescription view, List< BrowseDescription > nodesToBrowse, uint maxReferencesPerBrowse, RequestSettings settings, AsyncCallback callback, object userData) |
Browse OPC server address space with a list of starting nodes asnchonously. More... | |
List< List < ReferenceDescription > > | EndBrowseList (IAsyncResult result) |
Completes an ansynchronous browse list operation. 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 an asynchronous release browse continuation point operation. More... | |
List< BrowsePathResult > | TranslateBrowsePath (IList< BrowsePath > pathsToTranslate) |
Translate a browse path to a NodeId. More... | |
List< BrowsePathResult > | TranslateBrowsePath (IList< BrowsePath > pathsToTranslate, RequestSettings settings) |
Translate a browse path to a NodeId. More... | |
List< BrowsePathResult > | TranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths) |
Translates the browse paths. More... | |
List< BrowsePathResult > | TranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths, NamespaceTable namespaceUris, RequestSettings settings) |
Translates the browse paths. More... | |
IAsyncResult | BeginTranslateBrowsePath (IList< BrowsePath > pathsToTranslate, AsyncCallback callback, object userData) |
Begins a translate browse paths operation. More... | |
IAsyncResult | BeginTranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths, AsyncCallback callback, object userData) |
Begins a translate browse paths operation. 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 a translate browse paths operation. More... | |
List< BrowsePathResult > | EndTranslateBrowsePath (IAsyncResult result) |
Ends an asynchronous translate browse path operation. More... | |
List< Variant > | Call (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) |
Asynchronously calls the specified method. More... | |
List< Variant > | EndCall (IAsyncResult result) |
Completes an asynchronous Call operation. More... | |
StatusCode | EndCall (IAsyncResult result, out List< StatusCode > inputArgumentErrors, out List< Variant > outputArguments) |
Completes an asynchronous Call operation. More... | |
List< CallMethodResult > | CallList (IList< CallMethodRequest > methodsToCall, RequestSettings settings) |
Calls the specified methods to call. More... | |
IAsyncResult | BeginCallList (IList< CallMethodRequest > methodsToCall, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously calls the specified methods. More... | |
List< CallMethodResult > | EndCallList (IAsyncResult result) |
Completes an asynchronous request to call a list of methods. More... | |
List< HistoryDataReadResult > | HistoryReadRaw (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details) |
Reads the history of variable values synchronously from OPC server. More... | |
List< HistoryDataReadResult > | HistoryReadRaw (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings) |
Reads the history of variable values synchronously from OPC server. More... | |
IAsyncResult | BeginHistoryReadRaw (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, AsyncCallback callback, object userData) |
Reads the history of variable values asynchronously from OPC server. More... | |
IAsyncResult | BeginHistoryReadRaw (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData) |
Reads the history of variable values asynchronously from OPC server. More... | |
List< HistoryDataReadResult > | EndHistoryReadRaw (IAsyncResult result) |
Completes an asynchronous HistoryReadRaw operation. More... | |
List< HistoryDataReadResult > | HistoryReadModified (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details) |
Reads the history of modified variable values synchronously from the OPC server. More... | |
List< HistoryDataReadResult > | HistoryReadModified (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings) |
Reads the history of modified variable values synchronously from the OPC server. More... | |
IAsyncResult | BeginHistoryReadModified (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, AsyncCallback callback, object userData) |
Reads the history of modified variable values asynchronously from the OPC server. More... | |
IAsyncResult | BeginHistoryReadModified (IList< HistoryReadValueId > nodesToRead, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData) |
Reads the history of modified variable values asynchronously from the OPC server. More... | |
List< HistoryDataReadResult > | EndHistoryReadModified (IAsyncResult result) |
Completes an asynchronous HistoryReadModified operation. More... | |
List< HistoryDataReadResult > | HistoryReadProcessed (IList< HistoryReadValueId > nodesToRead, ReadProcessedDetails details) |
Reads the processed history of variable values synchronously from the OPC server based on a passed aggregate. More... | |
List< HistoryDataReadResult > | HistoryReadProcessed (IList< HistoryReadValueId > nodesToRead, ReadProcessedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings) |
Reads the processed history of variable values synchronously from the OPC server based on a passed aggregate. More... | |
IAsyncResult | BeginHistoryReadProcessed (IList< HistoryReadValueId > nodesToRead, ReadProcessedDetails details, AsyncCallback callback, object userData) |
Reads the processed history of variable values asynchronously from the OPC server based on a passed aggregate. More... | |
IAsyncResult | BeginHistoryReadProcessed (IList< HistoryReadValueId > nodesToRead, ReadProcessedDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData) |
Reads the processed history of variable values asynchronously from the OPC server based on a passed aggregate. More... | |
List< HistoryDataReadResult > | EndHistoryReadProcessed (IAsyncResult result) |
Completes an asynchronous HistoryReadProcessed operation. More... | |
List< HistoryDataReadResult > | HistoryReadAtTime (IList< HistoryReadValueId > nodesToRead, ReadAtTimeDetails details) |
Reads the history of item values synchronously from the OPC server for the given timestamps. More... | |
List< HistoryDataReadResult > | HistoryReadAtTime (IList< HistoryReadValueId > nodesToRead, ReadAtTimeDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings) |
Reads the history of item values synchronously from the OPC server for the given timestamps. More... | |
IAsyncResult | BeginHistoryReadAtTime (IList< HistoryReadValueId > nodesToRead, ReadAtTimeDetails details, AsyncCallback callback, object userData) |
Reads the history of item values asynchronously from the OPC server for the given timestamps. More... | |
IAsyncResult | BeginHistoryReadAtTime (IList< HistoryReadValueId > nodesToRead, ReadAtTimeDetails details, TimestampsToReturn timestampsToReturn, RequestSettings settings, AsyncCallback callback, object userData) |
Reads the history of item values asynchronously from the OPC server for the given timestamps. More... | |
List< HistoryDataReadResult > | EndHistoryReadAtTime (IAsyncResult result) |
Completes an asynchronous HistoryReadAtTime operation. More... | |
List< HistoryDataReadResult > | ReleaseHistoryContinuationPoints (IList< HistoryReadValueId > nodesToRead) |
Releases the history continuation points. More... | |
List< HistoryDataReadResult > | ReleaseHistoryContinuationPoints (IList< HistoryReadValueId > nodesToRead, RequestSettings settings) |
Releases the history continuation points. More... | |
IAsyncResult | BeginReleaseHistoryContinuationPoints (IList< HistoryReadValueId > nodesToRead, AsyncCallback callback, object userData) |
Begins a release history continuation point operation. More... | |
IAsyncResult | BeginReleaseHistoryContinuationPoints (IList< HistoryReadValueId > nodesToRead, RequestSettings settings, AsyncCallback callback, object userData) |
Begins a release history continuation point operation. More... | |
List< HistoryDataReadResult > | EndReleaseHistoryContinuationPoints (IAsyncResult result) |
Ends an asynchronous release history continuation point operation. More... | |
List< HistoryDataUpdateResult > | HistoryUpdateData (IList< UpdateDataDetails > nodesToUpdate) |
Updates the history for a list of variables. More... | |
List< HistoryDataUpdateResult > | HistoryUpdateData (IList< UpdateDataDetails > nodesToUpdate, RequestSettings settings) |
Updates the history for a list of variables. More... | |
IAsyncResult | BeginHistoryUpdateData (IList< UpdateDataDetails > nodesToUpdate, RequestSettings settings, AsyncCallback callback, object userData) |
Begins an operation to update the history for a list of variables. More... | |
List< HistoryDataUpdateResult > | EndHistoryUpdateData (IAsyncResult result) |
Ends an operation to update the history for a list of variables. More... | |
List< HistoryDataUpdateResult > | HistoryUpdateStructureData (IList< UpdateStructureDataDetails > nodesToUpdate) |
Updates the history for a list of for structured metadata variables. More... | |
List< HistoryDataUpdateResult > | HistoryUpdateStructureData (IList< UpdateStructureDataDetails > nodesToUpdate, RequestSettings settings) |
Updates the history for a list of structured metadata variables. More... | |
IAsyncResult | BeginHistoryUpdateStructureData (IList< UpdateStructureDataDetails > nodesToUpdate, RequestSettings settings, AsyncCallback callback, object userData) |
Begins an operation to update the history for a list of structured metadata variables. More... | |
List< HistoryDataUpdateResult > | EndHistoryUpdateStructureData (IAsyncResult result) |
Ends an operation to update the history for a list of structured metadata variables. More... | |
List< HistoryDataUpdateResult > | HistoryDeleteRaw (IList< DeleteRawModifiedDetails > nodesToDelete) |
Deletes the history for a list of variables in the passed time domain. More... | |
List< HistoryDataUpdateResult > | HistoryDeleteRaw (IList< DeleteRawModifiedDetails > nodesToDelete, RequestSettings settings) |
Deletes the history for a list of variables in the passed time domain. More... | |
IAsyncResult | BeginHistoryDeleteRaw (IList< DeleteRawModifiedDetails > nodesToDelete, RequestSettings settings, AsyncCallback callback, object userData) |
Begins an operation to delete the history for a list of variables in the passed time domain. More... | |
List< HistoryDataUpdateResult > | EndHistoryDeleteRaw (IAsyncResult result) |
Ends an operation to delete the history for a list of variables. More... | |
List< HistoryDataUpdateResult > | HistoryDeleteAtTime (IList< DeleteAtTimeDetails > nodesToDelete) |
Deletes the history for a list of variables for the passed timestamps. More... | |
List< HistoryDataUpdateResult > | HistoryDeleteAtTime (IList< DeleteAtTimeDetails > nodesToDelete, RequestSettings settings) |
Deletes the history for a list of variables for the passed timestamps. More... | |
IAsyncResult | BeginHistoryDeleteAtTime (IList< DeleteAtTimeDetails > nodesToDelete, RequestSettings settings, AsyncCallback callback, object userData) |
Begins an operation to delete the history for a list of variables for the passed timestamps. More... | |
List< HistoryDataUpdateResult > | EndHistoryDeleteAtTime (IAsyncResult result) |
Ends an operation to delete the history for a list of variables. More... | |
List< HistoryEventReadResult > | HistoryReadEvent (IList< HistoryReadValueId > nodesToRead, ReadEventDetails details) |
Reads the event history for a list of event notifier objects synchronously from an OPC server. More... | |
List< HistoryEventReadResult > | HistoryReadEvent (IList< HistoryReadValueId > nodesToRead, ReadEventDetails details, RequestSettings settings) |
Reads the event history for a list of event notifier objects synchronously from an OPC server. More... | |
IAsyncResult | BeginHistoryReadEvent (IList< HistoryReadValueId > nodesToRead, ReadEventDetails details, AsyncCallback callback, object userData) |
Begins an operation to read the event history for a list of notifiers. More... | |
IAsyncResult | BeginHistoryReadEvent (IList< HistoryReadValueId > nodesToRead, ReadEventDetails details, RequestSettings settings, AsyncCallback callback, object userData) |
Begins an operation to read the event history for a list of notifiers. More... | |
List< HistoryEventReadResult > | EndHistoryReadEvent (IAsyncResult result) |
Ends an operation to read the event history for a list of notifiers. More... | |
List< HistoryEventUpdateResult > | HistoryUpdateEvent (IList< UpdateEventDetails > nodesToUpdate) |
Updates the event history for a list of event notifier objects. More... | |
List< HistoryEventUpdateResult > | HistoryUpdateEvent (IList< UpdateEventDetails > nodesToUpdate, RequestSettings settings) |
Updates the event history for a list of event notifier objects. More... | |
IAsyncResult | BeginHistoryUpdateEvent (IList< UpdateEventDetails > nodesToUpdate, RequestSettings settings, AsyncCallback callback, object userData) |
Begins an operation to update the history for a list of event notifier objects. More... | |
List< HistoryEventUpdateResult > | EndHistoryUpdateEvent (IAsyncResult result) |
Ends an operation to update the history for a list of event notifier objects. More... | |
List< HistoryEventUpdateResult > | HistoryDeleteEvent (IList< DeleteEventDetails > nodesToUpdate) |
Deletes the event history for a list of event notifier objects. More... | |
List< HistoryEventUpdateResult > | HistoryDeleteEvent (IList< DeleteEventDetails > nodesToUpdate, RequestSettings settings) |
Deletes the event history for a list of event notifier objects. More... | |
IAsyncResult | BeginHistoryDeleteEvent (IList< DeleteEventDetails > nodesToUpdate, RequestSettings settings, AsyncCallback callback, object userData) |
Begins an operation to delete the event history for a list of event notifier objects. More... | |
List< HistoryEventUpdateResult > | EndHistoryDeleteEvent (IAsyncResult result) |
Ends an operation to delete the history for a list of variables. More... | |
List< AddNodesResult > | AddNodes (IList< AddNodesItem > nodesToAdd, RequestSettings settings) |
Adds the nodes. More... | |
IAsyncResult | BeginAddNodes (IList< AddNodesItem > nodesToAdd, RequestSettings settings, AsyncCallback callback, object userData) |
Begins an add nodes operation. More... | |
List< AddNodesResult > | EndAddNodes (IAsyncResult result) |
Completes an asynchronous add nodes operation. More... | |
List< StatusCode > | AddReferences (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< StatusCode > | EndAddReferences (IAsyncResult result) |
Ends and asynchronous add references operation. More... | |
List< StatusCode > | DeleteNodes (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< StatusCode > | EndDeleteNodes (IAsyncResult result) |
Ends the delete nodes operation. More... | |
List< StatusCode > | DeleteReferences (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< StatusCode > | EndDeleteReferences (IAsyncResult result) |
Ends the delete references operation. More... | |
List< NodeId > | RegisterNodes (IList< NodeId > nodesToRegister, RequestSettings settings) |
Registers the nodes. More... | |
IAsyncResult | BeginRegisterNodes (IList< NodeId > nodesToRegister, RequestSettings settings, AsyncCallback callback, object userData) |
Begins a register nodes operation. More... | |
List< NodeId > | EndRegisterNodes (IAsyncResult result) |
Ends an asynchronous register nodes operation. More... | |
void | UnregisterNodes (IList< NodeId > nodesToUnregister, RequestSettings settings) |
Unregisters the nodes. More... | |
IAsyncResult | BeginUnregisterNodes (IList< NodeId > nodesToUnregister, RequestSettings settings, AsyncCallback callback, object userData) |
Begins an unregister nodes operation. More... | |
void | EndUnregisterNodes (IAsyncResult result) |
Ends an asynchronous unregister nodes operation. 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 settings used as fallback for OPC UA service calls. 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... | |
bool | UseDnsNameAndPortFromDiscoveryUrl [get, set] |
Gets or sets a value indicating whether to use DNS name and port from discovery URL when connecting to a server. 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... | |
UpdateEndpointEventHandler | UpdateEndpoint |
Raised before connecting to the server and it allows the application to modify the endpoint used to connect. More... | |
A class that manages a session with an OPC UA server.
|
inline |
Create a session for the default client application.
|
inline |
Create a session for the specified client application.
|
inline |
Adds the nodes.
nodesToAdd | The nodes to add. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Adds the references.
referencesToAdd | The references to add. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Begins an add nodes operation.
nodesToAdd | The nodes to add. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins the add references operation.
referencesToAdd | The references to add. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
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.
|
inline |
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. |
|
inline |
This is an overloaded function. See BeginBrowse for more details.
nodeToBrowse | The node to browse. |
browseContext | The browse context. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Browse OPC server address space with a list of starting nodes 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 browse method is used for a list of starting nodes.
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. |
|
inline |
Browse OPC server address space with a list of starting nodes 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 browse method is used for a list of starting nodes.
view | The view. |
nodesToBrowse | The nodes to browse. |
maxReferencesPerBrowse | The maximum number of references per browse. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Continues a previous Browse request asynchronously.
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.
continuationPoint | 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 processing the Browse Service call. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Continues a previous Browse request asynchronously.
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.
continuationPoint | 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 processing the Browse Service call. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Asynchronously 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 the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Asynchronously calls the specified methods.
methodsToCall | The methods to call. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins an operation to cancel a request.
requestHandle | The handle of the request to cancel. |
settings | The settings. |
callback | The callback. |
userData | The user data. |
|
inline |
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 that is passed to the callback. |
|
inline |
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 the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Asynchronously 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 | Whether to retry a failed connect in the background. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Asynchronously 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 | Whether to retry a failed connect in the background. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins the delete nodes operation.
nodesToDelete | The nodes to delete. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins the delete references operation.
referencesToDelete | The references to delete. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Asynchronously 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.
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Asynchronously 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 subscriptions 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. |
|
inline |
Asynchronously 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 subscriptions are not deleted when option Keep is used. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins an operation to delete the history for a list of variables for the passed timestamps.
nodesToDelete | The variables with history to delete, including the timestamps for the data to be deleted. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins an operation to delete the event history for a list of event notifier objects.
nodesToUpdate | List of event notifier objects and Ids of events to delete. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins an operation to delete the history for a list of variables in the passed time domain.
nodesToDelete | The variables with history to delete, including the time domain for the data to be deleted. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Reads the history of item values asynchronously from the OPC server for the given timestamps.
nodesToRead | List of variable nodes to read data values at specified timestamps from. |
details | Configuration parameters for the history read of data at specified timestamps. Configuration parameters include
|
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Reads the history of item values asynchronously from the OPC server for the given timestamps.
nodesToRead | List of variable nodes to read data values at specified timestamps from. |
details | Configuration parameters for the history read of data at specified timestamps. Configuration parameters include
|
timestampsToReturn | Enumeration for the timestamps to return with the values. Possible values are source , server or both . The option neither is invalid for history read. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins an operation to read the event history for a list of notifiers.
nodesToRead | List of event notifier object nodes to read event history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of events. Configuration parameters include
|
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins an operation to read the event history for a list of notifiers.
nodesToRead | List of event notifier object nodes to read event history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of events. Configuration parameters include
|
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Reads the history of modified variable values asynchronously from the OPC server.
This method is used to read modified historical values of one or more nodes in an ordered sequence for the defined time domain. Continuation points are used to continue the read of the ordered sequence if not all data can be returned in one read. The returned number can be limited by the client or the server. See ReleaseHistoryContinuationPoints for cleaning up resources in the server if read should not be continued with the returned continuation point.
nodesToRead | List of variable nodes to read modified data history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of modified data. Configuration parameters include
|
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Reads the history of modified variable values asynchronously from the OPC server.
This method is used to read modified historical values of one or more nodes in an ordered sequence for the defined time domain. Continuation points are used to continue the read of the ordered sequence if not all data can be returned in one read. The returned number can be limited by the client or the server. See ReleaseHistoryContinuationPoints for cleaning up resources in the server if read should not be continued with the returned continuation point.
nodesToRead | List of variable nodes to read modified data history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of modified data. Configuration parameters include
|
timestampsToReturn | Enumeration for the timestamps to return with the values. Possible values are source, server or both. The option neither is invalid for history read. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Reads the processed history of variable values asynchronously from the OPC server based on a passed aggregate.
This method is used to read processed historical values of one or more nodes in an ordered sequence for the defined time domain. Continuation points are used to continue the read of the ordered sequence if not all data can be returned in one read or if the server was not able to finish the processing before the timeout expired. The returned number can be limited by the server and may be 0 if the server was not able to finish one calculation before the service timeout expired. See ReleaseHistoryContinuationPoints for cleaning up resources in the server if read should not be continued with the returned continuation point.
The processed values are calculated with the specified aggregate based on the raw data in the history database. The server must use start time, end time, and the resample interval to generate a sequence of time intervals and then calculate an aggregate for each interval.
nodesToRead | List of variable nodes to read processed data history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of processed data. Configuration parameters include
|
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Reads the processed history of variable values asynchronously from the OPC server based on a passed aggregate.
This method is used to read processed historical values of one or more nodes in an ordered sequence for the defined time domain. Continuation points are used to continue the read of the ordered sequence if not all data can be returned in one read or if the server was not able to finish the processing before the timeout expired. The returned number can be limited by the server and may be 0 if the server was not able to finish one calculation before the service timeout expired. See ReleaseHistoryContinuationPoints for cleaning up resources in the server if read should not be continued with the returned continuation point.
The processed values are calculated with the specified aggregate based on the raw data in the history database. The server must use start time, end time, and the resample interval to generate a sequence of time intervals and then calculate an aggregate for each interval.
nodesToRead | List of variable nodes to read processed data history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of processed data. Configuration parameters include
|
timestampsToReturn | The timestamps to return. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Reads the history of variable values asynchronously from OPC server.
This method is used to read raw historical values of one or more nodes in an ordered sequence for the defined time domain. Continuation points are used to continue the read of the ordered sequence if not all data can be returned in one read. The returned number can be limited by the client or the server. See ReleaseHistoryContinuationPoints for cleaning up resources in the server if read should not be continued with the returned continuation point.
nodesToRead | List of variable nodes to read data history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of raw data. Configuration parameters include
|
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Reads the history of variable values asynchronously from OPC server.
This method is used to read raw historical values of one or more nodes in an ordered sequence for the defined time domain. Continuation points are used to continue the read of the ordered sequence if not all data can be returned in one read. The returned number can be limited by the client or the server. See ReleaseHistoryContinuationPoints for cleaning up resources in the server if read should not be continued with the returned continuation point.
nodesToRead | List of variable nodes to read data history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of raw data. Configuration parameters include
|
timestampsToReturn | Enumeration for the timestamps to return with the values. Possible values are source, server or both. The option neither is invalid for history read. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins an operation to update the history for a list of variables.
nodesToUpdate | The list of variable nodes to update, including the data provided for the update. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins an operation to update the history for a list of event notifier objects.
nodesToUpdate | List of event notifier objects to update, including the event data and update settings. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins an operation to update the history for a list of structured metadata variables.
nodesToUpdate | The list of variable nodes to update, including the data provided for the update. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
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 the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
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. |
|
inline |
|
inline |
Begins a register nodes operation.
nodesToRegister | The nodes to register. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
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. |
|
inline |
Begins a release browse continuation point operation.
continuationPoint | The continuation point. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins a release history continuation point operation.
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. |
|
inline |
Begins a release history continuation point operation.
nodesToRead | The nodes to read. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins a translate browse paths operation.
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. |
|
inline |
Begins a translate browse paths operation.
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. |
|
inline |
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 the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins a translate browse paths operation.
pathsToTranslate | The paths to translate. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Begins an unregister nodes operation.
nodesToUnregister | The nodes to unregister. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Writes attributes asynchronously to a OPC UA 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 the property DefaultRequestSettings are used. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
This is an overloaded function. See BeginWrite for more details.
|
inline |
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 | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
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. |
|
inline |
This is an overloaded function. See Browse for more details.
nodeToBrowse | The node to browse. |
browseContext | The browse context. |
continuationPoint | The continuation point. |
|
inline |
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.
|
inline |
Browse OPC server address space with a list of starting nodes.
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 browse method is used for a list of starting nodes.
nodesToBrowse | The nodes to browse. |
|
inline |
Browse OPC server address space with a list of starting nodes.
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 browse method is used for a list of starting nodes.
view | The view. |
nodesToBrowse | The nodes to browse. |
maxReferencesPerBrowse | The maximum number of references per browse. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Continues 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.
continuationPoint | 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 processing the Browse Service call. |
|
inline |
Continues 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 | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
continuationPoint | 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 processing the Browse Service call. |
|
inline |
Calls a method of an Object in the OPC server
objectToCall | The object to call. |
methodToCall | The method to call. |
|
inline |
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. |
|
inline |
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 the property DefaultRequestSettings are used. |
inputArgumentErrors | The input argument errors. |
outputArguments | The output arguments. |
|
inline |
Calls the specified methods to call.
methodsToCall | The methods to call. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Cancels all requests with the specified handle.
requestHandle | The handle of the request to cancel. |
settings | The settings. |
Using this service requires that the caller explicitly specify a RequestId in the RequestSettings for each request that it thinks it might like to cancel. To avoid conflicts with the SDK the request ID should be be less than 1,000,000.
|
inline |
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.
|
inline |
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. |
|
inline |
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 the property DefaultRequestSettings are used. |
|
inline |
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. |
|
inline |
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 the property DefaultRequestSettings are used. |
|
inline |
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 | Whether to retry a failed connect in the background. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
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 the property DefaultRequestSettings are used. |
|
inline |
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 | Whether to retry a failed connect in the background. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Deletes the nodes.
nodesToDelete | The nodes to delete. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Deletes the references.
referencesToDelete | The references to delete. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
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.
|
inline |
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 subscriptions are not deleted when option Keep is used. |
|
inline |
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 subscriptions are not deleted when option Keep is used. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
inline |
Completes an asynchronous add nodes operation.
result | The object returned from the BeginAddNodes method. |
|
inline |
Ends and asynchronous add references operation.
result | The object returned from the BeginAddReferences() method. |
|
inline |
Completes an ansynchronous browse operation.
result | The object returned from the BeginBrowse method. |
continuationPoint | The continuation point. |
|
inline |
Completes an ansynchronous browse list operation.
result | The object returned from the BeginBrowseList method. |
|
inline |
Completes an asynchronous Call operation.
result | The object returned from the BeginCall method. |
|
inline |
Completes an asynchronous Call operation.
result | The object returned from the BeginCall method. |
inputArgumentErrors | The input argument errors. |
outputArguments | The output arguments. |
|
inline |
Completes an asynchronous request to call a list of methods.
result | The object returned from the BeginCallList method. |
|
inline |
Completes a cancel operation.
result | The result. |
|
inline |
Completes an asynchronous change user request.
result | The result returned from BeginChangeUser method |
|
inline |
Completes an asynchronous connect operation.
result | The object returned from the BeginConnect() method. |
|
inline |
Ends the delete nodes operation.
result | The object returned from the BeginDeleteNodes() method. |
|
inline |
Ends the delete references operation.
result | The object returned from the BeginDeleteReferences() method. |
|
inline |
Completes an asynchronous disconnect operation.
result | The object returned from the BeginDisconnect method. |
|
inline |
Ends an operation to delete the history for a list of variables.
result | The object returned from the BeginHistoryDeleteAtTime method. |
|
inline |
Ends an operation to delete the history for a list of variables.
result | The object returned from the BeginHistoryDeleteEvent method. |
|
inline |
Ends an operation to delete the history for a list of variables.
result | The object returned from the BeginHistoryDeleteRaw method. |
|
inline |
Completes an asynchronous HistoryReadAtTime operation.
result | The object returned from the BeginHistoryReadAtTime method. |
|
inline |
Ends an operation to read the event history for a list of notifiers.
result | The object returned from the BeginHistoryReadEvent method. |
|
inline |
Completes an asynchronous HistoryReadModified operation.
result | The object returned from the BeginHistoryReadModified method. |
|
inline |
Completes an asynchronous HistoryReadProcessed operation.
result | The object returned from the BeginHistoryReadProcessed method. |
|
inline |
Completes an asynchronous HistoryReadRaw operation.
result | The object returned from the BeginHistoryReadRaw method. |
|
inline |
Ends an operation to update the history for a list of variables.
result | The object returned from the BeginHistoryUpdateData method. |
|
inline |
Ends an operation to update the history for a list of event notifier objects.
result | The object returned from the BeginHistoryUpdateEvent method. |
|
inline |
Ends an operation to update the history for a list of structured metadata variables.
result | The object returned from the BeginHistoryUpdateStructureData method. |
|
inline |
Completes an asynchronous read operation.
result | The object returned from the BeginRead method. |
|
inline |
Ends an asynchronous register nodes operation.
result | The object returned from the BeginRegisterNodes() method. |
|
inline |
Ends an asynchronous release browse continuation point operation.
result | The object returned from the BeginReleaseBrowseContinuationPoint method. |
|
inline |
Ends an asynchronous release history continuation point operation.
result | The object returned from the BeginReleaseHistoryContinuationPoints method. |
|
inline |
Ends an asynchronous translate browse path operation.
result | The object returned from the BeginTranslateBrowsePath method. |
|
inline |
Ends an asynchronous unregister nodes operation.
result | The object returned from the BeginUnregisterNodes() method. |
|
inline |
Ends an asynchronous write operation.
result | The result returned from BeginWrite method. |
|
inline |
Deletes the history for a list of variables for the passed timestamps.
nodesToDelete | The variables with history to delete, including the timestamps for the data to be deleted. |
|
inline |
Deletes the history for a list of variables for the passed timestamps.
nodesToDelete | The variables with history to delete, including the timestamps for the data to be deleted. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Deletes the event history for a list of event notifier objects.
nodesToUpdate | List of event notifier objects and Ids of events to delete. |
|
inline |
Deletes the event history for a list of event notifier objects.
nodesToUpdate | List of event notifier objects and Ids of events to delete. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Deletes the history for a list of variables in the passed time domain.
nodesToDelete | The variables with history to delete, including the time domain for the data to be deleted. |
|
inline |
Deletes the history for a list of variables in the passed time domain.
nodesToDelete | The variables with history to delete, including the time domain for the data to be deleted. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Reads the history of item values synchronously from the OPC server for the given timestamps.
nodesToRead | List of variable nodes to read data values at specified timestamps from. |
details | Configuration parameters for the history read of data at specified timestamps. Configuration parameters include
|
|
inline |
Reads the history of item values synchronously from the OPC server for the given timestamps.
nodesToRead | List of variable nodes to read data values at specified timestamps from. |
details | Configuration parameters for the history read of data at specified timestamps. Configuration parameters include
|
timestampsToReturn | Enumeration for the timestamps to return with the values. Possible values are source , server or both . The option neither is invalid for history read. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Reads the event history for a list of event notifier objects synchronously from an OPC server.
nodesToRead | List of event notifier object nodes to read event history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of events. Configuration parameters include,
|
|
inline |
Reads the event history for a list of event notifier objects synchronously from an OPC server.
nodesToRead | List of event notifier object nodes to read event history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of events. Configuration parameters include
|
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Reads the history of modified variable values synchronously from the OPC server.
This method is used to read modified historical values of one or more nodes in an ordered sequence for the defined time domain. Continuation points are used to continue the read of the ordered sequence if not all data can be returned in one read. The returned number can be limited by the client or the server. See ReleaseHistoryContinuationPoints for cleaning up resources in the server if read should not be continued with the returned continuation point.
nodesToRead | List of variable nodes to read modified data history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of modified data. Configuration parameters include
|
|
inline |
Reads the history of modified variable values synchronously from the OPC server.
This method is used to read modified historical values of one or more nodes in an ordered sequence for the defined time domain. Continuation points are used to continue the read of the ordered sequence if not all data can be returned in one read. The returned number can be limited by the client or the server. See ReleaseHistoryContinuationPoints for cleaning up resources in the server if read should not be continued with the returned continuation point.
nodesToRead | List of variable nodes to read modified data history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of modified data. Configuration parameters include
|
timestampsToReturn | Enumeration for the timestamps to return with the values. Possible values are source, server or both. The option neither is invalid for history read. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Reads the processed history of variable values synchronously from the OPC server based on a passed aggregate.
This method is used to read processed historical values of one or more nodes in an ordered sequence for the defined time domain. Continuation points are used to continue the read of the ordered sequence if not all data can be returned in one read or if the server was not able to finish the processing before the timeout expired. The returned number can be limited by the server and may be 0 if the server was not able to finish one calculation before the service timeout expired. See ReleaseHistoryContinuationPoints for cleaning up resources in the server if read should not be continued with the returned continuation point.
The processed values are calculated with the specified aggregate based on the raw data in the history database. The server must use start time, end time, and the resample interval to generate a sequence of time intervals and then calculate an aggregate for each interval.
nodesToRead | List of variable nodes to read processed data history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of processed data. Configuration parameters include
|
|
inline |
Reads the processed history of variable values synchronously from the OPC server based on a passed aggregate.
This method is used to read processed historical values of one or more nodes in an ordered sequence for the defined time domain. Continuation points are used to continue the read of the ordered sequence if not all data can be returned in one read or if the server was not able to finish the processing before the timeout expired. The returned number can be limited by the server and may be 0 if the server was not able to finish one calculation before the service timeout expired. See ReleaseHistoryContinuationPoints for cleaning up resources in the server if read should not be continued with the returned continuation point.
The processed values are calculated with the specified aggregate based on the raw data in the history database. The server must use start time, end time, and the resample interval to generate a sequence of time intervals and then calculate an aggregate for each interval.
nodesToRead | List of variable nodes to read processed data history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of processed data. Configuration parameters include
|
timestampsToReturn | The timestamps to return. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Reads the history of variable values synchronously from OPC server.
This method is used to read raw historical values of one or more nodes in an ordered sequence for the defined time domain. Continuation points are used to continue the read of the ordered sequence if not all data can be returned in one read. The returned number can be limited by the client or the server. See ReleaseHistoryContinuationPoints for cleaning up resources in the server if read should not be continued with the returned continuation point.
nodesToRead | List of variable nodes to read data history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of raw data. Configuration parameters include
|
|
inline |
Reads the history of variable values synchronously from OPC server.
This method is used to read raw historical values of one or more nodes in an ordered sequence for the defined time domain. Continuation points are used to continue the read of the ordered sequence if not all data can be returned in one read. The returned number can be limited by the client or the server. See ReleaseHistoryContinuationPoints for cleaning up resources in the server if read should not be continued with the returned continuation point.
nodesToRead | List of variable nodes to read data history from. Includes a continuation point to continue previous read requests. |
details | Configuration parameters for the history read of raw data. Configuration parameters include
|
timestampsToReturn | Enumeration for the timestamps to return with the values. Possible values are source, server or both. The option neither is invalid for history read. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Updates the history for a list of variables.
nodesToUpdate | The list of variable nodes to update, including the data provided for the update. |
|
inline |
Updates the history for a list of variables.
nodesToUpdate | The list of variable nodes to update, including the data provided for the update. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Updates the event history for a list of event notifier objects.
nodesToUpdate | List of event notifier objects to update, including the event data and update settings. |
|
inline |
Updates the event history for a list of event notifier objects.
nodesToUpdate | List of event notifier objects to update, including the event data and update settings. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Updates the history for a list of for structured metadata variables.
nodesToUpdate | The list of variable nodes to update, including the data provided for the update. |
|
inline |
Updates the history for a list of structured metadata variables.
nodesToUpdate | The list of variable nodes to update, including the data provided for the update. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
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 the property DefaultRequestSettings are used. |
|
inline |
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. |
|
inline |
Registers the nodes.
nodesToRegister | The nodes to register. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Releases the browse continuation point.
continuationPoint | The continuation point. |
|
inline |
Releases the browse continuation point.
continuationPoint | The continuation point. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Releases the history continuation points.
nodesToRead | The nodes to read. |
|
inline |
Releases the history continuation points.
nodesToRead | The nodes to read. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
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 |
|
inline |
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 |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Translates the browse paths.
startingNodeId | The starting node. |
browsePaths | A list of browse paths to translate. |
|
inline |
Translates the browse paths.
startingNodeId | The starting node. |
browsePaths | A list of browse paths to translate. |
namespaceUris | The table of namespaces 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 the property DefaultRequestSettings are used. |
|
inline |
Unregisters the nodes.
nodesToUnregister | The nodes to unregister. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
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 the property DefaultRequestSettings are used. |
|
inline |
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 | 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 settings used as fallback for OPC UA service calls.
The default request settings include a timeout, diagnostic settings, request id, and maximum number of operations per request.
|
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 a value indicating whether to use DNS name and port from discovery URL when connecting to a server.
true
if the DNS name and port from discovery URL should be used when connecting to a server; otherwise, false
.
Sometimes the DNS name of the server is not accessible to the Client. Setting this flag will automatically use the DNS name of the URL passed to the Connect method when connecting to the server. Note that setting this flag to true makes it easier for hackers to trick clients into revealing confidential information (such as passwords) by redirecting clients to a rogue gateway.
|
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.
The SDK automatically detects if the target is a GUI control and ensures that the callback is invoked on the correct thread.
SessionValidationEventHandler UnifiedAutomation.UaClient.Session.SessionValidationError |
Raised when a non-fatal error occurs during session establishment.
The SDK automatically detects if the target is a GUI control and ensures that the callback is invoked on the correct thread.
UpdateEndpointEventHandler UnifiedAutomation.UaClient.Session.UpdateEndpoint |
Raised before connecting to the server and it allows the application to modify the endpoint used to connect.
The SDK automatically detects if the target is a GUI control and ensures that the callback is invoked on the correct thread. If the target is a GUI control and the synchronous Connect method can be used, this EventHandler must not show a dialog.