Package com.inductiveautomation.ignition.gateway.opc

Interface OpcConnection

All Superinterfaces:

Lifecycle

public interface OpcConnection
extends Lifecycle

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

It is agnostic of the underlying technology (e.g. 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.
Optional<LocalDateTime>	getConnectionTimestamp()	The timestamp when this connection made the transition to OpcConnection.State.CONNECTED, or Optional.empty() if not currently connected.
Optional<Throwable>	getFault()	If the OpcConnection.State is OpcConnection.State.FAULTED then return a Throwable containing the reason, otherwise, Optional.empty().
OpcConnection.State	getState()
List<QualifiedValue>	read(List<ServerNodeId> nodes)
List<QualityCode>	write(List<OPCWriteRequest> writes)

Methods inherited from interface com.inductiveautomation.ignition.common.lifecycle.Lifecycle

shutdown, startup

Method Details

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

Optional<LocalDateTime> getConnectionTimestamp()

The timestamp when this connection made the transition to OpcConnection.State.CONNECTED, or Optional.empty() if not currently connected.

getFault

Optional<Throwable> getFault()

If the OpcConnection.State is OpcConnection.State.FAULTED then return a Throwable containing the reason, otherwise, Optional.empty().

Returns:

a Throwable containing the reason for a connection fault, or Optional.empty() 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 Classic servers were referred to by their "progids" rather than names.