.NET Based OPC UA Client/Server SDK
3.0.3.458
|
A class that manages a session with an OPC UA server. More...
Inherits IDisposable, and UnifiedAutomation.UaBase.IMapperContext.
Classes | |
class | SessionAsyncResult |
Stores state information for asynchronous connect operations. More... | |
Public Member Functions | |
Session () | |
Create a session for the default client application. More... | |
Session (ApplicationInstanceBase 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 discoveryUrl, SecuritySelection securitySelection) |
Establish a connection to the OPC UA server. More... | |
void | Connect (string discoveryUrl, SecuritySelection securitySelection, RequestSettings settings) |
Establish a connection to the OPC UA server. More... | |
void | Connect (string discoveryUrl, SecuritySelection securitySelection, string transportProfileUri, RetryInitialConnect retryInitialConnect, RequestSettings settings) |
Establish a connection to the OPC UA server. More... | |
IAsyncResult | BeginConnect (string discoveryUrl, 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 outstanding service requests on the OPC UA server. More... | |
IAsyncResult | BeginCancel (uint requestHandle, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously cancels outstanding service requests on the OPC UA server. 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 synchronously from OPC server. More... | |
List< DataValue > | Read (IList< ReadValueId > nodesToRead) |
Reads attribute values synchronously 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) |
Writes attributes asynchronously to a OPC UA server. 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 the OPC UA server’s address space with a single starting node. More... | |
List< ReferenceDescription > | Browse (NodeId nodeToBrowse, BrowseContext browseContext, out byte[] continuationPoint) |
Browse the OPC UA server’s address space with a single starting node. More... | |
List< ReferenceDescription > | Browse (NodeId nodeToBrowse, out byte[] continuationPoint) |
Browse the OPC UA server’s address space with a single starting node. More... | |
IAsyncResult | BeginBrowse (NodeId nodeToBrowse, AsyncCallback callback, Object userData) |
Asynchronously browse the OPC UA server’s address space with a single starting node. More... | |
IAsyncResult | BeginBrowse (NodeId nodeToBrowse, BrowseContext browseContext, AsyncCallback callback, Object userData) |
Asynchronously browse the OPC UA server’s address space with a single starting node. More... | |
IAsyncResult | BeginBrowse (NodeId nodeToBrowse, BrowseContext browseContext, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously browse the OPC UA server’s address space with a single starting node. 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 the OPC UA server’s address space with a list of starting nodes. More... | |
List< List < ReferenceDescription > > | BrowseList (ViewDescription view, List< BrowseDescription > nodesToBrowse, uint maxReferencesPerBrowse, RequestSettings settings) |
Browse the OPC UA server’s 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 asynchronously. 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 asynchronously. 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) |
Translates a browse path to a NodeId. More... | |
List< BrowsePathResult > | TranslateBrowsePath (IList< BrowsePath > pathsToTranslate, RequestSettings settings) |
Translates a browse path to a NodeId. More... | |
List< BrowsePathResult > | TranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths) |
Translates a browse path to a NodeId. More... | |
List< BrowsePathResult > | TranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths, NamespaceTable namespaceUris, RequestSettings settings) |
Translates a browse path to a NodeId. More... | |
IAsyncResult | BeginTranslateBrowsePath (IList< BrowsePath > pathsToTranslate, AsyncCallback callback, object userData) |
Asynchronously translates a browse path to a NodeId. More... | |
IAsyncResult | BeginTranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths, AsyncCallback callback, object userData) |
Asynchronously translates a browse path to a NodeId. More... | |
IAsyncResult | BeginTranslateBrowsePath (NodeId startingNodeId, IList< string > browsePaths, NamespaceTable namespaceUris, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously translates a browse path to a NodeId. More... | |
IAsyncResult | BeginTranslateBrowsePath (IList< BrowsePath > pathsToTranslate, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously translates a browse path to a NodeId. More... | |
List< BrowsePathResult > | EndTranslateBrowsePath (IAsyncResult result) |
Ends an asynchronous translate browse path operation. More... | |
List< Variant > | Call (NodeId objectToCall, NodeId methodToCall) |
Calls a method provided by an Object on the OPC server. More... | |
StatusCode | Call (NodeId objectToCall, NodeId methodToCall, List< Variant > inputArguments, out List< StatusCode > inputArgumentErrors, out List< Variant > outputArguments) |
Calls a method provided by an Object on the OPC server. More... | |
StatusCode | Call (NodeId objectToCall, NodeId methodToCall, List< Variant > inputArguments, RequestSettings settings, out List< StatusCode > inputArgumentErrors, out List< Variant > outputArguments) |
Calls a method provided by an Object on the OPC UA server. More... | |
IAsyncResult | BeginCall (NodeId objectToCall, NodeId methodToCall, List< Variant > inputArguments, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously calls a method provided by an Object on the OPC UA server. 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 a list of methods provided by an Object on the OPC server. More... | |
IAsyncResult | BeginCallList (IList< CallMethodRequest > methodsToCall, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously calls a list of methods provided by an Object on the OPC server. 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, HistoryReadDetails details, 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, HistoryReadDetails details, 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 nodes to the OPC UA server’s address space. More... | |
IAsyncResult | BeginAddNodes (IList< AddNodesItem > nodesToAdd, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously adds nodes to the OPC UA server’s address space. More... | |
List< AddNodesResult > | EndAddNodes (IAsyncResult result) |
Completes an asynchronous add nodes operation. More... | |
List< StatusCode > | AddReferences (IList< AddReferencesItem > referencesToAdd, RequestSettings settings) |
Adds references to nodes in the OPC UA server’s address space. More... | |
IAsyncResult | BeginAddReferences (IList< AddReferencesItem > referencesToAdd, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously adds references to nodes in the OPC UA server’s address space. More... | |
List< StatusCode > | EndAddReferences (IAsyncResult result) |
Ends and asynchronous add references operation. More... | |
List< StatusCode > | DeleteNodes (IList< DeleteNodesItem > nodesToDelete, RequestSettings settings) |
Deletes nodes from the OPC UA server’s address space. More... | |
IAsyncResult | BeginDeleteNodes (IList< DeleteNodesItem > nodesToDelete, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously deletes nodes from the OPC UA server’s address space. More... | |
List< StatusCode > | EndDeleteNodes (IAsyncResult result) |
Completes an asynchronous delete nodes operation. More... | |
List< StatusCode > | DeleteReferences (IList< DeleteReferencesItem > referencesToDelete, RequestSettings settings) |
Deletes references from the OPC UA server’s address space. More... | |
IAsyncResult | BeginDeleteReferences (IList< DeleteReferencesItem > referencesToDelete, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously deletes references from the OPC UA server’s address space. More... | |
List< StatusCode > | EndDeleteReferences (IAsyncResult result) |
Completes an asynchronous delete references operation. More... | |
List< NodeId > | RegisterNodes (IList< NodeId > nodesToRegister, RequestSettings settings) |
Register nodes to create shortcuts in the server. More... | |
IAsyncResult | BeginRegisterNodes (IList< NodeId > nodesToRegister, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously register nodes to create shortcuts in the server. More... | |
List< NodeId > | EndRegisterNodes (IAsyncResult result) |
Ends an asynchronous register nodes operation. More... | |
void | UnregisterNodes (IList< NodeId > nodesToUnregister, RequestSettings settings) |
Unregister nodes to delete shortcuts in the server. More... | |
IAsyncResult | BeginUnregisterNodes (IList< NodeId > nodesToUnregister, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously unregister nodes to delete shortcuts in the server. More... | |
void | EndUnregisterNodes (IAsyncResult result) |
Ends an asynchronous unregister nodes operation. More... | |
List< TransferFromSessionResult > | TransferFromSession (Session sourceSession, bool sendInitialValues, RequestSettings settings) |
Transfers all subscriptions from a disconnected session. More... | |
IAsyncResult | BeginTransferFromSession (Session sourceSession, bool sendInitialValues, RequestSettings settings, AsyncCallback callback, Object userData) |
Begins an operation to transfers all subscriptions from a disconnected session. More... | |
List< TransferFromSessionResult > | EndTransferFromSession (IAsyncResult result) |
Completes an operation to transfers all subscriptions from a disconnected session. More... | |
List< TransferResult > | InternalTransferSubscriptions (IList< uint > subscriptionsToTransfer, bool sendInitialValues, RequestSettings settings) |
Transfers the subscription to the session. More... | |
IAsyncResult | BeginInternalTransferSubscriptions (IList< uint > subscriptionsToTransfer, bool sendInitialValues, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously transfers the subscription to the session. More... | |
List< TransferResult > | EndInternalTransferSubscriptions (IAsyncResult result) |
Completes an asynchronous transfer subscriptions operation. More... | |
List< StatusCode > | TransferSubscriptions () |
Transfers the Subscriptions of the Session to the Session. More... | |
List< StatusCode > | TransferSubscriptions (List< Subscription > subscriptions) |
Transfers the Subscriptions to the Session. More... | |
List< StatusCode > | TransferSubscriptions (List< Subscription > subscriptions, RequestSettings settings) |
Transfers the Subscriptions to the Session. More... | |
IAsyncResult | BeginTransferSubscriptions (IList< Subscription > subscriptions, RequestSettings settings, AsyncCallback callback, Object userData) |
Asynchronously transfers Subscriptions to the Session More... | |
List< StatusCode > | EndTransferSubscriptions (IAsyncResult result) |
Completes an asynchronous transfer subscriptions operation. More... | |
StatusCode | TransferSingleSubscription (Subscription subscription) |
Transfers a subscription to the Session. More... | |
StatusCode | TransferSingleSubscription (Subscription subscription, RequestSettings settings) |
Transfers a subscription to the Session. More... | |
IAsyncResult | BeginTransferSingleSubscription (Subscription subscription, RequestSettings settings, AsyncCallback callback, Object userData) |
Asynchronously transfers a Subscription to the Session. More... | |
StatusCode | EndTransferSingleSubscription (IAsyncResult result) |
Completes an asynchronous transfer single subscription operation. More... | |
List< QueryDataSet > | Query (QueryContext queryContext, RequestSettings settings, out byte[] continuationPoint, out QueryValidationResult validationResult) |
Start a query against the server's address space. More... | |
IAsyncResult | BeginQuery (QueryContext queryContext, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously begins a query operation. More... | |
List< QueryDataSet > | EndQuery (IAsyncResult result, out byte[] continuationPoint, out QueryValidationResult validationResult) |
Completes an ansynchronous query operation. More... | |
List< QueryDataSet > | QueryNext (byte[] continuationPoint, bool releaseContinuationPoint, RequestSettings settings, out byte[] revisedContinuationPoint) |
Continues a query against the server's address space. More... | |
IAsyncResult | BeginQueryNext (byte[] continuationPoint, bool releaseContinuationPoint, RequestSettings settings, AsyncCallback callback, object userData) |
Asynchronously begins a query operation. More... | |
List< QueryDataSet > | EndQueryNext (IAsyncResult result, out byte[] revisedContinuationPoint) |
Completes an ansynchronous query operation. More... | |
Protected Types | |
enum | State { State.Disconnected, State.Connecting, State.Reconnecting, State.Connected, State.Reactivating, State.Disposed } |
The possible states for the session. More... | |
Protected Member Functions | |
virtual bool | StopReconnectOnException (StatusException se) |
Determines if the reconnect loop stops if a StatusException ocurrs during Reactivate More... | |
virtual bool | CreateNewSessionOnException (StatusException se) |
Specifies if a new session shall be created if an exception is thrown. More... | |
void | CheckSessionState (State state) |
Checks the state of the session. More... | |
RequestHeader | GetRequestHeader (RequestSettings settings) |
Gets the request header. More... | |
Properties | |
ApplicationInstanceBase | Application [get] |
Gets the application. More... | |
NodeId | SessionId [get] |
Gets the session id. More... | |
CacheManager | Cache [get] |
Gets the cache manager. More... | |
ModelManager | Model [get] |
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. Can be set to use other authentifications than Anonymous. 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... | |
double | RevicedSessionTimeout [get] |
Gets the session timeout that is revised by the server. More... | |
uint | WatchdogCycleTime [get, set] |
Gets or sets the watchdog cycle time used for connection check and reconnect after connection errors. More... | |
uint | WatchdogTimeout [get, set] |
Gets or sets the watchdog service call timeout used for watchdog read calls. More... | |
bool | AutomaticReconnect [get, set] |
Gets or sets a value indicating whether the session should automatically reconnect on error. More... | |
RetryInitialConnect | RetryInitialConnect [get, set] |
Gets or sets a value indicating whether the session should automatically retry to connect if connect fails. More... | |
uint | ReconnectDelay [get, set] |
Gets or sets the delay between reconnect attempts. More... | |
uint | ReconnectTimeout [get, set] |
Gets or sets the timeout for the reconnect procedure in milliseconds. More... | |
uint | ReconnectCreateSubscriptionsDelay [get, set] |
Gets or sets the time been the recreation of a Session on reconnect and the recreation of Subscriptions. More... | |
uint | PublishPipelineDepth [get, set] |
Gets or sets the publish pipeline depth. More... | |
int | PublishTimeout [get, set] |
Gets or sets the publish request timeout. 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... | |
bool | AllowInsecureCredentials [get, set] |
Gets or sets a value indicating whether a password can be sent over an insecure connection. More... | |
EndpointDescription | EndpointDescription [get, set] |
Gets or sets the endpoint description. More... | |
ServerConnectionStatus | ConnectionStatus [get] |
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... | |
SessionClient | InternalSession [get] |
Gets the internal session. More... | |
int | SubscriptionCount [get] |
Gets the number of subscriptions. More... | |
List< Subscription > | Subscriptions [get] |
Gets the Subscriptions of the Session More... | |
int | PublishRequestCount [get] |
Gets the number of outstanding publish requests. More... | |
Events | |
ServerConnectionStatusUpdateEventHandler | ConnectionStatusUpdate |
Raised when the connection status has been updated. More... | |
SessionValidationEventHandler | SessionValidationError |
No longer used. More... | |
UpdateEndpointEventHandler | UpdateEndpoint |
Raised before connecting to the server and it allows the application to modify the endpoint used to connect. More... | |
InsecureCredentialsEventHandler | InsecureCredentials |
Raised before sending a plaintext user credentials over an insecure connection. 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 nodes to the OPC UA server’s address space.
nodesToAdd | List of nodes to add to the server. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Adds references to nodes in the OPC UA server’s address space.
referencesToAdd | List of references to add to the server. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Asynchronously adds nodes to the OPC UA server’s address space.
nodesToAdd | List of nodes to add to the server. |
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 adds references to nodes in the OPC UA server’s address space.
referencesToAdd | List of references to add to the server. |
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 browse the OPC UA server’s address space with a single 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. |
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 |
Asynchronously browse the OPC UA server’s address space with a single starting node.
This is an overloaded function. See BeginBrowse for more details.
nodeToBrowse | NodeId of the starting node. |
browseContext | Filter settings for the browse call. See BrowseContext for more details. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Asynchronously browse the OPC UA server’s address space with a single starting node.
This is an overloaded function. See BeginBrowse for more details.
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. |
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 asynchronously.
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 | List of browse descriptions for each starting node. |
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 asynchronously.
This is an overloaded function. See BeginBrowseList for more details.
view | View used for the browse. |
nodesToBrowse | List of browse descriptions for each starting node. |
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. |
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 is an overloaded function. See BeginBrowseNext for more details.
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. |
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 a method provided by an Object on the OPC UA server.
objectToCall | The object providing the method. |
methodToCall | The method to call. |
inputArguments | List of input arguments for the method 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 a list of methods provided by an Object on the OPC server.
methodsToCall | List of methods to call, containing ObjectId, MethodId, and InputArguments for each method. |
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 cancels outstanding service requests on the OPC UA server.
requestHandle | Request handle used for the outstanding service requests to cancel. |
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 |
Change user for the connection to the OPC UA server asynchronously.
Calling this function changes the user of the session by calling ActivateSession with the new user identity.
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.
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. |
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 creates a secure channel to the discovery url and calls GetEndpoints. Depending on the securitySelection a server endpoint is chosen. Then the function creates a secure channel to the server endpoint and it creates and activates a session in the server application.
The SDK is managing the connection to the server by
discoveryUrl | 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. The supported security policies are None, Basic128Rsa15, Basic256 and Basic256Sha256. |
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 deletes nodes from the OPC UA server’s address space.
nodesToDelete | List of 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 |
Asynchronously deletes references from the OPC UA server’s address space.
referencesToDelete | List of 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 | 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 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 |
Asynchronously transfers the subscription to the session.
subscriptionsToTransfer | List of nodes to add to the server. |
sendInitialValues | If true the initial values are reported for each monitored item. |
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 begins a query operation.
|
inline |
Asynchronously begins a query operation.
|
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 | 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
|
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 | List of nodes and attributes to read. |
maxAge | The maximum age for any value. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Asynchronously register nodes to create shortcuts in the server.
This method allows clients to optimize the cyclic access to Nodes for example for writing variable values or for calling methods. There are two levels of optimization.
The first level is to reduce the amount of data on the wire for the addressing information. Since NodeIds are used for addressing in Nodes and NodeIds can be very long, a more optimized addressing method is desirable for cyclic use of Nodes. Classic OPC provided the concept to create handles for items by adding them to a group. RegisterNodes provides a similar concept to create handles for Nodes by returning a numeric NodeId that can be used in all functions accessing information from the server. The transport of numeric NodeIds is very efficient in the OPC UA binary protocol.
The second level of optimization is possible inside the server. Since the client is telling the server that it wants to use the Node more frequently by registering the Node, the server is able to prepare everything that is possible to optimize the access to the Node.
The handles returned by the server are only valid during the lifetime of the Session that was used to register the Nodes. Clients must call UnregisterNodes if the Node is no longer used to free the resources used in the server for the optimization. This method should not be used to optimize the cyclic read of data since OPC UA provides a much more optimized mechanism to subscribe for data changes.
Clients do not have to use the Service and servers can simply implement the Service only returning the same list of NodeIds that was passed in if there is no need to optimize the access.
nodesToRegister | List of NodeIds of 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 to release. |
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 to release. |
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. |
This overload only works with data returned with a call to ReadRaw.
|
inline |
Begins a release history continuation point operation.
nodesToRead | The nodes to read. |
details | The structure that matches the request used to originally read the data (ReadRawModifiedDetails, ReadAtTimeDetails or ReadProcessedDetails). |
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 transfers all subscriptions from a disconnected session.
sourceSession | The source of the subscriptions to transfer. |
sendInitialValues | Whether the initial values shoudl be sent as soon as the transfer completes. |
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 asynchronous call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Asynchronously transfers a Subscription to the Session.
subscription | The subscription that shall be transferred to the session. The Session property of the subscription must be a reference to this Session or to a Session that is currently Disconnected. |
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 transfers Subscriptions to the Session
subscriptions | The subscriptions that shall be transferred to the session. The Session property of each Subscription must be a reference to this Session or to a Session that is currently Disconnected. |
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 translates 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. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Asynchronously translates a browse path to a NodeId.
This is an overloaded function. See BeginTranslateBrowsePath for more details.
startingNodeId | The nodeId of 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 |
Asynchronously translates a browse path to a NodeId.
This is an overloaded function. See BeginTranslateBrowsePath for more details.
startingNodeId | The NodeId of 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 |
Asynchronously translates a browse path to a NodeId.
This is an overloaded function. See BeginTranslateBrowsePath for more details.
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. |
callback | The callback to use when the async call completes. |
userData | The user data that is passed to the callback. |
|
inline |
Asynchronously unregister nodes to delete shortcuts in the server.
Handles created with the Service RegisterNodes must be freed by the client using the method unregisterNodes to free the resources in the server if the registered nodes are not longer needed. 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. |
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 |
Writes attributes asynchronously to a OPC UA server.
This is an overloaded function. See BeginWrite for more details.
|
inline |
Browse the OPC UA server’s address space with a single 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 | A continuation point that can be passed to browseNext to get the remaining results. 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. |
|
inline |
Browse the OPC UA server’s address space with a single starting node.
This is an overloaded function. See Browse for more details.
nodeToBrowse | NodeId of the starting node. |
browseContext | Filter settings for the browse call. See BrowseContext for more details. |
continuationPoint | A continuation point that can be passed to browseNext to get the remaining results. 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. |
|
inline |
Browse the OPC UA server’s address space with a single starting node.
This is an overloaded function. See Browse for more details.
nodeToBrowse | NodeId of the starting node. |
continuationPoint | A continuation point that can be passed to browseNext to get the remaining results. 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. |
|
inline |
Browse the OPC UA server’s 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 | List of browse descriptions for each starting node. |
|
inline |
Browse the OPC UA server’s address space with a list of starting nodes.
This is an overloaded function. See BrowseList for more details.
view | View used for the browse. |
nodesToBrowse | List of browse descriptions for each starting node. |
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
is overwritten to indicate whether there are still results remaining which haven’t been returned yet. This continuationPoint
can be passed to another BrowseNext call.
continuationPoint | Continuation points returned from a previous browse or browseNext call. |
|
inline |
Continues a previous Browse request.
This is an overloaded function. See BrowseNext for more details.
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. |
|
inline |
Calls a method provided by an Object on the OPC server.
objectToCall | The object providing the method. |
methodToCall | The method to call. |
|
inline |
Calls a method provided by an Object on the OPC server.
objectToCall | The object providing the method. |
methodToCall | The method to call. |
inputArguments | List of input arguments for the method call. |
inputArgumentErrors | The input argument errors. |
outputArguments | List of output arguments of the method. |
|
inline |
Calls a method provided by an Object on the OPC UA server.
objectToCall | The object providing the method. |
methodToCall | The method to call. |
inputArguments | List of input arguments for the method call. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
inputArgumentErrors | The input argument errors. |
outputArguments | List of output arguments of the method. |
|
inline |
Calls a list of methods provided by an Object on the OPC server.
methodsToCall | List of methods to call, containing ObjectId, MethodId, and InputArguments for each method. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Cancels outstanding service requests on the OPC UA server.
requestHandle | Request handle used for the outstanding service requests to cancel. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
Using this service requires that the caller explicitly specifies 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. |
|
inlineprotected |
Checks the state of the session.
state | The state. |
|
inline |
Establish a connection to the OPC UA server.
Calling this function creates a secure channel to the discovery url and calls GetEndpoints. Depending on the securitySelection a server endpoint is chosen. Then the function creates a secure channel to the server endpoint and it creates and activates a session in the server application.
The SDK is managing the connection to the server by
Following EventHandlers can be called by this method:
The EventHandlers may be called by other threads than the main thread. If an EventHander will be synchronized to the gui thread with InvokeRequired and Invoke, the method call could block. In these cases you should use the asynchronous API.
discoveryUrl | 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.
This is an overloaded function. See Connect for more details.
discoveryUrl | The URL of the server endpoint to connect to. UA TCP: opc.tcp://networknode:4840 WebService: https://networknode/ServerName |
Following EventHandlers can be called by this method:
The EventHandlers may be called by other threads than the main thread. If an EventHander will be synchronized to the gui thread with InvokeRequired and Invoke, the method call could block. In these cases you should use the asynchronous API.
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.
This is an overloaded function. See Connect for more details.
discoveryUrl | 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. |
|
inlineprotectedvirtual |
Specifies if a new session shall be created if an exception is thrown.
Is called if an StatusException is thrown on ActivateSession in the reconnect cycle.
se | The caught exception. |
true
if a new session shall be created. false
if ActivateSession should be called again.
|
inline |
Deletes nodes from the OPC UA server’s address space.
nodesToDelete | List of nodes to delete. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Deletes references from the OPC UA server’s address space.
referencesToDelete | List of 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 to the session are also deleted if the cleanupPolicy is set to Delete
.
cleanupPolicy | The cleanup policy for the subscription. The option Delete removes the subscription together with the session. The 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 to the session are also deleted if the cleanupPolicy is set to Delete
.
cleanupPolicy | The cleanup policy for the subscription. The option Delete removes the subscription together with the session. The 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 | A continuation point that can be passed to browseNext to get the remaining results. 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. |
|
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 | List of output arguments of the method. |
|
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 object returned from the BeginCancel method. |
|
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 |
Completes an asynchronous delete nodes operation.
result | The object returned from the BeginDeleteNodes method. |
|
inline |
Completes an asynchronous 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 transfer subscriptions operation.
result | The object returned from the BeginInternalTransferSubscriptions method. |
|
inline |
Completes an ansynchronous query operation.
|
inline |
Completes an ansynchronous query operation.
|
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 |
Completes an operation to transfers all subscriptions from a disconnected session.
result | The user data that is passed to the callback. |
|
inline |
Completes an asynchronous transfer single subscription operation.
result | The object returned from the BeginTransferSingleSubscription method. |
|
inline |
Completes an asynchronous transfer subscriptions operation.
result | The object returned from the UnifiedAutomation.UaClient.Session.BeginTransferSubscriptions 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. |
|
inlineprotected |
Gets the request header.
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 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 | 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 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 |
Transfers the subscription to the session.
subscriptionsToTransfer | List of subscriptions to transfer. |
sendInitialValues | If true the initial values are reported for each monitored item. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Start a query against the server's address space.
|
inline |
Continues a query against the server's address space.
|
inline |
Reads attribute values synchronously 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 synchronously from OPC server.
This is an overloaded function. See Read for more details.
nodesToRead | List of nodes and attributes to read. |
|
inline |
Register nodes to create shortcuts in the server.
This method allows clients to optimize the cyclic access to Nodes for example for writing variable values or for calling methods. There are two levels of optimization.
The first level is to reduce the amount of data on the wire for the addressing information. Since NodeIds are used for addressing in Nodes and NodeIds can be very long, a more optimized addressing method is desirable for cyclic use of Nodes. Classic OPC provided the concept to create handles for items by adding them to a group. RegisterNodes provides a similar concept to create handles for Nodes by returning a numeric NodeId that can be used in all functions accessing information from the server. The transport of numeric NodeIds is very efficient in the OPC UA binary protocol.
The second level of optimization is possible inside the server. Since the client is telling the server that it wants to use the Node more frequently by registering the Node, the server is able to prepare everything that is possible to optimize the access to the Node.
The handles returned by the server are only valid during the lifetime of the Session that was used to register the Nodes. Clients must call UnregisterNodes if the Node is no longer used to free the resources used in the server for the optimization. This method should not be used to optimize the cyclic read of data since OPC UA provides a much more optimized mechanism to subscribe for data changes.
Clients do not have to use the Service and servers can simply implement the Service only returning the same list of NodeIds that was passed in if there is no need to optimize the access.
nodesToRegister | List of NodeIds of 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 to release. |
|
inline |
Releases the browse continuation point.
continuationPoint | The continuation point to release. |
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 with information about the history continuation points to release. |
This overload only works with data returned with a call to ReadRaw.
|
inline |
Releases the history continuation points.
nodesToRead | The nodes with information about the history continuation points to release. |
details | The structure that matches the request used to originally read the data (ReadRawModifiedDetails, ReadAtTimeDetails or ReadProcessedDetails). |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inlineprotectedvirtual |
Determines if the reconnect loop stops if a StatusException ocurrs during Reactivate
se | The caught StatusException. |
true
if the reconnect loop shall stop.
|
inline |
Transfers all subscriptions from a disconnected session.
sourceSession | The source of the subscriptions to transfer. |
sendInitialValues | Whether the initial values shoudl be sent as soon as the transfer completes. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Transfers a subscription to the Session.
subscription | The subscription that shall be transferred to the session. The Session property of the Subscription must be a reference to this Session or to a Session that is currently Disconnected. |
|
inline |
Transfers a subscription to the Session.
subscription | The subscription that shall be transferred to the session. The Session property of the Subscription must be a reference to this Session or to a Session that is currently Disconnected. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
|
inline |
Transfers the Subscriptions to the Session.
subscriptions | The subscriptions that shall be transferred to the session. The Session property of each Subscription must be a reference to this Session or to a Session that is currently Disconnected. |
|
inline |
Transfers the Subscriptions to the Session.
subscriptions | The subscriptions that shall be transferred to the session. The Session property of each Subscription must be a reference to this Session or to a Session that is currently Disconnected. |
settings | The general settings for the request. If null, the default settings from the property DefaultRequestSettings are used. |
|
inline |
Translates 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 |
Translates a browse path to a NodeId.
This is an overloaded function. See TranslateBrowsePath for more details.
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 a browse path to a NodeId.
This is an overloaded function. See TranslateBrowsePath for more details.
startingNodeId | The NodeId of the starting node. |
browsePaths | A list of browse paths to translate. |
|
inline |
Translates a browse path to a NodeId.
This is an overloaded function. See TranslateBrowsePath for more details.
startingNodeId | The NodeId of 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 |
Unregister nodes to delete shortcuts in the server.
Handles created with the Service RegisterNodes must be freed by the client using the method UnregisterNodes to free the resources in the server if the registered nodes are not longer needed.
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 a value indicating whether a password can be sent over an insecure connection.
true
if a password can be sent over an insecure connection; otherwise, false
.
Sometimes a Server has no ability to handle encrypted passwords. This property bypasses the checks used to prevent applications from accidentally exposing sensitive data to evesdroppers.
|
getset |
Gets or sets the alternative endpoint urls.
The AlternativeEndpointUrls are used for connecting if the inital connect fails and retryInitialConnect is set to RetryInitialConnet.Yes. Once a connection could be created, only the Endpoint that worked is used for reconnecting. So AlternativeEndpointUrls are not evaluated for reconnect.
|
get |
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
.
|
get |
Gets the cache manager.
|
get |
Gets 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.
|
getset |
Gets or sets the endpoint description.
|
get |
Gets the dictionary of data types known to the stack.
|
getprotected |
Gets the internal session.
The internal session.
|
get |
Gets the message context.
|
get |
Gets the model manager.
|
get |
Gets the namespace uris.
|
getset |
Gets or sets the preferred locales.
|
getset |
Gets or sets the publish pipeline depth.
|
get |
Gets the number of outstanding publish requests.
|
getset |
Gets or sets the publish request timeout.
The PublishTimeout is the timeout for Publish requests. If this value is 0, then the default timeout for Requests is used instead. It is often necessary to set a higher PublishTimeout because Clients need to make sure that Publish requests are used before they time out. As a rule of thumb the PublishTimeout should be twice as long as the longest MaxKeepAliveTime.
|
getset |
Gets or sets the time been the recreation of a Session on reconnect and the recreation of Subscriptions.
The default value is 0.
|
getset |
Gets or sets the delay between reconnect attempts.
|
getset |
Gets or sets the timeout for the reconnect procedure in milliseconds.
The default value is ReconnectDelay / 2.
|
getset |
Gets or sets a value indicating whether the session should automatically retry to connect if connect fails.
|
get |
Gets the session timeout that is revised by the server.
The server can revice another value than requested by the client. See SessionTimeout for more details.
|
getset |
Gets or sets the secure channel lifetime.
|
getset |
Gets or sets the secure channel timeout.
The SecureChannelTimeout is the timeout used by the SecureChannel created for the Session. It places an upper limit on the OperationTimeout, which can be set individually for any single request. Clients that want to increase the PublishTimeout will likely have to increase the SecureChannelTimeout at the same time.
|
get |
Gets the server uris.
|
get |
Gets the session id.
|
getset |
Gets or sets the name of the session.
|
getset |
Gets or sets the session timeout.
The SessionTimeout specifies when the Server will close a Session due to inactivity. When a Session closes, the resources associated with the Session are freed (e.g. browse continuation points, outstanding publish requests, etc.). However, any associated Subscriptions will live on until they reach the end of their own lifetime. Keeping a Session alive can be done with any request sent to the Server. This is done automatically by the Client SDK if the WatchdogCycleTime is less than the SessionTimeout.
|
get |
Gets the number of subscriptions.
|
get |
Gets the Subscriptions of the Session
|
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.
|
getset |
Gets or sets the user identity. Can be set to use other authentifications than Anonymous.
|
getset |
Gets or sets the watchdog cycle time used for connection check and reconnect after connection errors.
|
getset |
Gets or sets the watchdog service call timeout used for watchdog read calls.
ServerConnectionStatusUpdateEventHandler UnifiedAutomation.UaClient.Session.ConnectionStatusUpdate |
Raised when the connection status has been updated.
This event is raised from a background thread and BeginInvoke may need to be called if being handled by a UI. Handlers that block before returning could cause timeouts or other communication failures.
InsecureCredentialsEventHandler UnifiedAutomation.UaClient.Session.InsecureCredentials |
Raised before sending a plaintext user credentials over an insecure connection.
This event is raised from a background thread and Invoke may need to be called if being handled by a UI. This event has return parameters so BeginInvoke cannot be used. Displaying a modal dialog in the callback will not work if the synchronous version of Connect is used. This problem can be avoided by using BeginConnect.
SessionValidationEventHandler UnifiedAutomation.UaClient.Session.SessionValidationError |
No longer used.
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.
This event is raised from a background thread and Invoke may need to be called if being handled by a UI. This event has return parameters so BeginInvoke cannot be used. Displaying a modal dialog in the callback will not work if the synchronous version of Connect is used. This problem can be avoided by using BeginConnect.