org.avineas.io

Interface ReadChannel

All Superinterfaces:

java.io.Closeable

All Known Subinterfaces:

Channel, NotifyingChannel

All Known Implementing Classes:

NotifyingChannelWrapper, NotifyingReadChannel, ServerSocketChannel, SocketChannel

public interface ReadChannel
extends java.io.Closeable

Read channel, channel from which information/packets can be read. Basic interface for reading data from any medium via which communication can take place.

Author:

Arie van Wijngaarden

Method Summary

Methods

Modifier and Type	Method and Description
int	read(byte[] data, int offset, long timeout) Read a packet or byte array from the channel, filling up either the data buffer or the information as present in the packet.

Methods inherited from interface java.io.Closeable

close

Method Detail

read

int read(byte[] data,
       int offset,
       long timeout)

Read a packet or byte array from the channel, filling up either the data buffer or the information as present in the packet.

Parameters:

data - The byte buffer to read into

offset - The offset in the buffer to start reading

timeout - The timeout to wait for the first byte of data to become available, in ms. If a value <= 0 is passed, no waiting is done at all

Returns:

The number of bytes read. -1 on error, 0 if no data available within the timeout. The returned number of bytes may be less than would be expected given the size of the data buffer