Reference

OpcServer Members

Type

OpcServer

Namespace

Opc.UaFx.Server

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Inherits members from OpcServerBase, OpcApplicationInstance<OpcTransport, OpcServerSecurity>.

Constructors

OpcServer

18 overloads

Overload	Description
OpcServer()	Initializes a new instance of the OpcServer class using the DefaultAddress.
OpcServer(IEnumerable<OpcNodeManager>)	Initializes a new instance of the OpcServer class using the DefaultAddress and the nodeManagers specified to provide its address space.
OpcServer(params OpcNodeManager[])	Initializes a new instance of the OpcServer class using the DefaultAddress and the nodeManagers specified to provide its address space.
OpcServer(Action<OpcAddressSpace>)	Initializes a new instance of the OpcServer class using the DefaultAddress and the createNodes callback specified to create the nodes of its address space.
OpcServer(IEnumerable<IOpcNode>)	Initializes a new instance of the OpcServer class using the DefaultAddress to provide the nodes specified in its address space.
OpcServer(params IOpcNode[])	Initializes a new instance of the OpcServer class using the DefaultAddress to provide the nodes specified in its address space.
OpcServer(string)	Initializes a new instance of the OpcServer class using the address specified.
OpcServer(Uri)	Initializes a new instance of the OpcServer class using the address specified.
OpcServer(string, IEnumerable<OpcNodeManager>)	Initializes a new instance of the OpcServer class using the address specified and the nodeManagers specified to provide its address space.
OpcServer(Uri, IEnumerable<OpcNodeManager>)	Initializes a new instance of the OpcServer class using the address specified and the nodeManagers specified to provide its address space.
OpcServer(string, params OpcNodeManager[])	Initializes a new instance of the OpcServer class using the address specified and the nodeManagers specified to provide its address space.
OpcServer(Uri, params OpcNodeManager[])	Initializes a new instance of the OpcServer class using the address specified and the nodeManagers specified to provide its address space.
OpcServer(string, Action<OpcAddressSpace>)	Initializes a new instance of the OpcServer class using the address specified and the createNodes callback specified to create the nodes of its address space.
OpcServer(Uri, Action<OpcAddressSpace>)	Initializes a new instance of the OpcServer class using the address specified and the createNodes callback specified to create the nodes of its address space.
OpcServer(string, IEnumerable<IOpcNode>)	Initializes a new instance of the OpcServer class using the address specified to provide the nodes specified in its address space.
OpcServer(Uri, IEnumerable<IOpcNode>)	Initializes a new instance of the OpcServer class using the address specified to provide the nodes specified in its address space.
OpcServer(string, params IOpcNode[])	Initializes a new instance of the OpcServer class using the address specified to provide the nodes specified in its address space.
OpcServer(Uri, params IOpcNode[])	Initializes a new instance of the OpcServer class using the address specified to provide the nodes specified in its address space.

OpcServer()

Initializes a new instance of the OpcServer class using the DefaultAddress.

public OpcServer()

Public Sub New()

OpcServer(IEnumerable<OpcNodeManager>)

Initializes a new instance of the OpcServer class using the DefaultAddress and the nodeManagers specified to provide its address space.

public OpcServer(IEnumerable<OpcNodeManager> nodeManagers)

Public Sub New(nodeManagers As IEnumerable(Of OpcNodeManager))

Parameters

Name	Type	Description
nodeManagers	IEnumerable<OpcNodeManager>	A sequence of OpcNodeManager instances which provide the address space of the server. The first node manager is used as the DefaultNodeManager.

Exceptions

Exception	Condition
ArgumentNullException	The nodeManagers sequence or one of its items is a null reference (Nothing in Visual Basic).

OpcServer(params OpcNodeManager[])

Initializes a new instance of the OpcServer class using the DefaultAddress and the nodeManagers specified to provide its address space.

public OpcServer(params OpcNodeManager[] nodeManagers)

Public Sub New(ParamArray nodeManagers As OpcNodeManager())

Parameters

Name	Type	Description
nodeManagers	params OpcNodeManager[]	An array of OpcNodeManager instances which provide the address space of the server. The first node manager is used as the DefaultNodeManager.

Exceptions

Exception	Condition
ArgumentNullException	The nodeManagers array or one of its items is a null reference (Nothing in Visual Basic).

OpcServer(Action<OpcAddressSpace>)

Initializes a new instance of the OpcServer class using the DefaultAddress and the createNodes callback specified to create the nodes of its address space.

public OpcServer(Action<OpcAddressSpace> createNodes)

Public Sub New(createNodes As Action(Of OpcAddressSpace))

Parameters

Name	Type	Description
createNodes	Action<OpcAddressSpace>	The callback which is called with an OpcAddressSpace to create the nodes of the address space of the server.

Exceptions

Exception	Condition
ArgumentNullException	The createNodes is a null reference (Nothing in Visual Basic).

OpcServer(IEnumerable<IOpcNode>)

Initializes a new instance of the OpcServer class using the DefaultAddress to provide the nodes specified in its address space.

public OpcServer(IEnumerable<IOpcNode> nodes)

Public Sub New(nodes As IEnumerable(Of IOpcNode))

Parameters

Name	Type	Description
nodes	IEnumerable<IOpcNode>	A sequence of the nodes to add to the address space of the server.

Exceptions

Exception	Condition
ArgumentNullException	The nodes sequence is a null reference (Nothing in Visual Basic).

Remarks

The constructor does not verify the items of the nodes; a node which is a null reference causes Start to throw an OpcException.

OpcServer(params IOpcNode[])

Initializes a new instance of the OpcServer class using the DefaultAddress to provide the nodes specified in its address space.

public OpcServer(params IOpcNode[] nodes)

Public Sub New(ParamArray nodes As IOpcNode())

Parameters

Name	Type	Description
nodes	params IOpcNode[]	An array of the nodes to add to the address space of the server.

Exceptions

Exception	Condition
ArgumentNullException	The nodes array is a null reference (Nothing in Visual Basic).

Remarks

The constructor does not verify the items of the nodes; a node which is a null reference causes Start to throw an OpcException.

OpcServer(string)

Initializes a new instance of the OpcServer class using the address specified.

public OpcServer(string address)

Public Sub New(address As String)

Parameters

Name	Type	Description
address	String	The string representation of the address of the server which needs to use one of the supported schemes 'opc.tcp' and 'https'.

Exceptions

Exception	Condition
ArgumentException	The address is equals Empty or is not an absolute URI using one of the supported schemes 'opc.tcp' and 'https'.
ArgumentNullException	The address is a null reference (Nothing in Visual Basic).

OpcServer(Uri)

Initializes a new instance of the OpcServer class using the address specified.

public OpcServer(Uri address)

Public Sub New(address As Uri)

Parameters

Name	Type	Description
address	Uri	The Uri of the address of the server which needs to use one of the supported schemes 'opc.tcp' and 'https'.

Exceptions

Exception	Condition
ArgumentException	The address does not use one of the supported schemes 'opc.tcp' and 'https'.
ArgumentNullException	The address is a null reference (Nothing in Visual Basic).

OpcServer(string, IEnumerable<OpcNodeManager>)

Initializes a new instance of the OpcServer class using the address specified and the nodeManagers specified to provide its address space.

public OpcServer(string address, IEnumerable<OpcNodeManager> nodeManagers)

Public Sub New(
    address As String,
    nodeManagers As IEnumerable(Of OpcNodeManager))

Parameters

Name	Type	Description
address	String	The string representation of the address of the server which needs to use one of the supported schemes 'opc.tcp' and 'https'.
nodeManagers	IEnumerable<OpcNodeManager>	A sequence of OpcNodeManager instances which provide the address space of the server. The first node manager is used as the DefaultNodeManager.

Exceptions

Exception	Condition
ArgumentException	The address is equals Empty or is not an absolute URI using one of the supported schemes 'opc.tcp' and 'https'.
ArgumentNullException	The address or nodeManagers sequence or one of its items is a null reference (Nothing in Visual Basic).

OpcServer(Uri, IEnumerable<OpcNodeManager>)

Initializes a new instance of the OpcServer class using the address specified and the nodeManagers specified to provide its address space.

public OpcServer(Uri address, IEnumerable<OpcNodeManager> nodeManagers)

Public Sub New(address As Uri, nodeManagers As IEnumerable(Of OpcNodeManager))

Parameters

Name	Type	Description
address	Uri	The Uri of the address of the server which needs to use one of the supported schemes 'opc.tcp' and 'https'.
nodeManagers	IEnumerable<OpcNodeManager>	A sequence of OpcNodeManager instances which provide the address space of the server. The first node manager is used as the DefaultNodeManager.

Exceptions

Exception	Condition
ArgumentException	The address does not use one of the supported schemes 'opc.tcp' and 'https'.
ArgumentNullException	The address or nodeManagers sequence or one of its items is a null reference (Nothing in Visual Basic).

OpcServer(string, params OpcNodeManager[])

Initializes a new instance of the OpcServer class using the address specified and the nodeManagers specified to provide its address space.

public OpcServer(string address, params OpcNodeManager[] nodeManagers)

Public Sub New(address As String, ParamArray nodeManagers As OpcNodeManager())

Parameters

Name	Type	Description
address	String	The string representation of the address of the server which needs to use one of the supported schemes 'opc.tcp' and 'https'.
nodeManagers	params OpcNodeManager[]	An array of OpcNodeManager instances which provide the address space of the server. The first node manager is used as the DefaultNodeManager.

Exceptions

Exception	Condition
ArgumentException	The address is equals Empty or is not an absolute URI using one of the supported schemes 'opc.tcp' and 'https'.
ArgumentNullException	The address or nodeManagers array or one of its items is a null reference (Nothing in Visual Basic).

OpcServer(Uri, params OpcNodeManager[])

Initializes a new instance of the OpcServer class using the address specified and the nodeManagers specified to provide its address space.

public OpcServer(Uri address, params OpcNodeManager[] nodeManagers)

Public Sub New(address As Uri, ParamArray nodeManagers As OpcNodeManager())

Parameters

Name	Type	Description
address	Uri	The Uri of the address of the server which needs to use one of the supported schemes 'opc.tcp' and 'https'.
nodeManagers	params OpcNodeManager[]	An array of OpcNodeManager instances which provide the address space of the server. The first node manager is used as the DefaultNodeManager.

Exceptions

Exception	Condition
ArgumentException	The address does not use one of the supported schemes 'opc.tcp' and 'https'.
ArgumentNullException	The address or nodeManagers array or one of its items is a null reference (Nothing in Visual Basic).

OpcServer(string, Action<OpcAddressSpace>)

Initializes a new instance of the OpcServer class using the address specified and the createNodes callback specified to create the nodes of its address space.

public OpcServer(string address, Action<OpcAddressSpace> createNodes)

Public Sub New(address As String, createNodes As Action(Of OpcAddressSpace))

Parameters

Name	Type	Description
address	String	The string representation of the address of the server which needs to use one of the supported schemes 'opc.tcp' and 'https'.
createNodes	Action<OpcAddressSpace>	The callback which is called with an OpcAddressSpace to create the nodes of the address space of the server.

Exceptions

Exception	Condition
ArgumentException	The address is equals Empty or is not an absolute URI using one of the supported schemes 'opc.tcp' and 'https'.
ArgumentNullException	The address or createNodes is a null reference (Nothing in Visual Basic).

OpcServer(Uri, Action<OpcAddressSpace>)

Initializes a new instance of the OpcServer class using the address specified and the createNodes callback specified to create the nodes of its address space.

public OpcServer(Uri address, Action<OpcAddressSpace> createNodes)

Public Sub New(address As Uri, createNodes As Action(Of OpcAddressSpace))

Parameters

Name	Type	Description
address	Uri	The Uri of the address of the server which needs to use one of the supported schemes 'opc.tcp' and 'https'.
createNodes	Action<OpcAddressSpace>	The callback which is called with an OpcAddressSpace to create the nodes of the address space of the server.

Exceptions

Exception	Condition
ArgumentException	The address does not use one of the supported schemes 'opc.tcp' and 'https'.
ArgumentNullException	The address or createNodes is a null reference (Nothing in Visual Basic).

OpcServer(string, IEnumerable<IOpcNode>)

Initializes a new instance of the OpcServer class using the address specified to provide the nodes specified in its address space.

public OpcServer(string address, IEnumerable<IOpcNode> nodes)

Public Sub New(address As String, nodes As IEnumerable(Of IOpcNode))

Parameters

Name	Type	Description
address	String	The string representation of the address of the server which needs to use one of the supported schemes 'opc.tcp' and 'https'.
nodes	IEnumerable<IOpcNode>	A sequence of the nodes to add to the address space of the server.

Exceptions

Exception	Condition
ArgumentException	The address is equals Empty or is not an absolute URI using one of the supported schemes 'opc.tcp' and 'https'.
ArgumentNullException	The address or nodes sequence is a null reference (Nothing in Visual Basic).

Remarks

The constructor does not verify the items of the nodes; a node which is a null reference causes Start to throw an OpcException.

OpcServer(Uri, IEnumerable<IOpcNode>)

Initializes a new instance of the OpcServer class using the address specified to provide the nodes specified in its address space.

public OpcServer(Uri address, IEnumerable<IOpcNode> nodes)

Public Sub New(address As Uri, nodes As IEnumerable(Of IOpcNode))

Parameters

Name	Type	Description
address	Uri	The Uri of the address of the server which needs to use one of the supported schemes 'opc.tcp' and 'https'.
nodes	IEnumerable<IOpcNode>	A sequence of the nodes to add to the address space of the server.

Exceptions

Exception	Condition
ArgumentException	The address does not use one of the supported schemes 'opc.tcp' and 'https'.
ArgumentNullException	The address or nodes sequence is a null reference (Nothing in Visual Basic).

Remarks

The constructor does not verify the items of the nodes; a node which is a null reference causes Start to throw an OpcException.

OpcServer(string, params IOpcNode[])

Initializes a new instance of the OpcServer class using the address specified to provide the nodes specified in its address space.

public OpcServer(string address, params IOpcNode[] nodes)

Public Sub New(address As String, ParamArray nodes As IOpcNode())

Parameters

Name	Type	Description
address	String	The string representation of the address of the server which needs to use one of the supported schemes 'opc.tcp' and 'https'.
nodes	params IOpcNode[]	An array of the nodes to add to the address space of the server.

Exceptions

Exception	Condition
ArgumentException	The address is equals Empty or is not an absolute URI using one of the supported schemes 'opc.tcp' and 'https'.
ArgumentNullException	The address or nodes array is a null reference (Nothing in Visual Basic).

Remarks

The constructor does not verify the items of the nodes; a node which is a null reference causes Start to throw an OpcException.

OpcServer(Uri, params IOpcNode[])

Initializes a new instance of the OpcServer class using the address specified to provide the nodes specified in its address space.

public OpcServer(Uri address, params IOpcNode[] nodes)

Public Sub New(address As Uri, ParamArray nodes As IOpcNode())

Parameters

Name	Type	Description
address	Uri	The Uri of the address of the server which needs to use one of the supported schemes 'opc.tcp' and 'https'.
nodes	params IOpcNode[]	An array of the nodes to add to the address space of the server.

Exceptions

Exception	Condition
ArgumentException	The address does not use one of the supported schemes 'opc.tcp' and 'https'.
ArgumentNullException	The address or nodes array is a null reference (Nothing in Visual Basic).

Remarks

The constructor does not verify the items of the nodes; a node which is a null reference causes Start to throw an OpcException.

Fields

DefaultAddress

static

Defines the default address (opc.tcp://localhost:4840) used by the constructors of the OpcServer which do not take an address.

public static readonly Uri DefaultAddress

Public Shared ReadOnly DefaultAddress As Uri

Field value

Uri

Properties

DefaultNodeManager

Gets the node manager used as the default node manager of the OpcServer.

public OpcNodeManager DefaultNodeManager { get; }

Public ReadOnly Property DefaultNodeManager As OpcNodeManager

Property value

OpcNodeManager

The first OpcNodeManager of the NodeManagers. When the server is started without any node manager, a new default node manager is created and added to the NodeManagers. Before the server has been started the value is the first node manager passed to the constructor or a null reference (Nothing in Visual Basic).

Diagnostics

Gets the diagnostic summary information of the OpcServer.

public OpcServerDiagnostics Diagnostics { get; }

Public ReadOnly Property Diagnostics As OpcServerDiagnostics

Property value

OpcServerDiagnostics

An instance of the OpcServerDiagnostics class which provides the diagnostic summary information for the server.

Discovery

since v2.58

Gets the settings the OpcServer uses to make itself known to discovery servers.

public OpcServerDiscovery Discovery { get; }

Public ReadOnly Property Discovery As OpcServerDiscovery

Property value

OpcServerDiscovery

An instance of the OpcServerDiscovery class.

EstimatedReturnTime

since v2.51

Gets or sets a value indicating the time at which the OpcServer is expected to be running.

public DateTime? EstimatedReturnTime { get; set; }

Public Property EstimatedReturnTime As Date?

Property value

Nullable<DateTime>

A DateTime indicating the time at which the OpcServer is expected to be running; MinValue if the estimated return time is unknown or a null reference (Nothing in Visual Basic) if the address space has not yet been created.

Exceptions

Exception	Condition
InvalidOperationException	The State is not equals Started.

Remarks

This time can be used to trigger the client to start its reconnect logic with some delay. Use a null reference (Nothing in Visual Basic) to set MinValue as the new value.

Globalization

since v2.11

Gets the OpcServerGlobalization instance used to control the localization and other globalization related tasks.

public OpcServerGlobalization Globalization { get; }

Public ReadOnly Property Globalization As OpcServerGlobalization

Property value

OpcServerGlobalization

An instance of the OpcServerGlobalization class used by the current OpcServer to perform localization tasks.

NodeManagers

Gets the node managers which provide the address space of the OpcServer.

public OpcNodeManagerCollection NodeManagers { get; }

Public ReadOnly Property NodeManagers As OpcNodeManagerCollection

Property value

OpcNodeManagerCollection

An OpcNodeManagerCollection of the OpcNodeManager instances used by the server.

OperationLimits

since v2.50

Gets the OpcOperationLimits instance used to maintain the different operation limits used by the server.

public OpcOperationLimits OperationLimits { get; }

Public ReadOnly Property OperationLimits As OpcOperationLimits

Property value

OpcOperationLimits

An instance of the OpcOperationLimits class used by the application instance to setup and maintain the different operation limits.

SystemContext

override

Gets the OpcContext which is used to store the context sensitive data and configuration used by the current OpcServer instance.

public override OpcContext SystemContext { get; }

Public Overrides ReadOnly Property SystemContext As OpcContext

Property value

OpcContext

An instance of the OpcContext class which might be at least Empty.

Overrides

SystemContext

UseDynamic

since v2.53

Gets or sets a value indicating whether the current OpcServer shall use generic types to represent dynamically defined custom types.

public bool UseDynamic { get; set; }

Public Property UseDynamic As Boolean

Property value

Boolean

The value true if the current OpcServer shall use generic types constructed from the type information offered dynamically; otherwise the value false. The default value is determined by the UseDynamic property.

Methods

CreateConfiguration

protected · override

Creates the configuration of the OpcServer based on the configuration created by the base class. The user token policies of the configuration reflect the access control lists of the Security settings and the transport quotas reflect the Transport settings.

[CLSCompliant(false)]
protected override OpcApplicationConfiguration CreateConfiguration()

<CLSCompliant(False)>
Protected Overrides Function CreateConfiguration() As OpcApplicationConfiguration

Returns

OpcApplicationConfiguration

A new instance of the OpcApplicationConfiguration class.

Overrides

CreateConfiguration

CreateOperationLimits

protected · since v2.50

Creates and initializes a new instance of the OpcOperationLimits which is used for the OperationLimits property.

protected OpcOperationLimits CreateOperationLimits()

Protected Function CreateOperationLimits() As OpcOperationLimits

Returns

OpcOperationLimits

A new instance of the type specified by OpcOperationLimits.

GetDataType

6 overloads · since v2.22

Overload	Description
GetDataType(string)since v2.22	Retrieves the OpcDataTypeInfo object which is known under the name specified.
GetDataType(OpcName)since v2.22	Retrieves the OpcDataTypeInfo object which is known under the name specified.
GetDataType(OpcNodeId)since v2.22	Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified.
GetDataType(Type)since v2.22	Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified.
GetDataType(OpcEncoding)since v2.22	Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified.
GetDataType(XmlQualifiedName)since v2.22	Retrieves the OpcDataTypeInfo object which is known under the xmlName specified.

Exceptions (all overloads)

Exception	Condition
ObjectDisposedException	The object has been disposed of.

GetDataType(string)

since v2.22

Retrieves the OpcDataTypeInfo object which is known under the name specified.

public OpcDataTypeInfo GetDataType(string name)

Public Function GetDataType(name As String) As OpcDataTypeInfo

Parameters

Name	Type	Description
name	String	The string to use to identify the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its Name is equals (regarding its Value) to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentException	The name is equals Empty.
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetDataType(OpcName)

since v2.22

Retrieves the OpcDataTypeInfo object which is known under the name specified.

public OpcDataTypeInfo GetDataType(OpcName name)

Public Function GetDataType(name As OpcName) As OpcDataTypeInfo

Parameters

Name	Type	Description
name	OpcName	The OpcName of the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetDataType(OpcNodeId)

since v2.22

Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified.

public OpcDataTypeInfo GetDataType(OpcNodeId typeId)

Public Function GetDataType(typeId As OpcNodeId) As OpcDataTypeInfo

Parameters

Name	Type	Description
typeId	OpcNodeId	The OpcNodeId which identifies the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object which is known under the typeId specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeInfo object which is associated with the typeId specified.

Exceptions

Exception	Condition
ArgumentNullException	The typeId is a null reference (Nothing in Visual Basic).

GetDataType(Type)

since v2.22

Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified.

public OpcDataTypeInfo GetDataType(Type underlyingType)

Public Function GetDataType(underlyingType As Type) As OpcDataTypeInfo

Parameters

Name	Type	Description
underlyingType	Type	The Type which implements the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object which declares the underlyingType specified or a null reference (Nothing in Visual Basic) if there isn't a OpcDataTypeInfo object associated with the underlyingType specified.

Exceptions

Exception	Condition
ArgumentNullException	The underlyingType is a null reference (Nothing in Visual Basic).

GetDataType(OpcEncoding)

since v2.22

Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified.

public OpcDataTypeInfo GetDataType(OpcEncoding encoding)

Public Function GetDataType(encoding As OpcEncoding) As OpcDataTypeInfo

Parameters

Name	Type	Description
encoding	OpcEncoding	The OpcEncoding which identifies the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object which is known under the encoding specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeInfo which is associated with the encoding specified.

Exceptions

Exception	Condition
ArgumentNullException	The encoding is a null reference (Nothing in Visual Basic).

GetDataType(XmlQualifiedName)

since v2.22

Retrieves the OpcDataTypeInfo object which is known under the xmlName specified.

public OpcDataTypeInfo GetDataType(XmlQualifiedName xmlName)

Public Function GetDataType(xmlName As XmlQualifiedName) As OpcDataTypeInfo

Parameters

Name	Type	Description
xmlName	XmlQualifiedName	The XmlQualifiedName of the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its XmlName is equals to the xmlName specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	The xmlName is a null reference (Nothing in Visual Basic).

GetDataTypes

since v2.22

Retrieves all OpcDataTypeInfo objects offered by the IOpcTypeProvider.

public OpcDataTypeInfo[] GetDataTypes()

Public Function GetDataTypes() As OpcDataTypeInfo()

Returns

OpcDataTypeInfo[]

An array that contains all OpcDataTypeInfo objects that are offered by the IOpcTypeProvider.

Exceptions

Exception	Condition
ObjectDisposedException	The object has been disposed of.

GetDataTypeSystems

since v2.22

Retrieves the systems used to describe the data exchanged via OPC UA.

public OpcDataTypeSystem[] GetDataTypeSystems()

Public Function GetDataTypeSystems() As OpcDataTypeSystem()

Returns

OpcDataTypeSystem[]

An instance of the OpcDataTypeSystem class which can be used to understand the structure of the data exchanged using a specific type of encoding (see OpcEncodingType).

Exceptions

Exception	Condition
InvalidOperationException	The requested operation is currently not supported.
LicenseException	The license is expired.
ObjectDisposedException	The object has been disposed of.

GetEndpoints

Retrieves the endpoints provided by the OpcServer.

public IEnumerable<OpcEndpointDescription> GetEndpoints()

Public Function GetEndpoints() As IEnumerable(Of OpcEndpointDescription)

Returns

IEnumerable<OpcEndpointDescription>

A sequence of OpcEndpointDescription instances describing the endpoints of the server.

Exceptions

Exception	Condition
InvalidOperationException	The server has not yet been started.
LicenseException	The license is expired.
OpcException	The endpoints could not be retrieved; for more details see exception details.
ObjectDisposedException	The object has been disposed of.

GetNodeType

4 overloads · since v2.50

Overload	Description
GetNodeType(string)since v2.50	Retrieves the OpcNodeTypeInfo object which is known under the name specified.
GetNodeType(OpcName)since v2.50	Retrieves the OpcNodeTypeInfo object which is known under the name specified.
GetNodeType(OpcNodeId)since v2.50	Retrieves the OpcNodeTypeInfo object which declares the type which is identified by the typeId specified.
GetNodeType(Type)since v2.50	Retrieves the OpcNodeTypeInfo object which declares the type implemented by the underlyingType specified.

Exceptions (all overloads)

Exception	Condition
ObjectDisposedException	The object has been disposed of.

GetNodeType(string)

since v2.50

Retrieves the OpcNodeTypeInfo object which is known under the name specified.

public OpcNodeTypeInfo GetNodeType(string name)

Public Function GetNodeType(name As String) As OpcNodeTypeInfo

Parameters

Name	Type	Description
name	String	The string to use to identify the OpcNodeTypeInfo object to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object its Name is equals (regarding its Value) to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentException	The name is equals Empty.
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetNodeType(OpcName)

since v2.50

Retrieves the OpcNodeTypeInfo object which is known under the name specified.

public OpcNodeTypeInfo GetNodeType(OpcName name)

Public Function GetNodeType(name As OpcName) As OpcNodeTypeInfo

Parameters

Name	Type	Description
name	OpcName	The OpcName of the OpcNodeTypeInfo object to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetNodeType(OpcNodeId)

since v2.50

Retrieves the OpcNodeTypeInfo object which declares the type which is identified by the typeId specified.

public OpcNodeTypeInfo GetNodeType(OpcNodeId typeId)

Public Function GetNodeType(typeId As OpcNodeId) As OpcNodeTypeInfo

Parameters

Name	Type	Description
typeId	OpcNodeId	The OpcNodeId which identifies the OpcNodeTypeInfo to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object which is known under the typeId specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcNodeTypeInfo object which is associated with the typeId specified.

Exceptions

Exception	Condition
ArgumentNullException	The typeId is a null reference (Nothing in Visual Basic).

GetNodeType(Type)

since v2.50

Retrieves the OpcNodeTypeInfo object which declares the type implemented by the underlyingType specified.

public OpcNodeTypeInfo GetNodeType(Type underlyingType)

Public Function GetNodeType(underlyingType As Type) As OpcNodeTypeInfo

Parameters

Name	Type	Description
underlyingType	Type	The Type which implements the OpcNodeTypeInfo to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object which declares the underlyingType specified or a null reference (Nothing in Visual Basic) if there isn't a OpcNodeTypeInfo object associated with the underlyingType specified.

Exceptions

Exception	Condition
ArgumentNullException	The underlyingType is a null reference (Nothing in Visual Basic).

GetNodeTypes

since v2.50

Retrieves all OpcNodeTypeInfo objects offered by the IOpcTypeProvider.

public OpcNodeTypeInfo[] GetNodeTypes()

Public Function GetNodeTypes() As OpcNodeTypeInfo()

Returns

OpcNodeTypeInfo[]

An array that contains all OpcNodeTypeInfo objects that are offered by the IOpcTypeProvider.

Exceptions

Exception	Condition
ObjectDisposedException	The object has been disposed of.

GetNodeTypeSystem

since v2.50

Retrieves the system used to describe the structural organisation via OPC UA.

public OpcNodeTypeSystem GetNodeTypeSystem()

Public Function GetNodeTypeSystem() As OpcNodeTypeSystem

Returns

OpcNodeTypeSystem

An instance of the OpcNodeTypeSystem class which can be used to understand the structural organisation of the nodes provided.

Exceptions

Exception	Condition
LicenseException	The license is expired.
ObjectDisposedException	The object has been disposed of.

GetSession

since v2.11

Retrieves the OpcSession associated with the sessionId specified.

public OpcSession GetSession(OpcNodeId sessionId)

Public Function GetSession(sessionId As OpcNodeId) As OpcSession

Parameters

Name	Type	Description
sessionId	OpcNodeId	The OpcNodeId which uniquely identifies the session requested within the created sessions on the current OpcServer.

Returns

OpcSession

Exceptions

Exception	Condition
ArgumentNullException	The sessionId is a null reference (Nothing in Visual Basic).
InvalidOperationException	The server has not yet been started.
ObjectDisposedException	The object has been disposed of.

GetSessions

Retrieves all currently known sessions created on the current OpcServer.

public IEnumerable<OpcSession> GetSessions()

Public Function GetSessions() As IEnumerable(Of OpcSession)

Returns

IEnumerable<OpcSession>

A sequence of OpcSession instances.

Exceptions

Exception	Condition
InvalidOperationException	The server has not yet been started.
LicenseException	The license is expired.
ObjectDisposedException	The object has been disposed of.

GetSubscriptions

since v2.50

Retrieves all currently known subscriptions created on the current OpcServer.

public IEnumerable<OpcSubscription> GetSubscriptions()

Public Function GetSubscriptions() As IEnumerable(Of OpcSubscription)

Returns

IEnumerable<OpcSubscription>

A sequence of OpcSubscription instances.

Exceptions

Exception	Condition
InvalidOperationException	The server has not yet been started.
LicenseException	The license is expired.
OpcException	The subscriptions could not be retrieved; for more details see exception details.
ObjectDisposedException	The object has been disposed of.

Remarks

The sequence returned is evaluated deferred: the state of the server is verified and the exceptions documented are thrown not before the sequence is enumerated.

OnCertificateChanged

protected · virtual · since v2.53

Raises the CertificateChanged event of the OpcServer.

protected virtual void OnCertificateChanged(OpcCertificateChangedEventArgs e)

Protected Overridable Sub OnCertificateChanged(
    e As OpcCertificateChangedEventArgs)

Parameters

Name	Type	Description
e	OpcCertificateChangedEventArgs	The event data.

OnRequestJudgement

protected · virtual · since v2.19

Raises the RequestJudgement event of the OpcServer.

protected virtual void OnRequestJudgement(OpcRequestJudgementEventArgs e)

Protected Overridable Sub OnRequestJudgement(e As OpcRequestJudgementEventArgs)

Parameters

Name	Type	Description
e	OpcRequestJudgementEventArgs	The event data.

OnRequestProcessed

protected · virtual · since v2.7

Raises the RequestProcessed event of the OpcServer.

protected virtual void OnRequestProcessed(OpcRequestProcessedEventArgs e)

Protected Overridable Sub OnRequestProcessed(e As OpcRequestProcessedEventArgs)

Parameters

Name	Type	Description
e	OpcRequestProcessedEventArgs	The event data.

OnRequestProcessing

protected · virtual · since v2.7

Raises the RequestProcessing event of the OpcServer.

protected virtual void OnRequestProcessing(OpcRequestProcessingEventArgs e)

Protected Overridable Sub OnRequestProcessing(
    e As OpcRequestProcessingEventArgs)

Parameters

Name	Type	Description
e	OpcRequestProcessingEventArgs	The event data.

OnRequestValidated

protected · virtual · since v2.7

Raises the RequestValidated event of the OpcServer.

protected virtual void OnRequestValidated(OpcRequestValidatedEventArgs e)

Protected Overridable Sub OnRequestValidated(e As OpcRequestValidatedEventArgs)

Parameters

Name	Type	Description
e	OpcRequestValidatedEventArgs	The event data.

OnRequestValidating

protected · virtual · since v2.7

Raises the RequestValidating event of the OpcServer.

protected virtual void OnRequestValidating(OpcRequestValidatingEventArgs e)

Protected Overridable Sub OnRequestValidating(
    e As OpcRequestValidatingEventArgs)

Parameters

Name	Type	Description
e	OpcRequestValidatingEventArgs	The event data.

OnSessionActivated

protected · virtual

Raises the SessionActivated event of the OpcServer.

protected virtual void OnSessionActivated(OpcSessionEventArgs e)

Protected Overridable Sub OnSessionActivated(e As OpcSessionEventArgs)

Parameters

Name	Type	Description
e	OpcSessionEventArgs	The event data.

OnSessionActivating

protected · virtual

Raises the SessionActivating event of the OpcServer.

protected virtual void OnSessionActivating(EventArgs e)

Protected Overridable Sub OnSessionActivating(e As EventArgs)

Parameters

Name	Type	Description
e	EventArgs	The event data.

OnSessionActivationFailed

protected · virtual · since v2.58

Raises the SessionActivationFailed event.

protected virtual void OnSessionActivationFailed(
    OpcSessionActivationFailedEventArgs e)

Protected Overridable Sub OnSessionActivationFailed(
    e As OpcSessionActivationFailedEventArgs)

Parameters

Name	Type	Description
e	OpcSessionActivationFailedEventArgs	The data describing the rejected activation.

OnSessionClosed

protected · virtual

Raises the SessionClosed event of the OpcServer.

protected virtual void OnSessionClosed(EventArgs e)

Protected Overridable Sub OnSessionClosed(e As EventArgs)

Parameters

Name	Type	Description
e	EventArgs	The event data.

OnSessionClosing

protected · virtual

Raises the SessionClosing event of the OpcServer.

protected virtual void OnSessionClosing(OpcSessionEventArgs e)

Protected Overridable Sub OnSessionClosing(e As OpcSessionEventArgs)

Parameters

Name	Type	Description
e	OpcSessionEventArgs	The event data.

OnSessionCreated

protected · virtual

Raises the SessionCreated event of the OpcServer.

protected virtual void OnSessionCreated(OpcSessionEventArgs e)

Protected Overridable Sub OnSessionCreated(e As OpcSessionEventArgs)

Parameters

Name	Type	Description
e	OpcSessionEventArgs	The event data.

OnSessionCreating

protected · virtual

Raises the SessionCreating event of the OpcServer.

protected virtual void OnSessionCreating(EventArgs e)

Protected Overridable Sub OnSessionCreating(e As EventArgs)

Parameters

Name	Type	Description
e	EventArgs	The event data.

OnSubscriptionCreated

protected · virtual

Raises the SubscriptionCreated event of the OpcServer.

protected virtual void OnSubscriptionCreated(OpcSubscriptionEventArgs e)

Protected Overridable Sub OnSubscriptionCreated(e As OpcSubscriptionEventArgs)

Parameters

Name	Type	Description
e	OpcSubscriptionEventArgs	The event data.

OnSubscriptionDeleted

protected · virtual

Raises the SubscriptionDeleted event of the OpcServer.

protected virtual void OnSubscriptionDeleted(OpcSubscriptionEventArgs e)

Protected Overridable Sub OnSubscriptionDeleted(e As OpcSubscriptionEventArgs)

Parameters

Name	Type	Description
e	OpcSubscriptionEventArgs	The event data.

OnTypeResolve

protected · virtual · since v2.53

Raises the TypeResolve event of the OpcServer.

protected virtual void OnTypeResolve(OpcTypeResolveEventArgs e)

Protected Overridable Sub OnTypeResolve(e As OpcTypeResolveEventArgs)

Parameters

Name	Type	Description
e	OpcTypeResolveEventArgs	The event data.

RegisterNamespace

3 overloads · since v2.50

Overload	Description
RegisterNamespace(string)since v2.50	Registers the namespaceUri specified in the namespace table of the OpcServer unless it is already registered.
RegisterNamespace(Uri)since v2.50	Registers the namespaceUri specified in the namespace table of the OpcServer unless it is already registered.
RegisterNamespace(OpcNamespace)since v2.50	Registers the URI of the namespace specified in the namespace table of the OpcServer unless it is already registered.

RegisterNamespace(string)

since v2.50

Registers the namespaceUri specified in the namespace table of the OpcServer unless it is already registered.

public OpcNamespace RegisterNamespace(string namespaceUri)

Public Function RegisterNamespace(namespaceUri As String) As OpcNamespace

Parameters

Name	Type	Description
namespaceUri	String	The URI of the namespace to register.

Returns

OpcNamespace

An OpcNamespace which refers to the namespaceUri and its index in the namespace table of the server.

Exceptions

Exception	Condition
ArgumentException	The namespaceUri is equals Empty.
ArgumentNullException	The namespaceUri is a null reference (Nothing in Visual Basic).

RegisterNamespace(Uri)

since v2.50

Registers the namespaceUri specified in the namespace table of the OpcServer unless it is already registered.

public OpcNamespace RegisterNamespace(Uri namespaceUri)

Public Function RegisterNamespace(namespaceUri As Uri) As OpcNamespace

Parameters

Name	Type	Description
namespaceUri	Uri	The Uri of the namespace to register.

Returns

OpcNamespace

An OpcNamespace which refers to the namespaceUri and its index in the namespace table of the server.

Exceptions

Exception	Condition
FormatException	The namespaceUri is not a valid namespace (see Create).
ArgumentNullException	The namespaceUri is a null reference (Nothing in Visual Basic).

Remarks

The namespaceUri is registered in the namespace table before it is verified to be a valid namespace; therefore it remains registered in case there a FormatException is thrown.

RegisterNamespace(OpcNamespace)

since v2.50

Registers the URI of the namespace specified in the namespace table of the OpcServer unless it is already registered.

public OpcNamespace RegisterNamespace(OpcNamespace @namespace)

Public Function RegisterNamespace([namespace] As OpcNamespace) As OpcNamespace

Parameters

Name	Type	Description
namespace	OpcNamespace	The OpcNamespace to register.

Returns

OpcNamespace

An OpcNamespace which refers to the URI of the namespace and its index in the namespace table of the server. This is either the namespace specified or a new instance.

Exceptions

Exception	Condition
ArgumentNullException	The namespace is a null reference (Nothing in Visual Basic).

RegisterNamespaces

6 overloads · since v2.50

Overload	Description
RegisterNamespaces(IEnumerable<string>)since v2.50	Registers each of the namespaces specified by the namespaceUris in the namespace table of the OpcServer unless it is already registered.
RegisterNamespaces(IEnumerable<Uri>)since v2.50	Registers each of the namespaces specified by the namespaceUris in the namespace table of the OpcServer unless it is already registered.
RegisterNamespaces(IEnumerable<OpcNamespace>)since v2.50	Registers each of the namespaces specified by the namespaces in the namespace table of the OpcServer unless it is already registered.
RegisterNamespaces(params string[])since v2.50	Registers each of the namespaces specified by the namespaceUris in the namespace table of the OpcServer unless it is already registered.
RegisterNamespaces(params Uri[])since v2.50	Registers each of the namespaces specified by the namespaceUris in the namespace table of the OpcServer unless it is already registered.
RegisterNamespaces(params OpcNamespace[])since v2.50	Registers each of the namespaces specified by the namespaces in the namespace table of the OpcServer unless it is already registered.

RegisterNamespaces(IEnumerable<string>)

since v2.50

Registers each of the namespaces specified by the namespaceUris in the namespace table of the OpcServer unless it is already registered.

public OpcNamespace[] RegisterNamespaces(IEnumerable<string> namespaceUris)

Public Function RegisterNamespaces(
    namespaceUris As IEnumerable(Of String)) As OpcNamespace()

Parameters

Name	Type	Description
namespaceUris	IEnumerable<String>	A sequence of the URIs of the namespaces to register.

Returns

OpcNamespace[]

An array of the OpcNamespace instances which refer to the namespaces registered and their index in the namespace table of the server, in the order of the namespaceUris.

Exceptions

Exception	Condition
ArgumentException	One of the items of the namespaceUris is equals Empty.
ArgumentNullException	The namespaceUris sequence or one of its items is a null reference (Nothing in Visual Basic).

RegisterNamespaces(IEnumerable<Uri>)

since v2.50

Registers each of the namespaces specified by the namespaceUris in the namespace table of the OpcServer unless it is already registered.

public OpcNamespace[] RegisterNamespaces(IEnumerable<Uri> namespaceUris)

Public Function RegisterNamespaces(
    namespaceUris As IEnumerable(Of Uri)) As OpcNamespace()

Parameters

Name	Type	Description
namespaceUris	IEnumerable<Uri>	A sequence of the Uri instances of the namespaces to register.

Returns

OpcNamespace[]

An array of the OpcNamespace instances which refer to the namespaces registered and their index in the namespace table of the server, in the order of the namespaceUris.

Exceptions

Exception	Condition
FormatException	One of the items of the namespaceUris is not a valid namespace (see Create).
ArgumentNullException	The namespaceUris sequence or one of its items is a null reference (Nothing in Visual Basic).

RegisterNamespaces(IEnumerable<OpcNamespace>)

since v2.50

Registers each of the namespaces specified by the namespaces in the namespace table of the OpcServer unless it is already registered.

public OpcNamespace[] RegisterNamespaces(IEnumerable<OpcNamespace> namespaces)

Public Function RegisterNamespaces(
    namespaces As IEnumerable(Of OpcNamespace)) As OpcNamespace()

Parameters

Name	Type	Description
namespaces	IEnumerable<OpcNamespace>	A sequence of the OpcNamespace instances to register.

Returns

OpcNamespace[]

An array of the OpcNamespace instances which refer to the namespaces registered and their index in the namespace table of the server, in the order of the namespaces.

Exceptions

Exception	Condition
ArgumentNullException	The namespaces sequence or one of its items is a null reference (Nothing in Visual Basic).

RegisterNamespaces(params string[])

since v2.50

Registers each of the namespaces specified by the namespaceUris in the namespace table of the OpcServer unless it is already registered.

public OpcNamespace[] RegisterNamespaces(params string[] namespaceUris)

Public Function RegisterNamespaces(
    ParamArray namespaceUris As String()) As OpcNamespace()

Parameters

Name	Type	Description
namespaceUris	params String[]	An array of the URIs of the namespaces to register.

Returns

OpcNamespace[]

An array of the OpcNamespace instances which refer to the namespaces registered and their index in the namespace table of the server, in the order of the namespaceUris.

Exceptions

Exception	Condition
ArgumentException	One of the items of the namespaceUris is equals Empty.
ArgumentNullException	The namespaceUris array or one of its items is a null reference (Nothing in Visual Basic).

RegisterNamespaces(params Uri[])

since v2.50

Registers each of the namespaces specified by the namespaceUris in the namespace table of the OpcServer unless it is already registered.

public OpcNamespace[] RegisterNamespaces(params Uri[] namespaceUris)

Public Function RegisterNamespaces(
    ParamArray namespaceUris As Uri()) As OpcNamespace()

Parameters

Name	Type	Description
namespaceUris	params Uri[]	An array of the Uri instances of the namespaces to register.

Returns

OpcNamespace[]

An array of the OpcNamespace instances which refer to the namespaces registered and their index in the namespace table of the server, in the order of the namespaceUris.

Exceptions

Exception	Condition
FormatException	One of the items of the namespaceUris is not a valid namespace (see Create).
ArgumentNullException	The namespaceUris array or one of its items is a null reference (Nothing in Visual Basic).

RegisterNamespaces(params OpcNamespace[])

since v2.50

Registers each of the namespaces specified by the namespaces in the namespace table of the OpcServer unless it is already registered.

public OpcNamespace[] RegisterNamespaces(params OpcNamespace[] namespaces)

Public Function RegisterNamespaces(
    ParamArray namespaces As OpcNamespace()) As OpcNamespace()

Parameters

Name	Type	Description
namespaces	params OpcNamespace[]	An array of the OpcNamespace instances to register.

Returns

OpcNamespace[]

An array of the OpcNamespace instances which refer to the namespaces registered and their index in the namespace table of the server, in the order of the namespaces.

Exceptions

Exception	Condition
ArgumentNullException	The namespaces array or one of its items is a null reference (Nothing in Visual Basic).

ReportEvent

7 overloads

Overload	Description
ReportEvent(OpcEventNode)	Produces a global event using the eventNode specified.
ReportEvent(OpcEventSeverity, OpcText)	Produces a global event using the event data specified.
ReportEvent(OpcEventSeverity, OpcText, params object[])	Produces a global event using the event data specified.
ReportEvent(OpcNodeId, string, OpcEventSeverity, OpcText)	Produces a global event using the event data specified.
ReportEvent(OpcNodeId, string, OpcEventSeverity, OpcText, params object[])	Produces a global event using the event data specified.
ReportEvent(IOpcNode, OpcEventSeverity, OpcText)	Produces a global event using the event data specified.
ReportEvent(IOpcNode, OpcEventSeverity, OpcText, params object[])	Produces a global event using the event data specified.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The State is not equals Started.
LicenseException	The license is expired.
ObjectDisposedException	The object has been disposed of.
OpcException	The operation failed (see exception details for more information).

ReportEvent(OpcEventNode)

Produces a global event using the eventNode specified.

public void ReportEvent(OpcEventNode eventNode)

Public Sub ReportEvent(eventNode As OpcEventNode)

Parameters

Name	Type	Description
eventNode	OpcEventNode	The OpcEventNode its event information is to be reported as a global event.

Exceptions

Exception	Condition
ArgumentNullException	The eventNode is a null reference (Nothing in Visual Basic).

ReportEvent(OpcEventSeverity, OpcText)

Produces a global event using the event data specified.

public void ReportEvent(OpcEventSeverity severity, OpcText message)

Public Sub ReportEvent(severity As OpcEventSeverity, message As OpcText)

Parameters

Name	Type	Description
severity	OpcEventSeverity	An indication of the urgency of the event.
message	OpcText	A human-readable and localizable text description of the event.

Exceptions

Exception	Condition
ArgumentNullException	The message is a null reference (Nothing in Visual Basic).

ReportEvent(OpcEventSeverity, OpcText, params object[])

Produces a global event using the event data specified.

public void ReportEvent(
    OpcEventSeverity severity,
    OpcText message,
    params object[] arguments)

Public Sub ReportEvent(
    severity As OpcEventSeverity,
    message As OpcText,
    ParamArray arguments As Object())

Parameters

Name	Type	Description
severity	OpcEventSeverity	An indication of the urgency of the event.
message	OpcText	A human-readable and localizable text description of the event with format placeholders which where replaced with the arguments specified.
arguments	params Object[]	The values to place into the message using its format placeholders.

Exceptions

Exception	Condition
ArgumentNullException	The message is a null reference (Nothing in Visual Basic).

ReportEvent(OpcNodeId, string, OpcEventSeverity, OpcText)

Produces a global event using the event data specified.

public void ReportEvent(
    OpcNodeId sourceNodeId,
    string sourceName,
    OpcEventSeverity severity,
    OpcText message)

Public Sub ReportEvent(
    sourceNodeId As OpcNodeId,
    sourceName As String,
    severity As OpcEventSeverity,
    message As OpcText)

Parameters

Name	Type	Description
sourceNodeId	OpcNodeId	The OpcNodeId which is to be used for the SourceNodeId property to define the origin of the event produced.
sourceName	String	The string which is to be used for the SourceName.
severity	OpcEventSeverity	An indication of the urgency of the event.
message	OpcText	A human-readable and localizable text description of the event.

Exceptions

Exception	Condition
ArgumentNullException	The message is a null reference (Nothing in Visual Basic).

ReportEvent(OpcNodeId, string, OpcEventSeverity, OpcText, params object[])

Produces a global event using the event data specified.

public void ReportEvent(
    OpcNodeId sourceNodeId,
    string sourceName,
    OpcEventSeverity severity,
    OpcText message,
    params object[] arguments)

Public Sub ReportEvent(
    sourceNodeId As OpcNodeId,
    sourceName As String,
    severity As OpcEventSeverity,
    message As OpcText,
    ParamArray arguments As Object())

Parameters

Name	Type	Description
sourceNodeId	OpcNodeId	The OpcNodeId which is to be used for the SourceNodeId property to define the origin of the event produced.
sourceName	String	The string which is to be used for the SourceName.
severity	OpcEventSeverity	An indication of the urgency of the event.
message	OpcText	A human-readable and localizable text description of the event with format placeholders which where replaced with the arguments specified.
arguments	params Object[]	The values to place into the message using its format placeholders.

Exceptions

Exception	Condition
ArgumentNullException	The message is a null reference (Nothing in Visual Basic).

ReportEvent(IOpcNode, OpcEventSeverity, OpcText)

Produces a global event using the event data specified.

public void ReportEvent(
    IOpcNode source,
    OpcEventSeverity severity,
    OpcText message)

Public Sub ReportEvent(
    source As IOpcNode,
    severity As OpcEventSeverity,
    message As OpcText)

Parameters

Name	Type	Description
source	IOpcNode	The IOpcNode instance its Id is used for the SourceNodeId property and its SymbolicName is used for the SourceName property to define the origin of the event produced.
severity	OpcEventSeverity	An indication of the urgency of the event.
message	OpcText	A human-readable and localizable text description of the event.

Exceptions

Exception	Condition
ArgumentNullException	The source or message is a null reference (Nothing in Visual Basic).

ReportEvent(IOpcNode, OpcEventSeverity, OpcText, params object[])

Produces a global event using the event data specified.

public void ReportEvent(
    IOpcNode source,
    OpcEventSeverity severity,
    OpcText message,
    params object[] arguments)

Public Sub ReportEvent(
    source As IOpcNode,
    severity As OpcEventSeverity,
    message As OpcText,
    ParamArray arguments As Object())

Parameters

Name	Type	Description
source	IOpcNode	The IOpcNode instance its Id is used for the SourceNodeId property and its SymbolicName is used for the SourceName property to define the origin of the event produced.
severity	OpcEventSeverity	An indication of the urgency of the event.
message	OpcText	A human-readable and localizable text description of the event with format placeholders which where replaced with the arguments specified.
arguments	params Object[]	The values to place into the message using its format placeholders.

Exceptions

Exception	Condition
ArgumentNullException	The source or message is a null reference (Nothing in Visual Basic).

ResumeCore

protected · override · since v2.11

Resumes the suspended server by setting the state of its underlying server instance to running.

protected override void ResumeCore()

Protected Overrides Sub ResumeCore()

Overrides

ResumeCore

StartCore

protected · override

Starts the server using the configuration specified. Before the server is started, the first node manager of the NodeManagers becomes the DefaultNodeManager; if there is no node manager a new default node manager is created and added to the NodeManagers.

[CLSCompliant(false)]
protected override void StartCore(OpcApplicationConfiguration configuration)

<CLSCompliant(False)>
Protected Overrides Sub StartCore(configuration As OpcApplicationConfiguration)

Parameters

Name	Type	Description
configuration	OpcApplicationConfiguration	The OpcApplicationConfiguration to use to start the server.

Exceptions

Exception	Condition
ArgumentNullException	The configuration is a null reference (Nothing in Visual Basic).

Overrides

StartCore

StopCore

protected · override

Stops the server.

protected override void StopCore()

Protected Overrides Sub StopCore()

Overrides

StopCore

SuspendCore

protected · override · since v2.11

Suspends the server by setting the state of its underlying server instance to suspended.

protected override void SuspendCore()

Protected Overrides Sub SuspendCore()

Overrides

SuspendCore

Events

CertificateChanged

since v2.53

Occurs when a new certificate has been assigned to the OpcServer through a OpcSession using an identity which is in the role SecurityAdmin.

public event OpcCertificateChangedEventHandler CertificateChanged

Public Event CertificateChanged As OpcCertificateChangedEventHandler

Event type

OpcCertificateChangedEventHandler

RequestJudgement

since v2.19

Occurs when the validation of a request does not fulfill the requirements for a valid request.

public event OpcRequestJudgementEventHandler RequestJudgement

Public Event RequestJudgement As OpcRequestJudgementEventHandler

Event type

OpcRequestJudgementEventHandler

Remarks

This event can be used to substitute the default judgement of such potential suspect situations which would otherwise throw an exception and reject a request.

RequestProcessed

since v2.7

Occurs after the server processed a request, whether it succeeded or failed.

public event OpcRequestProcessedEventHandler RequestProcessed

Public Event RequestProcessed As OpcRequestProcessedEventHandler

Event type

OpcRequestProcessedEventHandler

Remarks

The request and the response are of the type of the service, such as OpcReadNodesRequest and OpcReadNodesResponse, for the services on nodes and on their history. For other services, such as those of sessions and discovery, they are only described by the RequestType.

A failed request states its error in the Exception.

RequestProcessing

since v2.7

Occurs as soon as the server received a request, before it checks the session and the user and before it decodes the request into the type of its service.

public event OpcRequestProcessingEventHandler RequestProcessing

Public Event RequestProcessing As OpcRequestProcessingEventHandler

Event type

OpcRequestProcessingEventHandler

Remarks

The Request therefore only carries the request header. To inspect the content of a request or to reject it, use the RequestValidating event instead.

RequestValidated

since v2.7

Occurs after a request passed the validation, including the RequestValidating event, and right before the server processes it.

public event OpcRequestValidatedEventHandler RequestValidated

Public Event RequestValidated As OpcRequestValidatedEventHandler

Event type

OpcRequestValidatedEventHandler

RequestValidating

since v2.7

Occurs after the server checked the session and the user of a request and before it processes the request.

public event OpcRequestValidatingEventHandler RequestValidating

Public Event RequestValidating As OpcRequestValidatingEventHandler

Event type

OpcRequestValidatingEventHandler

Remarks

The Request is of the type of the service for the services on nodes and on their history, such as OpcReadNodesRequest, so that its content can be inspected. The Result states the result of the checks of the server.

Setting Cancel or a bad result rejects the request. The result set replaces the one of the server, so a good result also accepts a request the server would have rejected.

SessionActivated

Occurs when a session of the OpcServer has been activated.

public event OpcSessionEventHandler SessionActivated

Public Event SessionActivated As OpcSessionEventHandler

Event type

OpcSessionEventHandler

SessionActivating

Occurs when a session of the OpcServer is about to be activated.

public event EventHandler SessionActivating

Public Event SessionActivating As EventHandler

Event type

EventHandler

SessionActivationFailed

since v2.58

Occurs when the server rejects the activation of a session.

public event OpcSessionActivationFailedEventHandler SessionActivationFailed

Public Event SessionActivationFailed As OpcSessionActivationFailedEventHandler

Event type

OpcSessionActivationFailedEventHandler

Remarks

The event covers every rejection, among them an unknown user name, a rejected certificate and a user token signature that does not verify.

SessionClosed

Occurs when a session of the OpcServer has been closed.

public event EventHandler SessionClosed

Public Event SessionClosed As EventHandler

Event type

EventHandler

SessionClosing

Occurs when a session of the OpcServer is about to be closed.

public event OpcSessionEventHandler SessionClosing

Public Event SessionClosing As OpcSessionEventHandler

Event type

OpcSessionEventHandler

SessionCreated

Occurs when a new session has been created on the OpcServer.

public event OpcSessionEventHandler SessionCreated

Public Event SessionCreated As OpcSessionEventHandler

Event type

OpcSessionEventHandler

SessionCreating

Occurs when a new session is about to be created on the OpcServer.

public event EventHandler SessionCreating

Public Event SessionCreating As EventHandler

Event type

EventHandler

SubscriptionCreated

Occurs when a new subscription is created through a OpcSession.

public event OpcSubscriptionEventHandler SubscriptionCreated

Public Event SubscriptionCreated As OpcSubscriptionEventHandler

Event type

OpcSubscriptionEventHandler

SubscriptionDeleted

Occurs when an existing subscription of a OpcSession has been deleted.

public event OpcSubscriptionEventHandler SubscriptionDeleted

Public Event SubscriptionDeleted As OpcSubscriptionEventHandler

Event type

OpcSubscriptionEventHandler

TypeResolve

since v2.53

Occurs before the resolution of a data type takes place. Use this event to manually provide the Type to use for a specific data type definition identifier.

public event OpcTypeResolveEventHandler TypeResolve

Public Event TypeResolve As OpcTypeResolveEventHandler

Event type

OpcTypeResolveEventHandler