Package com.inductiveautomation.ignition.gateway.opc

Interface OpcConnection

public interface OpcConnection

An OpcConnection is a connection to some kind of OPC server.

It is agnostic of the underlying technology (i.e. OPC Classic vs OPC UA) and instead relies on basic abstractions for read, write, browse, and subscribe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	OpcConnection.State

Method Summary

Modifier and Type	Method	Description
List<OPCBrowseElement>	browse(ServerNodeId node)
default List<String>	getAliases()	Returns the "aliases", or alternative names, for a server.
LocalDateTime	getConnectionTimestamp()	The timestamp when this connection made the transition to OpcConnection.State.CONNECTED, or null if not currently connected.
Throwable	getFault()	If the OpcConnection.State is OpcConnection.State.FAULTED then return a Throwable containing the reason, otherwise, return null.
String	getName()	The name of this OPC connection.
OpcConnection.State	getState()
String	getType()	The type of this OPC connection.
boolean	isEnabled()	Returns true if this OpcConnection is enabled.
List<QualifiedValue>	read(List<ServerNodeId> nodes)
void	shutdown()
void	startup(OpcSubscriptionModel model)
List<QualityCode>	write(List<OPCWriteRequest> writes)

Method Details

getName

String getName()

The name of this OPC connection. Must match the name of the OPCServerProfileRecord that created it.

getType

String getType()

The type of this OPC connection. Must match the type of the OPCServerProfileRecord that created it.

isEnabled

boolean isEnabled()

Returns true if this OpcConnection is enabled.

Returns:

boolean true if this OpcConnection is enabled.

startup

void startup(OpcSubscriptionModel model)

shutdown

void shutdown()

read

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

write

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

browse

List<OPCBrowseElement> browse(ServerNodeId node)
                       throws Exception

Throws:

Exception

getState

OpcConnection.State getState()

Returns:

the current OpcConnection.State of the connection.

getConnectionTimestamp

@Nullable
LocalDateTime getConnectionTimestamp()

The timestamp when this connection made the transition to OpcConnection.State.CONNECTED, or null if not currently connected.

getFault

@Nullable
Throwable getFault()

If the OpcConnection.State is OpcConnection.State.FAULTED then return a Throwable containing the reason, otherwise, return null.

Returns:

a Throwable containing the reason for a connection fault, or null if not faulted.

getAliases

default List<String> getAliases()

Returns the "aliases", or alternative names, for a server.

This exists primarily to help backwards compatibility, where OPC servers were referred to by their "progids" rather than names.