com.inductiveautomation.xopc.driver.api

Interface Driver

All Known Implementing Classes:

AbstractDriver, AbstractIODelegatingDriver, AbstractSocketDriver, AbstractTagDriver, NodeMapDriver

public interface Driver

The super-interface for any type of XOPC driver.

Method Summary

Modifier and Type	Method and Description
void	browse(BrowseOperation browseOperation) Asynchronous browse operation.
void	buildNode(java.lang.String address, NodeId nodeId) For the given address, build an appropriate Node and at it to the UA address space.
default java.util.Optional<DriverMetrics>	getDriverMetrics() If this driver uses a traditional polling model, a DriverMetrics.
java.lang.String	getDriverStatus() Returns the current status of the driver.
default java.util.Optional<java.lang.String>	getDriverStatusJSLibName()
default java.util.Optional<java.lang.String>	getDriverStatusJSUrl()
void	readItems(java.util.List<? extends ReadItem> items) Asynchronous read call for a list of items.
void	shutdown() Called when a driver should cease all activities and shutdown any open connections.
void	writeItems(java.util.List<? extends WriteItem> items) Asynchronous write call for a list of items.

Method Detail

readItems

void readItems(java.util.List<? extends ReadItem> items)

Asynchronous read call for a list of items. Read results are reported by calling ReadItem.setValue(DataValue).

writeItems

void writeItems(java.util.List<? extends WriteItem> items)

Asynchronous write call for a list of items. Write results are reported by calling WriteItem.setWriteStatus(StatusCode).

browse

void browse(BrowseOperation browseOperation)

Asynchronous browse operation. When finished, call BrowseOperation.browseDone(StatusCode, List, Guid).

buildNode

void buildNode(java.lang.String address,
               NodeId nodeId)
        throws AddressNotFoundException

For the given address, build an appropriate Node and at it to the UA address space. See DriverContext.getNodeManager() and DriverContext.getNodeBuilderFactory() for more information.

If for any reason the node cannot be built AddressNotFoundException should be thrown.

Parameters:

address - Address of the node that is to be built.

nodeId - The NodeId to use when building the Node for this address.

Throws:

AddressNotFoundException

getDriverMetrics

default java.util.Optional<DriverMetrics> getDriverMetrics()

If this driver uses a traditional polling model, a DriverMetrics.

Returns:

a DriverMetrics if supported by this driver.

getDriverStatus

java.lang.String getDriverStatus()

Returns the current status of the driver.

Returns:

The driver's current status, e.g. "Browsing", "Program Mode", "Connected", etc...

shutdown

void shutdown()

Called when a driver should cease all activities and shutdown any open connections. No further value updates should be processed.

Once a driver instance has been shutdown it will never be started/used again; a new instance will be created and used if needed.

getDriverStatusJSUrl

default java.util.Optional<java.lang.String> getDriverStatusJSUrl()

getDriverStatusJSLibName

default java.util.Optional<java.lang.String> getDriverStatusJSLibName()