org.microbean.jersey.netty

Class ByteBufBackedChannelOutboundInvokingHttpContentOutputStream

java.lang.Object

java.io.OutputStream

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

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

org.microbean.jersey.netty.ByteBufBackedChannelOutboundInvokingHttpContentOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ByteBufBackedChannelOutboundInvokingHttpContentOutputStream
extends AbstractByteBufBackedChannelOutboundInvokingOutputStream<HttpContent>

An AbstractByteBufBackedChannelOutboundInvokingOutputStream that writes HttpContent messages.

Author:

Laird Nelson

See Also:

createMessage(ByteBuf), createLastMessage()

Nested Class Summary

Nested classes/interfaces inherited from class org.microbean.jersey.netty.AbstractByteBufBackedChannelOutboundInvokingOutputStream

AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator

Field Summary

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

channelOutboundInvoker, closeChannelOutboundInvoker

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected HttpContent	createLastMessage() Returns a new DefaultLastHttpContent when invoked.
protected HttpContent	createMessage(ByteBuf content) Returns a new DefaultHttpContent whose content() method returns the supplied ByteBuf.

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

createMessage

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

close, 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

ByteBufBackedChannelOutboundInvokingHttpContentOutputStream

public ByteBufBackedChannelOutboundInvokingHttpContentOutputStream(ChannelOutboundInvoker channelOutboundInvoker,
                                                                   boolean closeChannelOutboundInvoker)

Creates a new ByteBufBackedChannelOutboundInvokingHttpContentOutputStream.

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:

ByteBufBackedChannelOutboundInvokingHttpContentOutputStream(ChannelOutboundInvoker, int, boolean, AbstractByteBufBackedChannelOutboundInvokingOutputStream.ByteBufCreator)

ByteBufBackedChannelOutboundInvokingHttpContentOutputStream

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

Creates a new ByteBufBackedChannelOutboundInvokingHttpContentOutputStream.

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 ByteBufCreator that will be used to create ByteBuf instances; may be null in which case a default ByteBufCreator adapting Unpooled.wrappedBuffer(byte[], int, int) will be used instead

Method Detail

createMessage

protected HttpContent createMessage(ByteBuf content)

Returns a new DefaultHttpContent whose content() method returns the supplied ByteBuf.

This method never returns null.

Specified by:

createMessage in class AbstractByteBufBackedChannelOutboundInvokingOutputStream<HttpContent>

Parameters:

content - a ByteBuf; must not be null

Returns:

a new DefaultHttpContent whose content() method returns the supplied ByteBuf; never null

See Also:

AbstractByteBufBackedChannelOutboundInvokingOutputStream.createMessage(byte[], int, int)

createLastMessage

protected HttpContent createLastMessage()

Returns a new DefaultLastHttpContent when invoked.

This method never returns null.

Overrides:

createLastMessage in class AbstractChannelOutboundInvokingOutputStream<HttpContent>

Returns:

a new DefaultLastHttpContent

See Also:

AbstractChannelOutboundInvokingOutputStream.close()