org.michailov.async.io

Class AsyncCharDecoder

java.lang.Object

org.michailov.async.AsyncAgent

org.michailov.async.io.AsyncCharDecoder

public class AsyncCharDecoder
extends AsyncAgent

Asynchronous decoder of bytes into chars.

See Also:

WhenReady, AsyncAgent, ByteRingBuffer, CharRingBuffer

Constructor Summary

Constructors

Constructor and Description
AsyncCharDecoder(ByteRingBuffer byteRingBuffer, CharRingBuffer charRingBuffer, CharsetAsyncOptions charsetAsyncOptions) Constructs an AsyncCharDecoder instance over the given ring buffers.

Method Summary

Modifier and Type	Method and Description
protected void	action() "action" function that reads bytes from the input byte ring buffer and writes chars to the output char ring buffer.
protected boolean	done() "done" predicate that returns true when this async agent wants to quit the current async loop.
ByteRingBuffer	getByteRingBuffer() Returns the attached byte ring buffer from where bytes will be read.
CharRingBuffer	getCharRingBuffer() Returns the attached char ring buffer where chars will be written.
boolean	isEOF() Checks whether this decoder has reached EOF of the input byte ring buffer.
protected boolean	ready() "ready" predicate that returns true when bytes can be read from the input byte ring buffer and chars can be written to the output char ring buffer without blocking.

Methods inherited from class org.michailov.async.AsyncAgent

applyAsync, isIdle, setIdle, setIdleAndThrow, startApplyLoopAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncCharDecoder

public AsyncCharDecoder(ByteRingBuffer byteRingBuffer,
                        CharRingBuffer charRingBuffer,
                        CharsetAsyncOptions charsetAsyncOptions)

Constructs an AsyncCharDecoder instance over the given ring buffers.

Parameters:

byteRingBuffer - ByteRingBuffer to read bytes from.

charRingBuffer - CharRingBuffer to write chars to.

charsetAsyncOptions - CharsetAsyncOptions to use for all async operations.

Method Detail

getByteRingBuffer

public ByteRingBuffer getByteRingBuffer()

Returns the attached byte ring buffer from where bytes will be read.

Returns:

The attached byte ring buffer from where bytes will be read.

getCharRingBuffer

public CharRingBuffer getCharRingBuffer()

Returns the attached char ring buffer where chars will be written.

Returns:

The attached char ring buffer where chars will be written.

isEOF

public boolean isEOF()

Checks whether this decoder has reached EOF of the input byte ring buffer.

Returns:

true iff EOF has been reached or an exception has been encountered.

ready

protected boolean ready()

"ready" predicate that returns true when bytes can be read from the input byte ring buffer and chars can be written to the output char ring buffer without blocking.

Overrides:

ready in class AsyncAgent

Returns:

Derived classes should override this method to return true iff it is time to execute AsyncAgent.action().

done

protected boolean done()

"done" predicate that returns true when this async agent wants to quit the current async loop.

Overrides:

done in class AsyncAgent

Returns:

Derived classes should override this method to return true iff it is time for the loop to stop.

action

protected void action()

"action" function that reads bytes from the input byte ring buffer and writes chars to the output char ring buffer.

Overrides:

action in class AsyncAgent