com.prosysopc.ua.stack.utils.asyncsocket

Class AsyncSocketImpl

java.lang.Object

com.prosysopc.ua.stack.utils.AbstractState<SocketState,IOException>

com.prosysopc.ua.stack.utils.asyncsocket.AsyncSocketImpl

All Implemented Interfaces:

AsyncSocket, IStatefulObject<SocketState,IOException>

public class AsyncSocketImpl
extends AbstractState<SocketState,IOException>
implements AsyncSocket, IStatefulObject<SocketState,IOException>

Async socket.

The object has monitorable internal state SocketState.

Author:

Toni Kalajainen (toni.kalajainen@vtt.fi)

See Also:

Methods for monitoring the state, State of the socket, Async input stream, Async output stream, Stream alarms

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AsyncSocketImpl.AsyncSocketInputStream Internal AsyncInputStream of the AsyncSocketImpl.
class	AsyncSocketImpl.AsyncSocketOutputStream Internal AsyncOutputStream of the AsyncSocketImpl.

Constructor Summary

Constructors

Constructor and Description
AsyncSocketImpl() Constructor for AsyncSocketImpl.
AsyncSocketImpl(SocketChannel chan) Constructor for AsyncSocketImpl.
AsyncSocketImpl(SocketChannel channel, Executor triggerExecutor, AsyncSelector selectorThread) Constructor for AsyncSocketImpl.

Method Summary

Modifier and Type	Method and Description
AsyncSocketImpl	close() close.
void	closeOnFlush() Convenience method.
void	connect(SocketAddress addr) connect.
AsyncSocketImpl.AsyncSocketInputStream	getInputStream() getInputStream.
AsyncSocketImpl.AsyncSocketOutputStream	getOutputStream() getOutputStream.
IStatefulObject<SocketState,IOException>	getStateMonitor() getStateMonitor.
protected boolean	isStateTransitionAllowed(SocketState oldState, SocketState newState) Checks whether state transition is allowed.
protected void	onStateTransition(SocketState oldState, SocketState newState) Override this.
protected boolean	setState(SocketState state) setState.
Socket	socket() socket.
SocketChannel	socketChannel() socketChannel.
boolean	syncConnect(SocketAddress addr) syncConnect.

Methods inherited from class com.prosysopc.ua.stack.utils.AbstractState

addStateListener, addStateNotifiable, attemptSetState, clearError, getError, getState, hasError, onListenerException, removeStateListener, removeStateNotifiable, setError, setState, throwIfError, waitForState, waitForState, waitForStateUninterruptibly

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.prosysopc.ua.stack.utils.IStatefulObject

addStateListener, addStateNotifiable, getError, getState, removeStateListener, removeStateNotifiable, waitForState, waitForState, waitForStateUninterruptibly

Constructor Detail

AsyncSocketImpl

public AsyncSocketImpl()
                throws IOException

Constructor for AsyncSocketImpl.

Throws:

IOException - if any.

AsyncSocketImpl

public AsyncSocketImpl(SocketChannel chan)
                throws IOException

Constructor for AsyncSocketImpl.

Parameters:

chan - a SocketChannel object.

Throws:

IOException - if any.

AsyncSocketImpl

public AsyncSocketImpl(SocketChannel channel,
                       Executor triggerExecutor,
                       AsyncSelector selectorThread)
                throws IOException

Constructor for AsyncSocketImpl.

Parameters:

channel - a SocketChannel object.

triggerExecutor - a Executor object.

selectorThread - a AsyncSelector object.

Throws:

IOException - if any.

Method Detail

close

public AsyncSocketImpl close()
                      throws IOException

close.

Specified by:

close in interface AsyncSocket

Returns:

a AsyncSocketImpl object.

Throws:

IOException - if any.

closeOnFlush

public void closeOnFlush()

Convenience method. Closes socket when all data is flushed

connect

public void connect(SocketAddress addr)
             throws IOException

connect.

Async connect. The state is set to Connecting upon successful attempt (method returns without exeception). Once the connection attempt is finished the object state will shift either to Error or to Connected (See getState()). State changes can be monitored by attaching listeners (See addStateListener()).

Specified by:

connect in interface AsyncSocket

Parameters:

addr - a SocketAddress object.

Throws:

IOException - if any.

getInputStream

public AsyncSocketImpl.AsyncSocketInputStream getInputStream()

getInputStream.

Specified by:

getInputStream in interface AsyncSocket

Returns:

a AsyncInputStream object.

getOutputStream

public AsyncSocketImpl.AsyncSocketOutputStream getOutputStream()

getOutputStream.

Specified by:

getOutputStream in interface AsyncSocket

Returns:

a AsyncOutputStream object.

getStateMonitor

public IStatefulObject<SocketState,IOException> getStateMonitor()

getStateMonitor.

Specified by:

getStateMonitor in interface AsyncSocket

Returns:

a IStatefulObject object.

socket

public Socket socket()

socket.

Specified by:

socket in interface AsyncSocket

Returns:

a Socket object.

socketChannel

public SocketChannel socketChannel()

socketChannel.

Specified by:

socketChannel in interface AsyncSocket

Returns:

a SocketChannel object.

syncConnect

public boolean syncConnect(SocketAddress addr)
                    throws IOException

syncConnect.

Parameters:

addr - a SocketAddress object.

Returns:

a boolean.

Throws:

IOException - if any.

isStateTransitionAllowed

protected boolean isStateTransitionAllowed(SocketState oldState,
                                           SocketState newState)

Checks whether state transition is allowed. Override this

Overrides:

isStateTransitionAllowed in class AbstractState<SocketState,IOException>

Parameters:

oldState - a StateType object.

newState - a StateType object.

Returns:

true if state transition is allowed

onStateTransition

protected void onStateTransition(SocketState oldState,
                                 SocketState newState)

Override this.

Overrides:

onStateTransition in class AbstractState<SocketState,IOException>

Parameters:

oldState - a StateType object.

newState - a StateType object.

setState

protected boolean setState(SocketState state)

setState.

Overrides:

setState in class AbstractState<SocketState,IOException>

Parameters:

state - a SocketState object.

Returns:

a boolean.