org.activeio.adapter
Class AsyncToSyncChannel

java.lang.Object
  extended by org.activeio.adapter.AsyncToSyncChannel
All Implemented Interfaces:
AsyncChannelListener, Channel, Disposable, InputSyncChannel, OutputChannel, Service, SyncChannel

public final class AsyncToSyncChannel
extends Object
implements SyncChannel, AsyncChannelListener

Adapts a AsyncChannel so that it provides an org.activeio.SynchChannel interface. This object buffers asynchronous messages from the AsyncChannel and buffers them in a Channel util the client receives them.

Version:
$Revision$

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
AsyncToSyncChannel(AsyncChannel asyncChannel)
          Deprecated. #adapt(AsyncChannel)
AsyncToSyncChannel(AsyncChannel asyncChannel, Channel upPacketChannel)
          Deprecated. #adapt(AsyncChannel, Channel)
 
Method Summary
static SyncChannel adapt(Channel channel)
           
static SyncChannel adapt(Channel channel, Channel upPacketChannel)
           
 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.
 AsyncChannel getAsyncChannel()
           
 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.
 Packet read(long timeout)
          Used to synchronously receive a packet of information going '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
 

Constructor Detail

AsyncToSyncChannel

public AsyncToSyncChannel(AsyncChannel asyncChannel)
Deprecated. #adapt(AsyncChannel)


AsyncToSyncChannel

public AsyncToSyncChannel(AsyncChannel asyncChannel,
                          Channel upPacketChannel)
Deprecated. #adapt(AsyncChannel, Channel)

Method Detail

adapt

public static SyncChannel adapt(Channel channel)

adapt

public static SyncChannel adapt(Channel channel,
                                Channel upPacketChannel)

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
See Also:
org.activeio.Channel#write(org.activeio.Packet)

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
See Also:
org.activeio.Channel#flush()

read

public Packet read(long timeout)
            throws IOException
Description copied from interface: InputSyncChannel
Used to synchronously 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 InputSyncChannel
Returns:
the packet received or null if the timeout occurred.
Throws:
IOException
See Also:
InputSyncChannel.read(long)

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 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
See Also:
Service.start()

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
See Also:
Service.stop(long)

onPacket

public void onPacket(Packet packet)
Description copied from interface: AsyncChannelListener
A AsyncChannel will call this method to deliver an 'up' packet to a consumer.

Specified by:
onPacket in interface AsyncChannelListener
See Also:
AsyncChannelListener.onPacket(org.activeio.Packet)

onPacketError

public void onPacketError(IOException error)
Description copied from interface: AsyncChannelListener
A AsyncChannel will call this method when a async failure occurs in the channel.

Specified by:
onPacketError in interface AsyncChannelListener
Parameters:
error - the exception that describes the failure.
See Also:
org.activeio.AsyncChannelListener#onPacketError(org.activeio.ChannelException)

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

getAsyncChannel

public AsyncChannel getAsyncChannel()

toString

public String toString()
Overrides:
toString in class Object


Copyright © -2009 The ActiveIO Project. All Rights Reserved.