org.avineas.io.notify

Class NotifyingReadChannel<C extends ReadChannel>

java.lang.Object

org.avineas.io.notify.NotifyingReadChannel<C>

All Implemented Interfaces:

java.io.Closeable, Notifier, ReadChannel

Direct Known Subclasses:

NotifyingChannelWrapper

public class NotifyingReadChannel<C extends ReadChannel>
extends java.lang.Object
implements ReadChannel, Notifier

Wrapper around another channel to add notification to a read channel. This means that this object can notify objects about data that is available on the channel.

Author:

Arie van Wijngaarden

Nested Class Summary

Nested classes/interfaces inherited from interface org.avineas.io.notify.Notifier

Notifier.Listener

Constructor Summary

Constructors

Constructor and Description
NotifyingReadChannel(C wrapped, int maxSize) Add notification to a read channel.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	notify(Notifier.Listener toNotify) Set the listener to notify when data is available.
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 class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotifyingReadChannel

public NotifyingReadChannel(C wrapped,
                    int maxSize)

Add notification to a read channel.

Parameters:

wrapped - The channel that is wrapped

maxSize - The max. size of packets that can appear on the wrapped channel. This size is used to read packets from the wrapped channel via a separate thread

Method Detail

read

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

Description copied from interface: ReadChannel

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

Specified by:

read in interface ReadChannel

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

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

notify

public void notify(Notifier.Listener toNotify)

Description copied from interface: Notifier

Set the listener to notify when data is available.

Specified by:

notify in interface Notifier

Parameters:

toNotify - The object to notify