|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.activeio.FilterAsyncChannel
public class FilterAsyncChannel
A AsyncChannelFilter can be used as a filter between a AsyncChannel
and it's org.activeio.ChannelConsumer
. Most AsyncChannel
that are not directly accessing the network will extends the AsyncChannelFilter since they act as a
filter between the client and the network. O
Field Summary | |
---|---|
protected AsyncChannelListener |
channelListener
|
protected AsyncChannel |
next
|
Fields inherited from interface org.activeio.Service |
---|
NO_WAIT_TIMEOUT, WAIT_FOREVER_TIMEOUT |
Fields inherited from interface org.activeio.Service |
---|
NO_WAIT_TIMEOUT, WAIT_FOREVER_TIMEOUT |
Constructor Summary | |
---|---|
FilterAsyncChannel(AsyncChannel 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. |
AsyncChannelListener |
getAsyncChannelListener()
|
AsyncChannel |
getNext()
|
Object |
narrow(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. |
void |
onPacket(Packet packet)
A AsyncChannel will call this method to deliver an 'up' packet to a consumer. |
void |
onPacketError(IOException error)
A AsyncChannel will call this method when a async failure occurs in the channel. |
void |
setAsyncChannelListener(AsyncChannelListener channelListener)
Registers the ChannelConsumer that the protcol will use to deliver packets
coming 'up' the channel. |
void |
start()
Starts the channel. |
void |
stop(long timeout)
Stops the channel. |
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 |
Field Detail |
---|
protected final AsyncChannel next
protected AsyncChannelListener channelListener
Constructor Detail |
---|
public FilterAsyncChannel(AsyncChannel next)
Method Detail |
---|
public void setAsyncChannelListener(AsyncChannelListener channelListener)
InputAsyncChannel
ChannelConsumer
that the protcol will use to deliver packets
coming 'up' the channel.
setAsyncChannelListener
in interface InputAsyncChannel
public void write(Packet packet) throws IOException
OutputChannel
write
in interface OutputChannel
IOException
public void flush() throws IOException
OutputChannel
flush
in interface OutputChannel
IOException
public void dispose()
Disposable
dispose
in interface Disposable
Disposable.dispose()
public void start() throws IOException
Service
start
in interface Service
IOException
- if the next channel has not been set.Service.start()
public void stop(long timeout) throws IOException
Service
stop
in interface Service
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.
IOException
Service.stop(long)
public void onPacket(Packet packet)
AsyncChannelListener
AsyncChannel
will call this method to deliver an 'up' packet to a consumer.
onPacket
in interface AsyncChannelListener
AsyncChannelListener.onPacket(org.activeio.Packet)
public void onPacketError(IOException error)
AsyncChannelListener
AsyncChannel
will call this method when a async failure occurs in the channel.
onPacketError
in interface AsyncChannelListener
error
- the exception that describes the failure.org.activeio.AsyncChannelListener#onPacketError(org.activeio.ChannelException)
public AsyncChannel getNext()
public AsyncChannelListener getAsyncChannelListener()
getAsyncChannelListener
in interface InputAsyncChannel
public Object narrow(Class target)
Channel
narrow
in interface Channel
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |