Reference
OpcClient Members
Provides session based methods to access OPC UA server services.
Reference
OpcClient Members
- Type
- OpcClient
- Namespace
- Opc.UaFx.Client
- Assembly
- Opc.UaFx.Advanced.dll
- Package
- Opc.UaFx.Advanced v2.59.0
- Also in
- Opc.UaFx.Client
Inherits members from OpcApplicationInstance<OpcTransport, OpcClientSecurity>.
Constructors
| Name | Description |
|---|---|
| OpcClient | Initializes a new instance of the OpcClient class. |
Fields
| Name | Description |
|---|---|
| Default | Represents the default timeout value that is used by the OpcClient as initial value of the Disconnect |
| Default | Represents the default timeout value that is used by the OpcClient as initial value of the OperationTimeout property. |
| Default | Represents the default interval that is used by the OpcClient as initial value of the Reconnect |
| Default | Represents the default interval that is used by the OpcClient as initial value of the Reconnect |
| Default | Represents the default timeout value that is used by the OpcClient as initial value of the SessionTimeout property. |
Properties
| Name | Description |
|---|---|
| ApplicationName | Gets or sets the name of the client application. |
| Configuration | Gets or sets an instance of the Opc |
| Default | Gets or sets the subscription which is assigned as the default subscription of the sessions used by the OpcClient. |
| Disconnect | Gets or sets the wait time before terminating the attempt to shut-down an activated session. |
| Interfaces | Gets the Opc |
| KeepAlive | Gets the keep-alive options used by the OpcClient to monitor an established connection and recover from unexpected disconnection. |
| Locales | Gets a collection of locales supported/used by the client. |
| Max | Gets or sets the time after which the client stops attempting to reconnect to a halted session. |
| Namespaces | Gets a read-only collection of namespaces used by the server connected to. |
| NodeSet | Gets or sets the OpcNodeSet which is offered by the server the client is operating on. |
| OperationTimeout | Gets or sets the wait time before terminating an operation being processed by the server. |
| Reconnect | Gets or sets the time between two attempts to reconnect to a halted session. |
| ReconnectTimeout | Gets or sets the time between two attempts to reconnect to a halted session. |
| ServerAddress | Gets or sets the Uri of the OPC UA server to operate on. |
| ServerInterfaces | Gets a collection of OPC Classic interfaces supported by the server and used by the client. |
| Services | Gets the Opc |
| SessionName | Gets or sets the name to use for sessions to identify a session of this client. |
| SessionTimeout | Gets or sets the wait time before an active session is handled as expired. |
| State | Gets a value that indicates the current state of the client regarding its channel used to communicate with the endpoint defined by ServerAddress and EndpointPolicy setup via Security. |
| Subscriptions | Gets the subscriptions which are currently associated with the session of the OpcClient. |
| SystemContext | Gets the OpcContext which is used to store the context sensitive data and configuration used by the current OpcClient instance. |
| Use | Gets or sets a value indicating whether a connection break detection is to be used. |
| UsedEndpoint | Gets the Opc |
| UseDynamic | Gets or sets a value indicating whether the current OpcClient shall use generic types to represent OPC UA server defined custom types. |
Methods
| Name | Description |
|---|---|
| AddNode | Adds a new node into the address space hierarchy using the command specified. |
| AddNodes | Adds one or more nodes into the address space hierarchy using the commands specified. |
| AddObjectNode | Adds a new object node into the address space hierarchy using the specified type of object node to add, which shall be accessible by the name defined. |
| AddReference | Adds a new reference to existing nodes in the address space hierarchy using the command specified. |
| AddReferences | Adds one or more references to existing nodes in the address space hierarchy using the commands specified. |
| AddVariableNode | Adds a new variable node into the address space hierarchy using the specified type of variable node to add, which shall be accessible by the name defined. |
| BrowseNode | Browses the node identified by the nodeId specified to examine its attributes and its hierarchical references ( |
| BrowseNodes | Browses the nodes as defined by the commands specified to examine their attributes and their references. |
| CallAction | Calls the method identified by the methodId on the object identified by the objectId specified without any input arguments and discards the values of the output arguments returned. |
| CallFunc | Calls the method identified by the methodId on the object identified by the objectId specified without any input arguments and returns the value of its first output argument. |
| CallMethod | Calls the method as defined by the command specified. |
| CallMethods | Calls the methods as defined by the commands specified using a single call methods service request. |
| Change | Changes the identity of the connected session to the identity specified without creating a new session ( |
| Connect | Establishes a connection to the server identified by the ServerAddress and creates/activates a new session to access the OPC UA services provided by the server. |
| ConnectCore | Performs all necessary tasks to establish a connection to the server identified by the ServerAddress and creates/activates a new session to access the OPC UA services provided by the server. |
| Create | Creates historical values of the node as defined by the command specified. |
| Create | Creates historical values of the nodes as defined by the commands specified using a single history update service request. |
| CreateSecurity | Creates a new instance of the Opc |
| Create | Creates a new OpcSubscription using the setup specified. |
| CreateTransport | Creates a new instance of the OpcTransport class. |
| DeleteNode | Deletes a node from the address space hierarchy using the command specified. |
| Delete | Deletes all raw historical values of the node identified by the nodeId specified. |
| Delete | Deletes historical values at specific timestamps of the node as defined by the command specified. |
| Delete | Deletes all modified historical values of the node identified by the nodeId specified. |
| DeleteNodes | Deletes one or more nodes from the address space hierarchy using the commands specified. |
| Delete | Deletes raw historical values of the nodes as defined by the commands specified using a single history update service request. |
| Delete | Deletes historical values at specific timestamps of the nodes as defined by the commands specified using a single history update service request. |
| Delete | Deletes modified historical values of the nodes as defined by the commands specified using a single history update service request. |
| DeleteReference | Deletes a reference of existing nodes in the address space hierarchy using the command specified. |
| DeleteReferences | Deletes one or more references of existing nodes in the address space hierarchy using the commands specified. |
| Deny | Verifies whether the client is connected to the server. |
| Disconnect | Closes an activated session and terminates the connection to the server. |
| DisconnectCore | Performs all necessary tasks to close an activated session and to terminate the connection to the server. |
| Dispose | Releases the unmanaged resources used by the OpcClient and optionally releases the managed resources. |
| GetDataType | Retrieves the OpcDataTypeInfo object which is known under the name specified. |
| GetDataTypes | Retrieves all OpcDataTypeInfo objects offered by the IOpcTypeProvider. |
| Get | Retrieves the system used to describe the data exchanged via OPC UA using the type of encoding configured by the client and supported by the endpdoint of the server connected to. |
| GetNodeType | Retrieves the OpcNodeTypeInfo object which is known under the name specified. |
| GetNodeTypes | Retrieves all OpcNodeTypeInfo objects offered by the IOpcTypeProvider. |
| Get | Retrieves the system used to describe the type of nodes accessed on the server connected to. |
| GetType | Retrieves the IOpcType object which is known under the name specified. |
| GetTypes | Retrieves all IOpcType objects offered by the IOpcTypeProviders supported. |
| IsSubtypeOf | Determines whether the type identified by subtypeId derives from the type specified by typeId. |
| OnBreakDetected | Raises the BreakDetected event of the OpcClient. |
| On | Raises the Certificate |
| OnConnected | Raises the Connected event of the OpcClient. |
| OnConnecting | Raises the Connecting event of the OpcClient. |
| On | Raises the Data |
| On | Raises the DialogRequested event of the OpcClient. |
| OnDisconnected | Raises the Disconnected event of the OpcClient. |
| OnDisconnecting | Raises the Disconnecting event of the OpcClient. |
| OnEventReceived | Raises the EventReceived event of the OpcClient. |
| On | Raises the Notification |
| On | Raises the Notification |
| OnReconnected | Raises the Reconnected event of the OpcClient. |
| OnReconnecting | Raises the Reconnecting event of the OpcClient. |
| OnStateChanged | Raises the StateChanged event of the OpcClient. |
| On | Raises the Subscriptions |
| OnTypeResolve | Raises the TypeResolve event of the OpcClient. |
| ReadEventHistory | |
| Read | |
| ReadNode | Reads the Value attribute of the node specified by nodeId. |
| ReadNodeHistory | Reads the historical values of the node identified by the nodeId specified using the details specified to select the values. |
| Read | |
| Read | |
| Read | |
| ReadNodes | Reads the Value attribute of the nodes specified by nodeIds. |
| ReadNodesHistory | Reads the historical values of the nodes identified by the nodeIds specified using the details specified to select the values. |
| Read | |
| Read | |
| Read | |
| ReadNodeValue | Reads the Value attribute of the node specified. |
| ReadNodeValues | Reads the Value attributes of the nodes specified. |
| RegisterNode | Registers a node for optimized node access using the command specified. |
| RegisterNodes | Registers one or more nodes for optimized node access using the specified commands. |
| Replace | Replaces existing entries of the history of the node as defined by the command specified. |
| Replace | Replaces existing entries of the history of the nodes as defined by the commands specified using a single history update service request. |
| Subscribe | Subscribes data changes on the Value attribute of the node specified by nodeId. |
| SubscribeEvent | Subscribes events on the node specified by nodeId. |
| SubscribeNode | Subscribes the Value attribute of the node specified by nodeId. |
| SubscribeNodes | Creates a OpcSubscription using the OpcMonitoredItem setup defined by the commands specified. |
| TranslatePath | Translates a path starting from the root node using the pathElements specified. |
| TranslatePaths | Translates paths starting from the root node using the pathsElements specified. |
| UnregisterNode | Unregisters a node to not longer optimize its node access using the command specified. |
| UnregisterNodes | Unregisters one or more nodes to not longer optimize their node access using the specified commands. |
| Update | Updates the history of the node as defined by the command specified. |
| Update | Updates the history of the nodes as defined by the commands specified using a single history update service request. |
| WriteNode | Writes one value to one attribute of one node using the specified command. |
| WriteNodes | Writes one or more values to one or more attributes of one or more nodes using the specified commands. |
| WriteNodeValue | Writes the Value attribute of the node using the further specified value. |
| WriteNodeValues | Writes the Value attributes using the nodes and values in the nodeValues specified. |
Events
| Name | Description |
|---|---|
| BreakDetected | Occurs when a connection break has been detected. |
| Certificate | Occurs when the validation of a opponent application instance certificate has already fulfilled the requirements for valid and trusted certificates, but while being connected the server may behave different regarding its initially offered certificate. |
| Connected | Occurs when the OpcClient has successfully established a connection to the server using a new session. |
| Connecting | Occurs when the OpcClient is about to establish a connection to the server. |
| Data | Occurs when a monitored item of one of the Subscriptions of the OpcClient receives a data change notification which is not handled by the monitored item and not handled by its subscription. |
| DialogRequested | Occurs when a monitored item receives an Opc |
| Disconnected | Occurs when the OpcClient has successfully terminated a connection to the server. |
| Disconnecting | Occurs when the OpcClient is about to terminate a connection to the server. |
| EventReceived | Occurs when a monitored item receives an event notification which is not handled by any other Opc |
| Notification | Occurs when a notification message from the server connected to failed to be received, so that its data changes and events do not reach the monitored items. |
| Notification | Occurs when the OpcClient received a notification message form the server connected to. |
| Reconnected | Occurs when the OpcClient has successfully re-established a broken connection to the server using the previously used session. |
| Reconnecting | Occurs when the OpcClient is about to re-establish a broken connection to the server. |
| StateChanged | Occurs when ever the State property has been changed to a different value. |
| Subscriptions | Occurs when a subscription has been added to or removed from the Subscriptions of the OpcClient and when the Subscriptions have been cleared while disconnecting from the server. |
| TypeResolve | Occurs before the resolution of a data type takes place. |