com.inductiveautomation.xopc.driver.api

Class SocketIODelegate

java.lang.Object

com.inductiveautomation.xopc.driver.api.SocketIODelegate

All Implemented Interfaces:

DriverIODelegate

public class SocketIODelegate
extends java.lang.Object
implements DriverIODelegate

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SO_TIMEOUT
static int	DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
SocketIODelegate(AbstractIODelegatingDriver driver, java.lang.String hostname, int port)
SocketIODelegate(AbstractIODelegatingDriver driver, java.lang.String hostname, int port, int timeout, int soTimeout)

Method Summary

Modifier and Type	Method and Description
void	connect() Connect to the underlying IO source.
void	disconnect() Disconnect from the underlying IO source.
void	onNotifyConnectFailed(java.lang.Exception connectError) AbstractDriver.notifyConnectFailed(Exception) was intercepted by AbstractIODelegatingDriver.
void	onNotifyConnectionLost() AbstractDriver.notifyConnectionLost() was intercepted by AbstractIODelegatingDriver.
void	onNotifyConnectSucceeded() AbstractDriver.notifyConnectSucceeded() was intercepted by AbstractIODelegatingDriver.
void	onNotifyDisconnectDone() AbstractDriver.notifyDisconnectDone() was intercepted by AbstractIODelegatingDriver.
void	writeToIO(java.nio.ByteBuffer... buffers) Write data to the underlying IO source.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SO_TIMEOUT

public static final int DEFAULT_SO_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

SocketIODelegate

public SocketIODelegate(AbstractIODelegatingDriver driver,
                        java.lang.String hostname,
                        int port)

SocketIODelegate

public SocketIODelegate(AbstractIODelegatingDriver driver,
                        java.lang.String hostname,
                        int port,
                        int timeout,
                        int soTimeout)

Method Detail

connect

public void connect()
             throws java.io.IOException

Description copied from interface: DriverIODelegate

Connect to the underlying IO source.

Specified by:

connect in interface DriverIODelegate

Throws:

java.io.IOException - Any IOException thrown during connect will result in a call to AbstractDriver.notifyConnectFailed(Exception) and the rest of the connection sequence will be aborted. Implementations do not need to make this call themselves.

disconnect

public void disconnect()

Description copied from interface: DriverIODelegate

Disconnect from the underlying IO source.

Specified by:

disconnect in interface DriverIODelegate

writeToIO

public void writeToIO(java.nio.ByteBuffer... buffers)

Description copied from interface: DriverIODelegate

Write data to the underlying IO source.

Specified by:

writeToIO in interface DriverIODelegate

Parameters:

buffers - Data to write.

onNotifyConnectSucceeded

public void onNotifyConnectSucceeded()

Description copied from interface: DriverIODelegate

AbstractDriver.notifyConnectSucceeded() was intercepted by AbstractIODelegatingDriver.

Specified by:

onNotifyConnectSucceeded in interface DriverIODelegate

onNotifyConnectFailed

public void onNotifyConnectFailed(java.lang.Exception connectError)

Description copied from interface: DriverIODelegate

AbstractDriver.notifyConnectFailed(Exception) was intercepted by AbstractIODelegatingDriver.

Specified by:

onNotifyConnectFailed in interface DriverIODelegate

Parameters:

connectError - The error associated with the connect failure.

onNotifyConnectionLost

public void onNotifyConnectionLost()

Description copied from interface: DriverIODelegate

AbstractDriver.notifyConnectionLost() was intercepted by AbstractIODelegatingDriver.

Specified by:

onNotifyConnectionLost in interface DriverIODelegate

onNotifyDisconnectDone

public void onNotifyDisconnectDone()

Description copied from interface: DriverIODelegate

AbstractDriver.notifyDisconnectDone() was intercepted by AbstractIODelegatingDriver.

Specified by:

onNotifyDisconnectDone in interface DriverIODelegate