org.activeio.net
Class VMPipeAsynchChannelPipe.PipeChannel

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

All Implemented Interfaces:

AsynchChannel, Channel, Disposable, InputAsynchChannel, OutputChannel, Service

Enclosing class:

VMPipeAsynchChannelPipe

public static final class VMPipeAsynchChannelPipe.PipeChannel

extends java.lang.Object

implements AsynchChannel

Field Summary

Fields inherited from interface org.activeio.Service

NO_WAIT_TIMEOUT, WAIT_FOREVER_TIMEOUT

Constructor Summary

VMPipeAsynchChannelPipe.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.
AsynchChannelListener	getAsynchChannelListener()
java.lang.String	getId()
VMPipeAsynchChannelPipe.PipeChannel	getSibiling()
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.
void	setAsynchChannelListener(AsynchChannelListener channelListener) Registers the ChannelConsumer that the protcol will use to deliver packets comming 'up' the channel.
void	setSibiling(VMPipeAsynchChannelPipe.PipeChannel sibiling)
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

VMPipeAsynchChannelPipe.PipeChannel

public VMPipeAsynchChannelPipe.PipeChannel()

Method Detail

setAsynchChannelListener

public void setAsynchChannelListener(AsynchChannelListener channelListener)

Description copied from interface: InputAsynchChannel

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

Specified by:

setAsynchChannelListener in interface InputAsynchChannel

getAsynchChannelListener

public AsynchChannelListener getAsynchChannelListener()

Specified by:

getAsynchChannelListener in interface InputAsynchChannel

Returns:

the registered Packet consumer

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

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

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

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

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 VMPipeAsynchChannelPipe.PipeChannel getSibiling()

setSibiling

public void setSibiling(VMPipeAsynchChannelPipe.PipeChannel sibiling)

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

getId

public java.lang.String getId()

toString

public java.lang.String toString()