org.eclipse.scada.da.server.io.common

Class StreamBaseDevice

java.lang.Object

org.apache.mina.core.service.IoHandlerAdapter

org.eclipse.scada.da.server.io.common.GenericBaseDevice

org.eclipse.scada.da.server.io.common.StreamBaseDevice

All Implemented Interfaces:

IoHandler, BaseDevice

public abstract class StreamBaseDevice
extends GenericBaseDevice
implements BaseDevice

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONNECT_TIMEOUT
protected IoSession	session

Fields inherited from class org.eclipse.scada.da.server.io.common.GenericBaseDevice

connectionListeners

Constructor Summary

Constructors

Constructor and Description
StreamBaseDevice(SocketAddress address)

Method Summary

Methods

Modifier and Type	Method and Description
void	connect()
void	dispose()
boolean	isConnected()
void	sessionClosed(IoSession session) Invoked when a connection is closed.
void	sessionCreated(IoSession session) Invoked from an I/O processor thread when a new connection has been created.
void	sessionIdle(IoSession session, IdleStatus status) Invoked with the related IdleStatus when a connection becomes idle.
void	sessionOpened(IoSession session) Invoked when a connection has been opened.
protected void	setTimeout(long timeout)
protected abstract void	setupConnector(SocketConnector connector)
protected void	writeMessage(Object message) Write a message to the outbound connection or fail if there is not open connection at the moment
protected void	writeMessageIgnore(Object message) Write a message to the outbound connection or ignore it if there is no open connection at the moment

Methods inherited from class org.eclipse.scada.da.server.io.common.GenericBaseDevice

addConnectionListener, fireConnected, fireConnectionFailed, fireDisconnected, removeConnectionListener

Methods inherited from class org.apache.mina.core.service.IoHandlerAdapter

exceptionCaught, messageReceived, messageSent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scada.da.server.io.common.BaseDevice

addConnectionListener, removeConnectionListener

Field Detail

CONNECT_TIMEOUT

public static final int CONNECT_TIMEOUT

session

protected IoSession session

Constructor Detail

StreamBaseDevice

public StreamBaseDevice(SocketAddress address)

Method Detail

setupConnector

protected abstract void setupConnector(SocketConnector connector)

isConnected

public boolean isConnected()

Specified by:

isConnected in interface BaseDevice

connect

public void connect()

Specified by:

connect in interface BaseDevice

dispose

public void dispose()

Specified by:

dispose in interface BaseDevice

sessionCreated

public void sessionCreated(IoSession session)
                    throws Exception

Description copied from interface: IoHandler

Invoked from an I/O processor thread when a new connection has been created. Because this method is supposed to be called from the same thread that handles I/O of multiple sessions, please implement this method to perform tasks that consumes minimal amount of time such as socket parameter and user-defined session attribute initialization.

Specified by:

sessionCreated in interface IoHandler

Overrides:

sessionCreated in class IoHandlerAdapter

Throws:

Exception

setTimeout

protected void setTimeout(long timeout)

sessionOpened

public void sessionOpened(IoSession session)
                   throws Exception

Description copied from interface: IoHandler

Invoked when a connection has been opened. This method is invoked after IoHandler.sessionCreated(IoSession). The biggest difference from IoHandler.sessionCreated(IoSession) is that it's invoked from other thread than an I/O processor thread once thread model is configured properly.

Specified by:

sessionOpened in interface IoHandler

Overrides:

sessionOpened in class IoHandlerAdapter

Throws:

Exception

sessionIdle

public void sessionIdle(IoSession session,
               IdleStatus status)
                 throws Exception

Description copied from interface: IoHandler

Invoked with the related IdleStatus when a connection becomes idle. This method is not invoked if the transport type is UDP; it's a known bug, and will be fixed in 2.0.

Specified by:

sessionIdle in interface IoHandler

Overrides:

sessionIdle in class IoHandlerAdapter

Throws:

Exception

sessionClosed

public void sessionClosed(IoSession session)
                   throws Exception

Description copied from interface: IoHandler

Invoked when a connection is closed.

Specified by:

sessionClosed in interface IoHandler

Overrides:

sessionClosed in class IoHandlerAdapter

Throws:

Exception

writeMessage

protected void writeMessage(Object message)
                     throws NotConnectedException

Write a message to the outbound connection or fail if there is not open connection at the moment

Parameters:

message - the message to wrtite

Throws:

NotConnectedException - thrown if there is no connection at the moment

writeMessageIgnore

protected void writeMessageIgnore(Object message)

Write a message to the outbound connection or ignore it if there is no open connection at the moment

Parameters:

message - the message to write