org.shared.net.handler

Class AbstractFilteredHandler<H extends AbstractFilteredHandler<H,C,T>,C extends Connection,T>

java.lang.Object

org.shared.net.handler.AbstractFilteredHandler<H,C,T>

Type Parameters:

H - the parameterization lower bounded by AbstractFilteredHandler itself.

C - the Connection type.

T - the Filter inbound type.

All Implemented Interfaces:

Closeable, AutoCloseable, ConnectionHandler<C>, FilteredHandler<H,C,T>, OobHandler<C>

Direct Known Subclasses:

ClientServerTest.Utf8Handler, SynchronousHandler, XmlHandler

public abstract class AbstractFilteredHandler<H extends AbstractFilteredHandler<H,C,T>,C extends Connection,T>
extends Object
implements FilteredHandler<H,C,T>, OobHandler<C>, Closeable

An abstract base class implementing much of FilteredHandler.

Nested Class Summary

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

ConnectionHandler.ClosingType

Field Summary

Fields

Modifier and Type	Field and Description
protected static Future<?>	dummyFuture A trivial Future that returns immediately with null.

Constructor Summary

Constructors

Constructor and Description
AbstractFilteredHandler(String name) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
C	getConnection() Gets the Connection associated with this handler.
void	onBind() On binding.
void	onClosing(ConnectionHandler.ClosingType type, ByteBuffer bb) On closure.
Future<?>	onOob(OobEvent evt) On receipt of a user-defined OobEvent.
protected void	onOob(OobEvent evt, ByteBuffer bb) Propagates the given OobEvent through the underlying OobFilter.
void	onReceive(ByteBuffer bb) On receipt of data.
int	send(T output) Sends the given output value to the remote host.
void	setConnection(C connection) Sets the Connection associated with this handler.
H	setFilterFactory(FilterFactory<? extends Filter<T,ByteBuffer>,T,ByteBuffer,? super H> filterFactory) Sets the FilterFactory from which appropriate Filters will be derived.
String	toString() Creates a human-readable representation of this handler.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.shared.net.handler.FilteredHandler

onBind, onClosing, onReceive

Methods inherited from interface org.shared.net.ConnectionHandler

onClose

Field Detail

dummyFuture

protected static final Future<?> dummyFuture

A trivial Future that returns immediately with null.

Constructor Detail

AbstractFilteredHandler

public AbstractFilteredHandler(String name)

Default constructor.

Method Detail

setFilterFactory

public H setFilterFactory(FilterFactory<? extends Filter<T,ByteBuffer>,T,ByteBuffer,? super H> filterFactory)

Description copied from interface: FilteredHandler

Sets the FilterFactory from which appropriate Filters will be derived.

Specified by:

setFilterFactory in interface FilteredHandler<H extends AbstractFilteredHandler<H,C,T>,C extends Connection,T>

Parameters:

filterFactory - the FilterFactory.

send

public int send(T output)

Description copied from interface: FilteredHandler

Sends the given output value to the remote host.

Specified by:

send in interface FilteredHandler<H extends AbstractFilteredHandler<H,C,T>,C extends Connection,T>

Parameters:

output - the output value.

Returns:

the number of units remaining to be written.

onBind

public void onBind()

Description copied from interface: ConnectionHandler

On binding.

Specified by:

onBind in interface ConnectionHandler<C extends Connection>

onReceive

public void onReceive(ByteBuffer bb)

Description copied from interface: ConnectionHandler

On receipt of data.

Specified by:

onReceive in interface ConnectionHandler<C extends Connection>

Parameters:

bb - the ByteBuffer containing data.

onClosing

public void onClosing(ConnectionHandler.ClosingType type,
             ByteBuffer bb)

Description copied from interface: ConnectionHandler

On closure.

Specified by:

onClosing in interface ConnectionHandler<C extends Connection>

Parameters:

type - the ConnectionHandler.ClosingType.

bb - the ByteBuffer containing data. It must be completely drained, as this is the final callback.

See Also:

ConnectionHandler.ClosingType

onOob

public Future<?> onOob(OobEvent evt)

Description copied from interface: OobHandler

On receipt of a user-defined OobEvent.

Specified by:

onOob in interface OobHandler<C extends Connection>

Parameters:

evt - the OobEvent.

Returns:

a Future for waiting on completion of out-of-band processing, which may occur asynchronously on another thread.

getConnection

public C getConnection()

Description copied from interface: ConnectionHandler

Gets the Connection associated with this handler.

Specified by:

getConnection in interface ConnectionHandler<C extends Connection>

setConnection

public void setConnection(C connection)

Description copied from interface: ConnectionHandler

Sets the Connection associated with this handler.

Specified by:

setConnection in interface ConnectionHandler<C extends Connection>

Parameters:

connection - the Connection.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

toString

public String toString()

Description copied from interface: ConnectionHandler

Creates a human-readable representation of this handler.

Specified by:

toString in interface ConnectionHandler<C extends Connection>

Overrides:

toString in class Object

onOob

protected void onOob(OobEvent evt,
         ByteBuffer bb)

Propagates the given OobEvent through the underlying OobFilter.