com.inductiveautomation.xopc.driver.api

Interface DriverContext

public interface DriverContext

Method Summary

Modifier and Type	Method and Description
void	disableStaleChecking() Opt out of stale checking for all variable nodes created by this device.
void	enableStaleChecking() Opt into stale checking for all variable nodes created by this device.
java.lang.String	getDeviceName()
io.netty.util.concurrent.EventExecutorGroup	getEventExecutor() Deprecated. use getExecutorService() and getScheduledExecutorService() instead.
io.netty.channel.nio.NioEventLoopGroup	getEventLoop()
java.util.concurrent.ExecutorService	getExecutorService()
GatewayContext	getGatewayContext()
java.io.File	getHomeFolder()
NodeBuilderFactory	getNodeBuilderFactory()
NodeManager	getNodeManager()
java.util.concurrent.ScheduledExecutorService	getScheduledExecutorService()
DriverSubscriptionModel	getSubscriptionModel()
io.netty.util.HashedWheelTimer	getWheelTimer()
void	setLastConnectError(java.lang.Throwable error) Store the last error that occurred.

Method Detail

getDeviceName

java.lang.String getDeviceName()

Returns:

The user-assigned name for this device (driver instance).

getGatewayContext

GatewayContext getGatewayContext()

Returns:

The GatewayContext.

getHomeFolder

java.io.File getHomeFolder()

Returns:

A folder at {gateway_home}/drivers/{device_name} that this driver instance can read/write to.

getNodeManager

NodeManager getNodeManager()

Returns:

The NodeManager that manages Nodes in the UA address space.

getNodeBuilderFactory

NodeBuilderFactory getNodeBuilderFactory()

Returns:

A factory that provides NodeBuilders, used to build Nodes that will be added to the UA address space.

getSubscriptionModel

DriverSubscriptionModel getSubscriptionModel()

Returns:

The DriverSubscriptionModel for this Driver.

setLastConnectError

void setLastConnectError(java.lang.Throwable error)

Store the last error that occurred. The message and optionally the stack trace from error will visible to the user in the device status area of the gateway.

Given the visibility of this error, it should be used only when reporting errors that are relevant to the user for troubleshooting the current state of the device, such as repeating reconnection attempts to a disconnected or unreachable device. Exceptions that may occur during normal operations should be logged in the traditional manner.

The last connect error must be nullified once it is no longer valid.

Parameters:

error - The error that occurred.

enableStaleChecking

void enableStaleChecking()

Opt into stale checking for all variable nodes created by this device.

disableStaleChecking

void disableStaleChecking()

Opt out of stale checking for all variable nodes created by this device.

getEventExecutor

@Deprecated
io.netty.util.concurrent.EventExecutorGroup getEventExecutor()

Deprecated. use getExecutorService() and getScheduledExecutorService() instead.

getExecutorService

java.util.concurrent.ExecutorService getExecutorService()

Returns:

a shared, general purpose EventExecutorGroup instance.

getScheduledExecutorService

java.util.concurrent.ScheduledExecutorService getScheduledExecutorService()

Returns:

a shared, general purpose ScheduledExecutorService instance.

getEventLoop

io.netty.channel.nio.NioEventLoopGroup getEventLoop()

Returns:

a shared NioEventLoopGroup instance.

getWheelTimer

io.netty.util.HashedWheelTimer getWheelTimer()

Returns:

a shared HashedWheelTimer instance.