org.activeio
Interface InputSynchChannel

All Superinterfaces:
Channel, Disposable, Service
All Known Subinterfaces:
SynchChannel
All Known Implementing Classes:
AsynchToSynchChannelAdapter, DatagramSocketSynchChannel, FilterSynchChannel, NIOSynchChannel, SocketSynchChannel

public interface InputSynchChannel
extends Channel

SynchChannel objets allow threadd to synchronously block on the read method to get org.activeio.channel.Packet objects when they arrive from the peer.

Version:
$Revision$

Field Summary
 
Fields inherited from interface org.activeio.Service
NO_WAIT_TIMEOUT, WAIT_FOREVER_TIMEOUT
 
Method Summary
 Packet read(long timeout)
          Used to synchonously receive a packet of information going 'up' the channel.
 
Methods inherited from interface org.activeio.Channel
narrow
 
Methods inherited from interface org.activeio.Disposable
dispose
 
Methods inherited from interface org.activeio.Service
start, stop
 

Method Detail

read

public Packet read(long timeout)
            throws java.io.IOException
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.

Parameters:
timeout -
Returns:
the packet recived or null if the timeout occured.
Throws:
java.io.IOException


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