org.activeio.filter
Class SynchornizedSynchChannel

java.lang.Object
  org.activeio.FilterSynchChannel
      org.activeio.filter.SynchornizedSynchChannel

All Implemented Interfaces:

Channel, Disposable, InputSynchChannel, OutputChannel, Service, SynchChannel

public class SynchornizedSynchChannel

extends FilterSynchChannel

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

Constructor Summary

SynchornizedSynchChannel(SynchChannel next)

SynchornizedSynchChannel(SynchChannel next, EDU.oswego.cs.dl.util.concurrent.Sync readLock, EDU.oswego.cs.dl.util.concurrent.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.
EDU.oswego.cs.dl.util.concurrent.Sync	getReadLock()
EDU.oswego.cs.dl.util.concurrent.Sync	getWriteLock()
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.
Packet	read(long timeout) Used to synchonously 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.FilterSynchChannel

getNext, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SynchornizedSynchChannel

public SynchornizedSynchChannel(SynchChannel next)

SynchornizedSynchChannel

public SynchornizedSynchChannel(SynchChannel next,
                                EDU.oswego.cs.dl.util.concurrent.Sync readLock,
                                EDU.oswego.cs.dl.util.concurrent.Sync writeLock)

Method Detail

read

public Packet read(long timeout)
            throws java.io.IOException

Description copied from interface: InputSynchChannel

Used to synchonously 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 InputSynchChannel

Overrides:

read in class FilterSynchChannel

Throws:

java.io.IOException

See Also:

InputSynchChannel.read(long)

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

Overrides:

write in class FilterSynchChannel

Throws:

java.io.IOException

See Also:

org.activeio.Channel#write(org.activeio.channel.Packet)

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

Overrides:

flush in class FilterSynchChannel

Throws:

java.io.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 FilterSynchChannel

See Also:

Disposable.dispose()

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

Overrides:

narrow in class FilterSynchChannel

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

Overrides:

start in class FilterSynchChannel

Throws:

java.io.IOException

See Also:

Service.start()

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

Overrides:

stop in class FilterSynchChannel

Throws:

java.io.IOException

See Also:

Service.stop(long)

getReadLock

public EDU.oswego.cs.dl.util.concurrent.Sync getReadLock()

getWriteLock

public EDU.oswego.cs.dl.util.concurrent.Sync getWriteLock()