org.activeio.filter
Class SynchornizedSyncChannel

java.lang.Object
  extended by org.activeio.FilterSyncChannel
      extended by org.activeio.filter.SynchornizedSyncChannel
All Implemented Interfaces:
Channel, Disposable, InputSyncChannel, OutputChannel, Service, SyncChannel

public class SynchornizedSyncChannel
extends FilterSyncChannel

Used to synchronize concurrent access to a SynchChannel. Uses two different Sync objects for write and read operations. All other operations such as stop(long) and stop(long) just do a normal java synchronization against the SynchornizedSynchChannel object instance.


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
SynchornizedSyncChannel(SyncChannel next)
           
SynchornizedSyncChannel(SyncChannel next, Sync readLock, Sync writeLock)
           
 
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.
 Sync getReadLock()
           
 Sync getWriteLock()
           
 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.
 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.
 void write(Packet packet)
          Sends a packet down the channel towards the media.
 
Methods inherited from class org.activeio.FilterSyncChannel
getNext, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SynchornizedSyncChannel

public SynchornizedSyncChannel(SyncChannel next)

SynchornizedSyncChannel

public SynchornizedSyncChannel(SyncChannel next,
                               Sync readLock,
                               Sync writeLock)
Method Detail

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
Overrides:
read in class FilterSyncChannel
Returns:
the packet received or null if the timeout occurred.
Throws:
IOException
See Also:
InputSyncChannel.read(long)

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
Overrides:
write in class FilterSyncChannel
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
Overrides:
flush in class FilterSyncChannel
Throws:
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
Overrides:
dispose in class FilterSyncChannel
See Also:
Disposable.dispose()

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
Overrides:
narrow in class FilterSyncChannel

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
Overrides:
start in class FilterSyncChannel
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
Overrides:
stop in class FilterSyncChannel
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)

getReadLock

public Sync getReadLock()

getWriteLock

public Sync getWriteLock()


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