Package com.inductiveautomation.ignition.gateway.opc

Interface OpcConnectionManager

All Superinterfaces:

ExtensionPointManager

public interface OpcConnectionManager
extends ExtensionPointManager

Manages OpcConnection instances and provides an interface to read, write, browse, and subscribe to OPC values via those connections.

Method Summary

Modifier and Type	Method	Description
List<OPCBrowseElement>	browse(ServerNodeId nodeId)	Browse the nodes immediately under the given node
OpcSubscription	createSubscription(String connectionName, String subscriptionName, PropertySet properties)	Create an OpcSubscription on the named connection.
void	deleteSubscription(OpcSubscription subscription)	Delete an OpcSubscription.
OpcConnection	getConnection(String name)	Return the OpcConnection identified by name, or null if none exists.
List<OpcConnection>	getConnections()	Returns all registered connections.
default OpcConnection.State	getConnectionState(String name)	Returns the OpcConnection.State of a named connection.
List<OpcConnectionType>	getExtensionPoints()
OpcSubscriptionModel	getSubscriptionModel()	Get the OpcSubscriptionModel.
List<QualifiedValue>	read(List<ServerNodeId> nodes)	Reads the values addressed by the given nodes
CompletableFuture<Void>	registerConnectionType(OpcConnectionType type)	Register a OpcConnectionType that provides a new kind of OpcConnection.
CompletableFuture<Void>	unregisterConnectionType(OpcConnectionType type)	Unregister a previously-registered OpcConnectionType.
List<QualityCode>	write(List<OPCWriteRequest> values)	Writes the values to their node ids

Methods inherited from interface com.inductiveautomation.ignition.gateway.model.ExtensionPointManager

getExtensionPoint

Method Details

getConnection

@Nullable
OpcConnection getConnection(String name)

Return the OpcConnection identified by name, or null if none exists.

Parameters:

name - the name or alias for the OpcConnection.

Returns:

the OpcConnection identified by name, or null if none exists.

getConnections

List<OpcConnection> getConnections()

Returns all registered connections.

getConnectionState

default OpcConnection.State getConnectionState(String name)

Returns the OpcConnection.State of a named connection.

If the connection does not exist OpcConnection.State.UNKNOWN will be returned.

Parameters:

name - the name of the connection.

Returns:

the connection OpcConnection.State, or OpcConnection.State.UNKNOWN if the connection doesn't exist.

createSubscription

OpcSubscription createSubscription(String connectionName,
 String subscriptionName,
 PropertySet properties)
                            throws Exception

Create an OpcSubscription on the named connection.

Parameters:

connectionName - the name of the OpcConnection.

subscriptionName - the name to assign the OpcSubscription.

properties - a PropertySet containing additional properties that a subscription may need to configure itself.

Returns:

an OpcSubscription.

Throws:

Exception - if a subscription by subscriptionName already exists on the named connection.

deleteSubscription

void deleteSubscription(OpcSubscription subscription)

Delete an OpcSubscription.

Parameters:

subscription - the OpcSubscription to delete.

read

List<QualifiedValue> read(List<ServerNodeId> nodes)

Reads the values addressed by the given nodes

write

List<QualityCode> write(List<OPCWriteRequest> values)

Writes the values to their node ids

browse

List<OPCBrowseElement> browse(ServerNodeId nodeId)
                       throws Exception

Browse the nodes immediately under the given node

Throws:

Exception

registerConnectionType

CompletableFuture<Void> registerConnectionType(OpcConnectionType type)
                                        throws Exception

Register a OpcConnectionType that provides a new kind of OpcConnection.

Returns:

a CompletableFuture that completes when any existing instances of the registered type have finished shutting down and new instances have finished starting up.

Throws:

Exception

unregisterConnectionType

CompletableFuture<Void> unregisterConnectionType(OpcConnectionType type)
                                          throws Exception

Unregister a previously-registered OpcConnectionType.

Returns:

a CompletableFuture that completes when existing instances of the unregistered type have finished shutting down.

Throws:

Exception

getSubscriptionModel

OpcSubscriptionModel getSubscriptionModel()

Get the OpcSubscriptionModel.

This is the same instance provided to connections in OpcConnection.startup(OpcSubscriptionModel).

Returns:

the OpcSubscriptionModel.

getExtensionPoints

List<OpcConnectionType> getExtensionPoints()

Specified by:

getExtensionPoints in interface ExtensionPointManager

Returns:

all ExtensionPointTypes managed by this ExtensionPointManager.