org.shared.net.handler

Class SynchronousHandler<C extends Connection>

java.lang.Object

org.shared.net.handler.AbstractFilteredHandler<SynchronousHandler<C>,C,ByteBuffer>

org.shared.net.handler.SynchronousHandler<C>

Type Parameters:

C - the Connection type.

All Implemented Interfaces:

Closeable, AutoCloseable, ConnectionHandler<C>, FilteredHandler<SynchronousHandler<C>,C,ByteBuffer>, OobHandler<C>

public class SynchronousHandler<C extends Connection>
extends AbstractFilteredHandler<SynchronousHandler<C>,C,ByteBuffer>

A subclass of AbstractFilteredHandler with synchronous behavior.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SynchronousHandler.ManagedInputStream A subclass of InputStream that is managed underneath.
protected class	SynchronousHandler.ManagedOutputStream A subclass of OutputStream that is managed underneath.
protected static interface	SynchronousHandler.Resolver Defines a gadget that supports SynchronousHandler.ManagedInputStream and SynchronousHandler.ManagedOutputStream.

Nested classes/interfaces inherited from interface org.shared.net.ConnectionHandler

ConnectionHandler.ClosingType

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	FLAG_BOUND A bit flag indicating that the associated connection has been bound.
protected static int	FLAG_CLOSED A bit flag indicating that the associated connection has been closed.
protected static org.slf4j.Logger	log The static Logger instance.

Fields inherited from class org.shared.net.handler.AbstractFilteredHandler

dummyFuture

Constructor Summary

Constructors

Constructor and Description
SynchronousHandler(String name) Alternate constructor.
SynchronousHandler(String name, int bufferSize) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	debug(String format, Object... args) Logs a debugging message.
InputStream	getInputStream() Gets the InputStream.
OutputStream	getOutputStream() Gets the OutputStream.
void	onBind(Queue<ByteBuffer> inputs) On binding.
void	onClose() On completion of closure.
void	onClosing(ConnectionHandler.ClosingType type, Queue<ByteBuffer> inputs) On closure.
void	onReceive(Queue<ByteBuffer> inputs) On receipt of data.
protected void	setInResolverDisabled() Sets a read SynchronousHandler.Resolver for when read operation interest is disabled.
protected void	setInResolverEnabled() Sets a read SynchronousHandler.Resolver for when read operation interest is enabled.
protected void	setInResolverEos() Sets a read SynchronousHandler.Resolver for when an end-of-stream has been reached.
protected void	setInResolverError(IOException e) Sets an error read SynchronousHandler.Resolver.
protected void	setOutResolverDefault() Sets the default write SynchronousHandler.Resolver.
protected void	setOutResolverError(IOException e) Sets an error write SynchronousHandler.Resolver.
protected void	waitInterruptibly() Waits interruptibly on this connection's monitor.

Methods inherited from class org.shared.net.handler.AbstractFilteredHandler

close, getConnection, onBind, onClosing, onOob, onOob, onReceive, send, setConnection, setFilterFactory, toString

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_BOUND

protected static final int FLAG_BOUND

A bit flag indicating that the associated connection has been bound.

See Also:

Constant Field Values

FLAG_CLOSED

protected static final int FLAG_CLOSED

A bit flag indicating that the associated connection has been closed.

See Also:

Constant Field Values

log

protected static final org.slf4j.Logger log

The static Logger instance.

Constructor Detail

SynchronousHandler

public SynchronousHandler(String name,
                  int bufferSize)

Default constructor.

SynchronousHandler

public SynchronousHandler(String name)

Alternate constructor.

Method Detail

setInResolverEnabled

protected void setInResolverEnabled()

Sets a read SynchronousHandler.Resolver for when read operation interest is enabled.

setInResolverDisabled

protected void setInResolverDisabled()

Sets a read SynchronousHandler.Resolver for when read operation interest is disabled.

setInResolverEos

protected void setInResolverEos()

Sets a read SynchronousHandler.Resolver for when an end-of-stream has been reached.

setInResolverError

protected void setInResolverError(IOException e)

Sets an error read SynchronousHandler.Resolver.

setOutResolverDefault

protected void setOutResolverDefault()

Sets the default write SynchronousHandler.Resolver.

setOutResolverError

protected void setOutResolverError(IOException e)

Sets an error write SynchronousHandler.Resolver.

getInputStream

public InputStream getInputStream()

Gets the InputStream.

getOutputStream

public OutputStream getOutputStream()

Gets the OutputStream.

onBind

public void onBind(Queue<ByteBuffer> inputs)

Description copied from interface: FilteredHandler

On binding.

Parameters:

inputs - the input Queue.

onReceive

public void onReceive(Queue<ByteBuffer> inputs)

Description copied from interface: FilteredHandler

On receipt of data.

Parameters:

inputs - the input Queue.

onClosing

public void onClosing(ConnectionHandler.ClosingType type,
             Queue<ByteBuffer> inputs)

Description copied from interface: FilteredHandler

On closure.

Parameters:

type - the ConnectionHandler.ClosingType.

inputs - the input Queue.

See Also:

ConnectionHandler.ClosingType

onClose

public void onClose()

Description copied from interface: ConnectionHandler

On completion of closure.

waitInterruptibly

protected void waitInterruptibly()
                          throws IOException

Waits interruptibly on this connection's monitor.

Throws:

IOException - when the current operation is interrupted; wraps an InterruptedException.

debug

protected static final void debug(String format,
         Object... args)

Logs a debugging message.