org.activeio
Interface InputSyncChannel

All Superinterfaces:
Channel, Disposable, Service
All Known Subinterfaces:
SyncChannel
All Known Implementing Classes:
AsyncToSyncChannel, DatagramSocketSyncChannel, FilterSyncChannel, NIOSyncChannel, SocketSyncChannel

public interface InputSyncChannel
extends Channel

SynchChannel objects allow threaded to synchronously block on the read method to get 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 synchronously 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 IOException
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.

Parameters:
timeout -
Returns:
the packet received or null if the timeout occurred.
Throws:
IOException


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