com.inductiveautomation.xopc.driver.api

Class AbstractSocketDriver

java.lang.Object

com.inductiveautomation.xopc.driver.api.AbstractDriver<byte[]>

com.inductiveautomation.xopc.driver.api.AbstractSocketDriver

All Implemented Interfaces:

Driver, DriverTagManager

public abstract class AbstractSocketDriver
extends AbstractDriver<byte[]>

A subclass of AbstractDriver that implements connect/disconnect/read/write management of a Socket connection.

Field Summary

Fields inherited from class com.inductiveautomation.xopc.driver.api.AbstractDriver

builderFactory, diagnosticsContext, executor, log, nodeManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSocketDriver(DriverContext driverContext, java.lang.String hostname, int port, int timeout)

Method Summary

Modifier and Type	Method and Description
protected void	connect() A chance for implementations to do anything that is needed before moving into DriverState.Connected.
protected abstract Request<byte[]>	createConnectRequest() Called after the driver has successfully opened a TCP connection but before moving into DriverState.Connected.
protected void	disconnect() A chance for implementations to do anything that is needed before moving into DriverState.Disconnected.
java.lang.String	getHostname()
int	getPort()
int	getSoTimeout()
int	getTimeout()
protected void	messageArrived(byte[] message) Notify AbstractDriver that a messaged arrived.
protected abstract int	messageLength(java.nio.ByteBuffer buffer) Search the given ByteBuffer starting at its current position looking for a message and return the length in bytes of the next message in the buffer.
void	notifyConnectFailed(java.lang.Exception connectError) Callback indicating that the result of AbstractDriver.connect() was a failure.
protected void	reconnect()
void	setHostname(java.lang.String hostname)
void	setPort(int port)
void	setSoTimeout(int soTimeout)
void	setTimeout(int timeout)
boolean	writeToChannel(java.nio.ByteBuffer... bufs) Writes the contents of the given ByteBuffers to the channel.

Methods inherited from class com.inductiveautomation.xopc.driver.api.AbstractDriver

addDriverTag, browse, createBrowseRequest, createReadRequest, createSubscribeRequest, createWriteRequest, currentGuid, findTag, getConcurrentRequests, getDiagnostics, getDriverContext, getDriverMetrics, getDriverState, getDriverStatus, getDriverTagAddressPrefix, getLogger, getName, getRequestDiagnostics, getRequestKey, isBrowsingSupported, isOfflineBrowsingSupported, nextGuid, notifyConnectionLost, notifyConnectSucceeded, notifyDisconnectDone, optimizeRead, optimizeSubscribe, optimizeWrite, postRequest, readItems, removeDriverTag, reschedule, setConcurrentRequests, setState, shutdown, writeItems

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inductiveautomation.xopc.driver.api.Driver

buildNode, getDriverStatusJSLibName, getDriverStatusJSUrl

Constructor Detail

AbstractSocketDriver

protected AbstractSocketDriver(DriverContext driverContext,
                               java.lang.String hostname,
                               int port,
                               int timeout)

Method Detail

getHostname

public java.lang.String getHostname()

getPort

public int getPort()

getTimeout

public int getTimeout()

getSoTimeout

public int getSoTimeout()

setHostname

public void setHostname(java.lang.String hostname)

setPort

public void setPort(int port)

setTimeout

public void setTimeout(int timeout)

setSoTimeout

public void setSoTimeout(int soTimeout)

connect

protected void connect()

Description copied from class: AbstractDriver

A chance for implementations to do anything that is needed before moving into DriverState.Connected. When done, AbstractDriver.notifyConnectSucceeded() or AbstractDriver.notifyConnectFailed(Exception) must be called.

Specified by:

connect in class AbstractDriver<byte[]>

notifyConnectFailed

public void notifyConnectFailed(java.lang.Exception connectError)

Description copied from class: AbstractDriver

Callback indicating that the result of AbstractDriver.connect() was a failure.

The contents of connectError will be displayed to the user on the device status page of the Ignition gateway.

Overrides:

notifyConnectFailed in class AbstractDriver<byte[]>

Parameters:

connectError - A user-facing error message that will be displayed on the device status page of the Ignition gateway.

disconnect

protected void disconnect()

Description copied from class: AbstractDriver

A chance for implementations to do anything that is needed before moving into DriverState.Disconnected. When done, AbstractDriver.notifyDisconnectDone() must be called.

Specified by:

disconnect in class AbstractDriver<byte[]>

reconnect

protected void reconnect()

messageArrived

protected void messageArrived(byte[] message)

Notify AbstractDriver that a messaged arrived. This cannot be called on the same thread that Request.sendMessage() was invoked on.

Overrides:

messageArrived in class AbstractDriver<byte[]>

Parameters:

message - The message that has arrived.

writeToChannel

public boolean writeToChannel(java.nio.ByteBuffer... bufs)

Writes the contents of the given ByteBuffers to the channel. Will not block - if the contents cannot be written immediately, they will be scheduled for writing when writing is available again.

Parameters:

bufs - ByteBuffers to write.

Returns:

Always returns True...

createConnectRequest

protected abstract Request<byte[]> createConnectRequest()

Called after the driver has successfully opened a TCP connection but before moving into DriverState.Connected.

Now is that chance for any requests needed to initialize communications with a device, such as negotiating PDU size or session handles, to happen.

Return null if no connect Request is necessary.

If a non-null value is returned, then it is the responsibility of the implementation to call AbstractDriver.notifyConnectSucceeded() or notifyConnectFailed(Exception) when finished connecting.

Returns:

A connect Request or null if none is necessary.

messageLength

protected abstract int messageLength(java.nio.ByteBuffer buffer)

Search the given ByteBuffer starting at its current position looking for a message and return the length in bytes of the next message in the buffer. If there is not enough information in the buffer to determine the length of the next message, return -1.

This function should only make calls to ByteBuffer.get() and friends. Only the buffer's position should ever be modified by this function; it should leave the mark and limit alone.

Parameters:

buffer - A ByteBuffer containing bytes that have come in off the wire.

Returns:

The length of the next message in the buffer, or -1 if there is not enough information to determine the length.