org.microbean.jersey.netty

Class AbstractByteBufBackedChannelOutboundInvokingOutputStream<T>

java.lang.Object

java.io.OutputStream

org.microbean.jersey.netty.AbstractChannelOutboundInvokingOutputStream<T>

org.microbean.jersey.netty.AbstractByteBufBackedChannelOutboundInvokingOutputStream<T>

Type Parameters:

T - the type of message that will be written; see createMessage(ByteBuf)

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

ByteBufBackedChannelOutboundInvokingHttp2DataFrameOutputStream, ByteBufBackedChannelOutboundInvokingHttpContentOutputStream

public abstract class AbstractByteBufBackedChannelOutboundInvokingOutputStream<T>
extends AbstractChannelOutboundInvokingOutputStream<T>

An AbstractChannelOutboundInvokingOutputStream that creates its messages from ByteBuf instances.

Author:

Laird Nelson

See Also:

createMessage(ByteBuf)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator A creator of ByteBufs that uses a byte array or a portion of a byte array as its raw materials.

Field Summary

Fields inherited from class org.microbean.jersey.netty.AbstractChannelOutboundInvokingOutputStream

channelOutboundInvoker, closeChannelOutboundInvoker

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractByteBufBackedChannelOutboundInvokingOutputStream(ChannelOutboundInvoker channelOutboundInvoker, boolean closeChannelOutboundInvoker) Creates a new AbstractByteBufBackedChannelOutboundInvokingOutputStream.
protected	AbstractByteBufBackedChannelOutboundInvokingOutputStream(ChannelOutboundInvoker channelOutboundInvoker, int flushThreshold, boolean closeChannelOutboundInvoker) Creates a new AbstractByteBufBackedChannelOutboundInvokingOutputStream.
protected	AbstractByteBufBackedChannelOutboundInvokingOutputStream(ChannelOutboundInvoker channelOutboundInvoker, int flushThreshold, boolean closeChannelOutboundInvoker, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator) Creates a new AbstractByteBufBackedChannelOutboundInvokingOutputStream.

Method Summary

Modifier and Type	Method and Description
protected T	createMessage(byte[] bytes, int offset, int length) Returns the result of invoking the createMessage(ByteBuf) method with a ByteBuf returned by the AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator supplied at construction time.
protected abstract T	createMessage(ByteBuf content) Creates and returns a new message to be written.

Methods inherited from class org.microbean.jersey.netty.AbstractChannelOutboundInvokingOutputStream

close, createLastMessage, createMessage, flush, getFlushThreshold, newPromise, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractByteBufBackedChannelOutboundInvokingOutputStream

protected AbstractByteBufBackedChannelOutboundInvokingOutputStream(ChannelOutboundInvoker channelOutboundInvoker,
                                                                   boolean closeChannelOutboundInvoker)

Creates a new AbstractByteBufBackedChannelOutboundInvokingOutputStream.

Parameters:

channelOutboundInvoker - the ChannelOutboundInvoker to which operations are adapted; must not be null

closeChannelOutboundInvoker - whether ChannelOutboundInvoker.close(ChannelPromise) will be called on the supplied ChannelOutboundInvoker when close() is called

See Also:

AbstractByteBufBackedChannelOutboundInvokingOutputStream(ChannelOutboundInvoker, int, boolean, ByteBufCreator)

AbstractByteBufBackedChannelOutboundInvokingOutputStream

protected AbstractByteBufBackedChannelOutboundInvokingOutputStream(ChannelOutboundInvoker channelOutboundInvoker,
                                                                   int flushThreshold,
                                                                   boolean closeChannelOutboundInvoker)

Creates a new AbstractByteBufBackedChannelOutboundInvokingOutputStream.

Parameters:

channelOutboundInvoker - the ChannelOutboundInvoker to which operations are adapted; must not be null

flushThreshold - the minimum number of bytes that this instance has to write before an automatic flush will take place; if less than 0 0 will be used instead; if Integer.MAX_VALUE then no automatic flushing will occur

closeChannelOutboundInvoker - whether ChannelOutboundInvoker.close(ChannelPromise) will be called on the supplied ChannelOutboundInvoker when close() is called

See Also:

AbstractByteBufBackedChannelOutboundInvokingOutputStream(ChannelOutboundInvoker, int, boolean, ByteBufCreator)

AbstractByteBufBackedChannelOutboundInvokingOutputStream

protected AbstractByteBufBackedChannelOutboundInvokingOutputStream(ChannelOutboundInvoker channelOutboundInvoker,
                                                                   int flushThreshold,
                                                                   boolean closeChannelOutboundInvoker,
                                                                   AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator byteBufCreator)

Creates a new AbstractByteBufBackedChannelOutboundInvokingOutputStream.

Parameters:

channelOutboundInvoker - the ChannelOutboundInvoker to which operations are adapted; must not be null

flushThreshold - the minimum number of bytes that this instance has to write before an automatic flush will take place; if less than 0 0 will be used instead; if Integer.MAX_VALUE then no automatic flushing will occur

closeChannelOutboundInvoker - whether ChannelOutboundInvoker.close(ChannelPromise) will be called on the supplied ChannelOutboundInvoker when close() is called

byteBufCreator - a AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator that will be used to create ByteBuf instances; may be null in which case a default AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator adapting Unpooled.wrappedBuffer(byte[], int, int) will be used instead

See Also:

AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator, Unpooled.wrappedBuffer(byte[], int, int)

Method Detail

createMessage

protected final T createMessage(byte[] bytes,
                                int offset,
                                int length)
                         throws IOException

Returns the result of invoking the createMessage(ByteBuf) method with a ByteBuf returned by the AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator supplied at construction time.

Specified by:

createMessage in class AbstractChannelOutboundInvokingOutputStream<T>

Parameters:

bytes - a byte array originating from, e.g., a AbstractChannelOutboundInvokingOutputStream.write(byte[], int, int) method invocation; will never be null

offset - the (validated) offset within the supplied byte array from which to start reading; will always be 0 or a positive int less than length

length - the (validated) length of the portion to read; will always be 0 or a positive int less than or equal to the length of the supplied byte array

Returns:

a new, non-null message to write

Throws:

IndexOutOfBoundsException - if offset is negative, or length is negative, or offset + length is greater than the length of bytes

IOException - if the createMessage(ByteBuf) method throws an IOException

See Also:

createMessage(ByteBuf)

createMessage

protected abstract T createMessage(ByteBuf content)
                            throws IOException

Creates and returns a new message to be written.

This method is called by the createMessage(byte[], int, int) method.

Parameters:

content - the ByteBuf to construct the message from; will never be null; must be read in its entirety, i.e. the return value of its ByteBuf.readableBytes() method after this method has completed must be 0

Returns:

a new message

Throws:

IOException - if an error occurs

See Also:

createMessage(byte[], int, int)