org.michailov.async.io

Class AsyncCharEncoder

java.lang.Object

org.michailov.async.AsyncAgent

org.michailov.async.io.AsyncCharEncoder

public class AsyncCharEncoder
extends AsyncAgent

Asynchronous encoder of chars into bytes.

See Also:

WhenReady, AsyncAgent, ByteRingBuffer, CharRingBuffer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	action() "action" function that reads chars from the input char ring buffer and writes bytes to the output byte 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 where bytes will be written.
CharRingBuffer	getCharRingBuffer() Returns the attached char ring buffer from where chars will be read.
boolean	isEOF() Checks whether this decoder has reached EOF of the input char ring buffer.
protected boolean	ready() "ready" predicate that returns true when chars can be read from the input char ring buffer and bytes can be written to the output byte 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

AsyncCharEncoder

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

Constructs an AsyncCharEncoder instance over the given ring buffers.

Parameters:

charRingBuffer - CharRingBuffer to read chars from.

byteRingBuffer - ByteRingBuffer to write bytes to.

charsetAsyncOptions - CharsetAsyncOptions to use for all async operations.

Method Detail

getCharRingBuffer

public CharRingBuffer getCharRingBuffer()

Returns the attached char ring buffer from where chars will be read.

Returns:

The attached char ring buffer from where chars will be read.

getByteRingBuffer

public ByteRingBuffer getByteRingBuffer()

Returns the attached byte ring buffer where bytes will be written.

Returns:

The attached byte ring buffer where bytes will be written.

isEOF

public boolean isEOF()

Checks whether this decoder has reached EOF of the input char 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 chars can be read from the input char ring buffer and bytes can be written to the output byte 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 chars from the input char ring buffer and writes bytes to the output byte ring buffer.

Overrides:

action in class AsyncAgent