org.jperipheral

Interface InterruptibleByteChannel

public interface InterruptibleByteChannel

An AsynchronousByteChannel whose operations may be interrupted.

Author:

Gili Tzabari

Method Summary

Methods

Modifier and Type	Method and Description
<A> void	close(A attachment, CompletionHandler<Void,? super A> handler) Closes this channel.
<A> void	read(ByteBuffer target, long timeout, TimeUnit unit, A attachment, CompletionHandler<Integer,? super A> handler) Reads a sequence of bytes from this channel into the given buffer.
<A> void	write(ByteBuffer source, long timeout, TimeUnit unit, A attachment, CompletionHandler<Integer,? super A> handler) Writes a sequence of bytes to this channel from the given buffer.

Method Detail

read

<A> void read(ByteBuffer target,
            long timeout,
            TimeUnit unit,
            A attachment,
            CompletionHandler<Integer,? super A> handler)
          throws IllegalArgumentException,
                 ReadPendingException,
                 ShutdownChannelGroupException

Reads a sequence of bytes from this channel into the given buffer.

This method initiates an asynchronous read operation to read a sequence of bytes from this channel into the given buffer. The handler parameter is a completion handler that is invoked when the read operation completes (or fails). The result passed to the completion handler is the number of bytes read or -1 if no bytes could be read because the channel has reached end-of-stream.

If a timeout is specified and the timeout elapses before the operation completes then the operation completes with the exception InterruptedByTimeoutException. Where a timeout occurs, and the implementation cannot guarantee that bytes have not been read, or will not be read from the channel into the given buffer, then further attempts to read from the channel will cause an unspecific runtime exception to be thrown.

Otherwise this method works in the same manner as the AsynchronousByteChannel.read(ByteBuffer,Object,CompletionHandler) method.

Type Parameters:

A - The attachment type

Parameters:

target - The buffer into which bytes are to be transferred

timeout - The timeout, or 0L for no timeout

unit - The time unit of the timeout argument

attachment - The object to attach to the I/O operation; can be null

handler - The handler for consuming the result

Throws:

IllegalArgumentException - If the timeout parameter is negative or the buffer is read-only

ReadPendingException - If the channel does not allow more than one read to be outstanding and a previous read has not completed

ShutdownChannelGroupException - If the channel is associated with a group that has terminated

UnsupportedOperationException - If the implementation does not support this operation

write

<A> void write(ByteBuffer source,
             long timeout,
             TimeUnit unit,
             A attachment,
             CompletionHandler<Integer,? super A> handler)

Writes a sequence of bytes to this channel from the given buffer. (optional operation)

This method initiates an asynchronous write operation to write a sequence of bytes to this channel from the given buffer. The handler parameter is a completion handler that is invoked when the write operation completes (or fails). The result passed to the completion handler is the number of bytes written.

If a timeout is specified and the timeout elapses before the operation completes then it completes with the exception InterruptedByTimeoutException. Where a timeout occurs, and the implementation cannot guarantee that bytes have not been written, or will not be written to the channel from the given buffer, then further attempts to write to the channel will cause an unspecific runtime exception to be thrown.

Otherwise this method works in the same manner as the AsynchronousByteChannel#write(ByteBuffer,Object,CompletionHandler,boolean) method.

Type Parameters:

A - The attachment type

Parameters:

source - The buffer from which bytes are to be retrieved

timeout - The timeout, or 0L for no timeout

unit - The time unit of the timeout argument

attachment - The object to attach to the I/O operation; can be null

handler - The handler for consuming the result

Throws:

IllegalArgumentException - If the timeout parameter is negative

WritePendingException - If the channel does not allow more than one write to be outstanding and a previous write has not completed

ShutdownChannelGroupException - If the channel is associated with a group that has terminated

UnsupportedOperationException - If the implementation does not support this operation

close

<A> void close(A attachment,
             CompletionHandler<Void,? super A> handler)

Closes this channel. The underlying channel might take an arbitrary amount of time to cancel outstanding operations. As such, this method returns immediately and a completion handler is notified when the operation completes.

This method otherwise behaves exactly as specified by AsynchronousChannel.close().

Type Parameters:

A - The attachment type

Parameters:

attachment - The object to attach to the I/O operation; can be null

handler - The handler for consuming the result