org.activeio.net
Class VMPipeAsyncChannelPipe.PipeChannel

java.lang.Object
  org.activeio.net.VMPipeAsyncChannelPipe.PipeChannel

All Implemented Interfaces:

AsyncChannel, Channel, Disposable, InputAsyncChannel, OutputChannel, Service

Enclosing class:

VMPipeAsyncChannelPipe

public static final class VMPipeAsyncChannelPipe.PipeChannel
extends Object
implements AsyncChannel

Field Summary

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

VMPipeAsyncChannelPipe.PipeChannel()

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()
String	getId()
VMPipeAsyncChannelPipe.PipeChannel	getSibiling()
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	setAsyncChannelListener(AsyncChannelListener channelListener) Registers the ChannelConsumer that the protcol will use to deliver packets coming 'up' the channel.
void	setSibiling(VMPipeAsyncChannelPipe.PipeChannel sibiling)
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

Constructor Detail

VMPipeAsyncChannelPipe.PipeChannel

public VMPipeAsyncChannelPipe.PipeChannel()

Method Detail

setAsyncChannelListener

public void setAsyncChannelListener(AsyncChannelListener channelListener)

Description copied from interface: InputAsyncChannel

Registers the ChannelConsumer that the protcol will use to deliver packets coming 'up' the channel.

Specified by:

setAsyncChannelListener in interface InputAsyncChannel

getAsyncChannelListener

public AsyncChannelListener getAsyncChannelListener()

Specified by:

getAsyncChannelListener in interface InputAsyncChannel

Returns:

the registered Packet consumer

write

public void write(Packet packet)
           throws IOException

Description copied from interface: OutputChannel

Sends a packet down the channel towards the media.

Specified by:

write in interface OutputChannel

Throws:

IOException

flush

public void flush()
           throws 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:

IOException

start

public void start()
           throws 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:

IOException

stop

public void stop(long timeout)
          throws 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:

IOException

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

getSibiling

public VMPipeAsyncChannelPipe.PipeChannel getSibiling()

setSibiling

public void setSibiling(VMPipeAsyncChannelPipe.PipeChannel sibiling)

narrow

public Object narrow(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

getId

public String getId()

toString

public String toString()

Overrides:

toString in class Object