org.activeio
Class FilterSynchChannel

java.lang.Object
  org.activeio.FilterSynchChannel

All Implemented Interfaces:

Channel, Disposable, InputSynchChannel, OutputChannel, Service, SynchChannel

Direct Known Subclasses:

PacketAggregatingSynchChannel, PushbackSynchChannel, SynchornizedSynchChannel, WriteBufferedSynchChannel

public class FilterSynchChannel

extends java.lang.Object

implements SynchChannel

A SynchChannelFilter can be used as a filter another SynchChannel Most SynchChannel that are not directly accessing the network will extends the SynchChannelFilter since they act as a filter between the client and the network.

Version:

$Revision$

Field Summary

Fields inherited from interface org.activeio.Service

NO_WAIT_TIMEOUT, WAIT_FOREVER_TIMEOUT

Constructor Summary

FilterSynchChannel(SynchChannel next)

Method Summary

void	dispose() This method should not throw any exceptions.
void	flush() Some channels may buffer data which may be sent down if flush() is called.
SynchChannel	getNext()
java.lang.Object	narrow(java.lang.Class target) Since a Channel may be composed from a chain of other Channel obejcts, this method allows you to query the chain for the specified interface.
Packet	read(long timeout) Used to synchonously receive a packet of information going 'up' the channel.
void	start() Starts the channel.
void	stop(long timeout) Stops the channel.
java.lang.String	toString()
void	write(Packet packet) Sends a packet down the channel towards the media.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterSynchChannel

public FilterSynchChannel(SynchChannel next)

Method Detail

write

public void write(Packet packet)
           throws java.io.IOException

Description copied from interface: OutputChannel

Sends a packet down the channel towards the media.

Specified by:

write in interface OutputChannel

Parameters:

packet -

Throws:

java.io.IOException

See Also:

org.activeio.Channel#write(org.activeio.channel.Packet)

flush

public void flush()
           throws java.io.IOException

Description copied from interface: OutputChannel

Some channels may buffer data which may be sent down if flush() is called.

Specified by:

flush in interface OutputChannel

Throws:

java.io.IOException

See Also:

org.activeio.Channel#flush()

dispose

public void dispose()

Description copied from interface: Disposable

This method should not throw any exceptions. Cleaning up a Disposable object should be easy of an end user therefore do not make him have to handle an Exception.

Specified by:

dispose in interface Disposable

See Also:

Disposable.dispose()

start

public void start()
           throws java.io.IOException

Description copied from interface: Service

Starts the channel. Once started, the channel is in the running state.

Specified by:

start in interface Service

Throws:

java.io.IOException

See Also:

Service.start()

stop

public void stop(long timeout)
          throws java.io.IOException

Description copied from interface: Service

Stops the channel. Once stopped, the channel is in the stopped state.

Specified by:

stop in interface Service

Parameters:

timeout - The amount of time the channel is allowed to take to gracefully stop. If the timeout is exceeded, the channel should do a forcefull stop.

Throws:

java.io.IOException

See Also:

Service.stop(long)

getNext

public SynchChannel getNext()

Returns:

Returns the next.

read

public Packet read(long timeout)
            throws java.io.IOException

Description copied from interface: InputSynchChannel

Used to synchonously receive a packet of information going 'up' the channel. This method blocks until a packet is received or the operation experiences timeout.

Specified by:

read in interface InputSynchChannel

Parameters:

timeout -

Returns:

the packet recived or null if the timeout occured.

Throws:

java.io.IOException

See Also:

InputSynchChannel.read(long)

narrow

public java.lang.Object narrow(java.lang.Class target)

Description copied from interface: Channel

Since a Channel may be composed from a chain of other Channel obejcts, this method allows you to query the chain for the specified interface. The first Channel in the chain the implments the requested interface will be return an implementing object. If no Channel in the chain implements the requested class, then null is returned.

Specified by:

narrow in interface Channel

toString

public java.lang.String toString()