OpcServer Members

OpcServer(IEnumerable<IOpcNode>)

C#

public OpcServer(IEnumerable<IOpcNode> nodes)

Parameters

nodes IEnumerable<IOpcNode>

Exceptions

OpcServer(IEnumerable<OpcNodeManager>)

C#

public OpcServer(IEnumerable<OpcNodeManager> nodeManagers)

Parameters

nodeManagers IEnumerable<OpcNodeManager>

Exceptions

OpcServer(params IOpcNode[])

C#

public OpcServer(params IOpcNode[] nodes)

Parameters

nodes IOpcNode[]

Exceptions

OpcServer(params OpcNodeManager[])

C#

public OpcServer(params OpcNodeManager[] nodeManagers)

Parameters

nodeManagers OpcNodeManager[]

Exceptions

OpcServer(string)

C#

public OpcServer(string address)

Parameters

address String

Exceptions

OpcServer(string, Action<OpcAddressSpace>)

C#

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

Parameters

address String

createNodes Action<OpcAddressSpace>

Exceptions

OpcServer(string, IEnumerable<IOpcNode>)

C#

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

Parameters

address String

nodes IEnumerable<IOpcNode>

Exceptions

OpcServer(string, IEnumerable<OpcNodeManager>)

C#

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

Parameters

address String

nodeManagers IEnumerable<OpcNodeManager>

Exceptions

OpcServer(string, params IOpcNode[])

C#

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

Parameters

address String

nodes IOpcNode[]

Exceptions

OpcServer(string, params OpcNodeManager[])

C#

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

Parameters

address String

nodeManagers OpcNodeManager[]

Exceptions

OpcServer(Uri)

C#

public OpcServer(Uri address)

Parameters

address Uri

Exceptions

OpcServer(Uri, Action<OpcAddressSpace>)

C#

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

Parameters

address Uri

createNodes Action<OpcAddressSpace>

Exceptions

OpcServer(Uri, IEnumerable<IOpcNode>)

C#

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

Parameters

address Uri

nodes IEnumerable<IOpcNode>

Exceptions

OpcServer(Uri, IEnumerable<OpcNodeManager>)

C#

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

Parameters

address Uri

nodeManagers IEnumerable<OpcNodeManager>

Exceptions

OpcServer(Uri, params IOpcNode[])

C#

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

Parameters

address Uri

nodes IOpcNode[]

Exceptions

OpcServer(Uri, params OpcNodeManager[])

C#

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

Parameters

address Uri

nodeManagers OpcNodeManager[]

Exceptions

DefaultAddress

C#

public static readonly Uri DefaultAddress

Field Value
Uri

RequestJudgement

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

C#

public event OpcRequestJudgementEventHandler RequestJudgement

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

C#

public event OpcRequestProcessedEventHandler RequestProcessed

RequestProcessing

C#

public event OpcRequestProcessingEventHandler RequestProcessing

RequestValidated

C#

public event OpcRequestValidatedEventHandler RequestValidated

RequestValidating

C#

public event OpcRequestValidatingEventHandler RequestValidating

SessionActivated

C#

public event OpcSessionEventHandler SessionActivated

SessionActivating

C#

public event EventHandler SessionActivating

SessionClosed

C#

public event EventHandler SessionClosed

SessionClosing

C#

public event OpcSessionEventHandler SessionClosing

SessionCreated

C#

public event OpcSessionEventHandler SessionCreated

SessionCreating

C#

public event EventHandler SessionCreating

SubscriptionCreated

Occurs when a new subscription is created through a OpcSession.

C#

public event OpcSubscriptionEventHandler SubscriptionCreated

SubscriptionDeleted

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

C#

public event OpcSubscriptionEventHandler SubscriptionDeleted

DefaultNodeManager

C#

public OpcNodeManager DefaultNodeManager { get; }

Property Value

OpcNodeManager

Diagnostics

C#

public OpcServerDiagnostics Diagnostics { get; }

Property Value

OpcServerDiagnostics

EstimatedReturnTime

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

C#

public DateTime? EstimatedReturnTime { get; set; }

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

OpcApplicationConfiguration

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

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

C#

public OpcServerGlobalization Globalization { get; }

Property Value

OpcServerGlobalization

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

NodeManagers

C#

public OpcNodeManagerCollection NodeManagers { get; }

Property Value

OpcNodeManagerCollection

OperationLimits

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

C#

public OpcOperationLimits OperationLimits { get; }

Property Value

OpcOperationLimits

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

SystemContext

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

C#

public override OpcContext SystemContext { get; }

Property Value

OpcContext

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

CreateConfiguration()

C#

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

Returns

CreateOperationLimits()

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

C#

protected OpcOperationLimits CreateOperationLimits()

Returns

OpcOperationLimits

A new instance of the type specified by OpcOperationLimits.

GetDataType(OpcEncoding)

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

C#

public OpcDataTypeInfo GetDataType(OpcEncoding encoding)

Parameters

encoding OpcEncoding

The OpcEncoding which identifies the OpcDataTypeInfo to retrieve.

Returns

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

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

The object has been disposed of.

GetDataType(OpcName)

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

C#

public OpcDataTypeInfo GetDataType(OpcName name)

Parameters

name OpcName

The OpcName of the OpcDataTypeInfo object to retrieve.

Returns

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

Exceptions

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

The object has been disposed of.

GetDataType(OpcNodeId)

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

C#

public OpcDataTypeInfo GetDataType(OpcNodeId typeId)

Parameters

typeId OpcNodeId

The OpcNodeId which identifies the OpcDataTypeInfo to retrieve.

Returns

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

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

The object has been disposed of.

GetDataType(string)

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

C#

public OpcDataTypeInfo GetDataType(string name)

Parameters

name String

The String to use to identify the OpcDataTypeInfo object to retrieve.

Returns

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

Exceptions

The name is equals Empty.

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

The object has been disposed of.

GetDataType(Type)

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

C#

public OpcDataTypeInfo GetDataType(Type underlyingType)

Parameters

underlyingType Type

The Type which implements the OpcDataTypeInfo to retrieve.

Returns

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

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

The object has been disposed of.

GetDataType(XmlQualifiedName)

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

C#

public OpcDataTypeInfo GetDataType(XmlQualifiedName xmlName)

Parameters

xmlName XmlQualifiedName

The XmlQualifiedName of the OpcDataTypeInfo object to retrieve.

Returns

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

Exceptions

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

The object has been disposed of.

GetDataTypes()

Retrieves all OpcDataTypeInfo objects offered by the IOpcTypeProvider.

C#

public OpcDataTypeInfo[] GetDataTypes()

Returns

OpcDataTypeInfo[]

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

Exceptions

The object has been disposed of.

GetDataTypeSystems()

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

C#

public OpcDataTypeSystem[] GetDataTypeSystems()

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

The requested operation is currently not supported.

IEnumerable<OpcEndpointDescription>

The object has been disposed of.

GetEndpoints()

C#

public IEnumerable<OpcEndpointDescription> GetEndpoints()

Returns

Exceptions

GetNodeType(OpcName)

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

C#

public OpcNodeTypeInfo GetNodeType(OpcName name)

Parameters

name OpcName

The OpcName of the OpcNodeTypeInfo object to retrieve.

Returns

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

Exceptions

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

The object has been disposed of.

GetNodeType(OpcNodeId)

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

C#

public OpcNodeTypeInfo GetNodeType(OpcNodeId typeId)

Parameters

typeId OpcNodeId

The OpcNodeId which identifies the OpcNodeTypeInfo to retrieve.

Returns

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

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

The object has been disposed of.

GetNodeType(string)

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

C#

public OpcNodeTypeInfo GetNodeType(string name)

Parameters

name String

The String to use to identify the OpcNodeTypeInfo object to retrieve.

Returns

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

Exceptions

The name is equals Empty.

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

The object has been disposed of.

GetNodeType(Type)

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

C#

public OpcNodeTypeInfo GetNodeType(Type underlyingType)

Parameters

underlyingType Type

The Type which implements the OpcNodeTypeInfo to retrieve.

Returns

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

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

The object has been disposed of.

GetNodeTypes()

Retrieves all OpcNodeTypeInfo objects offered by the IOpcTypeProvider.

C#

public OpcNodeTypeInfo[] GetNodeTypes()

Returns

OpcNodeTypeInfo[]

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

Exceptions

The object has been disposed of.

GetNodeTypeSystem()

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

C#

public OpcNodeTypeSystem GetNodeTypeSystem()

Returns

OpcNodeTypeSystem

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

Exceptions

The object has been disposed of.

GetSession(OpcNodeId)

Retrieves the OpcSession associated with the sessionId specified.

C#

public OpcSession GetSession(OpcNodeId sessionId)

Parameters

sessionId OpcNodeId

The OpcNodeId which uniquely identifies the session requested within the created sessions on the current OpcServer.

Returns

OpcSession

Exceptions

The sessionId is a null reference (Nothing in Visual Basic).

The server has not yet been started.

The object has been disposed of.

GetSessions()

Retrieves all currently known sessions created on the current OpcServer.

C#

public IEnumerable<OpcSession> GetSessions()

Returns

IEnumerable<OpcSession>

A sequence of OpcSession instances.

Exceptions

The server has not yet been started.

IEnumerable<OpcSubscription>

The object has been disposed of.

GetSubscriptions()

C#

public IEnumerable<OpcSubscription> GetSubscriptions()

Returns

Exceptions

OnRequestJudgement(OpcRequestJudgementEventArgs)

Raises the RequestJudgement event of the OpcServer.

C#

protected virtual void OnRequestJudgement(OpcRequestJudgementEventArgs e)

Parameters

e OpcRequestJudgementEventArgs

The event data.

OnRequestProcessed(OpcRequestProcessedEventArgs)

C#

protected virtual void OnRequestProcessed(OpcRequestProcessedEventArgs e)

Parameters

e OpcRequestProcessedEventArgs

OnRequestProcessing(OpcRequestProcessingEventArgs)

C#

protected virtual void OnRequestProcessing(OpcRequestProcessingEventArgs e)

Parameters

e OpcRequestProcessingEventArgs

OnRequestValidated(OpcRequestValidatedEventArgs)

C#

protected virtual void OnRequestValidated(OpcRequestValidatedEventArgs e)

Parameters

e OpcRequestValidatedEventArgs

OnRequestValidating(OpcRequestValidatingEventArgs)

C#

protected virtual void OnRequestValidating(OpcRequestValidatingEventArgs e)

Parameters

e OpcRequestValidatingEventArgs

OnSessionActivated(OpcSessionEventArgs)

C#

protected virtual void OnSessionActivated(OpcSessionEventArgs e)

Parameters

e OpcSessionEventArgs

OnSessionActivating(EventArgs)

C#

protected virtual void OnSessionActivating(EventArgs e)

Parameters

e EventArgs

OnSessionClosed(EventArgs)

C#

protected virtual void OnSessionClosed(EventArgs e)

Parameters

e EventArgs

OnSessionClosing(OpcSessionEventArgs)

C#

protected virtual void OnSessionClosing(OpcSessionEventArgs e)

Parameters

e OpcSessionEventArgs

OnSessionCreated(OpcSessionEventArgs)

C#

protected virtual void OnSessionCreated(OpcSessionEventArgs e)

Parameters

e OpcSessionEventArgs

OnSessionCreating(EventArgs)

C#

protected virtual void OnSessionCreating(EventArgs e)

Parameters

e EventArgs

OnSubscriptionCreated(OpcSubscriptionEventArgs)

Raises the SubscriptionCreated event of the OpcServer.

C#

protected virtual void OnSubscriptionCreated(OpcSubscriptionEventArgs e)

Parameters

e OpcSubscriptionEventArgs

The event data.

OnSubscriptionDeleted(OpcSubscriptionEventArgs)

Raises the SubscriptionDeleted event of the OpcServer.

C#

protected virtual void OnSubscriptionDeleted(OpcSubscriptionEventArgs e)

Parameters

e OpcSubscriptionEventArgs

The event data.

RegisterNamespace(OpcNamespace)

C#

public OpcNamespace RegisterNamespace(OpcNamespace @namespace)

Parameters

namespace OpcNamespace

Returns

OpcNamespace

Exceptions

RegisterNamespace(string)

C#

public OpcNamespace RegisterNamespace(string namespaceUri)

Parameters

namespaceUri String

Returns

OpcNamespace

Exceptions

RegisterNamespace(Uri)

C#

public OpcNamespace RegisterNamespace(Uri namespaceUri)

Parameters

namespaceUri Uri

Returns

OpcNamespace

Exceptions

RegisterNamespaces(IEnumerable<OpcNamespace>)

C#

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

Parameters

namespaces IEnumerable<OpcNamespace>

Returns

Exceptions

RegisterNamespaces(IEnumerable<string>)

C#

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

Parameters

namespaceUris IEnumerable<String>

Returns

Exceptions

RegisterNamespaces(IEnumerable<Uri>)

C#

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

Parameters

namespaceUris IEnumerable<Uri>

Returns

Exceptions

RegisterNamespaces(params OpcNamespace[])

C#

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

Parameters

namespaces OpcNamespace[]

Returns

Exceptions

RegisterNamespaces(params string[])

C#

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

Parameters

namespaceUris String[]

Returns

Exceptions

RegisterNamespaces(params Uri[])

C#

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

Parameters

namespaceUris Uri[]

Returns

Exceptions

ReportEvent(IOpcNode, OpcEventSeverity, OpcText)

Produces a global event using the event data specified.

C#

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

Parameters

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

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

The State is not equals Started.

The object has been disposed of.

The operation failed (see exception details for more information).

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

Produces a global event using the event data specified.

C#

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

Parameters

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 Object[]

The values to place into the message using its format placeholders.

Exceptions

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

The State is not equals Started.

The object has been disposed of.

The operation failed (see exception details for more information).

ReportEvent(OpcEventNode)

Produces a global event using the eventNode specified.

C#

public void ReportEvent(OpcEventNode eventNode)

Parameters

eventNode OpcEventNode

The OpcEventNode its event information is to be reported as a global event.

Exceptions

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

The State is not equals Started.

The object has been disposed of.

The operation failed (see exception details for more information).

ReportEvent(OpcEventSeverity, OpcText)

Produces a global event using the event data specified.

C#

public void ReportEvent(OpcEventSeverity severity, OpcText message)

Parameters

severity OpcEventSeverity

An indication of the urgency of the event.

message OpcText

A human-readable and localizable text description of the event.

Exceptions

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

The State is not equals Started.

The object has been disposed of.

The operation failed (see exception details for more information).

ReportEvent(OpcEventSeverity, OpcText, params object[])

Produces a global event using the event data specified.

C#

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

Parameters

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 Object[]

The values to place into the message using its format placeholders.

Exceptions

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

The State is not equals Started.

The object has been disposed of.

The operation failed (see exception details for more information).

ReportEvent(OpcNodeId, string, OpcEventSeverity, OpcText)

Produces a global event using the event data specified.

C#

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

Parameters

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

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

The State is not equals Started.

The object has been disposed of.

The operation failed (see exception details for more information).

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

Produces a global event using the event data specified.

C#

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

Parameters

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 Object[]

The values to place into the message using its format placeholders.

Exceptions

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

The State is not equals Started.

The object has been disposed of.