Modifier and Type	Class and Description
pack-priv static class	OutputBuffer.ByteArrayCloner The `MessageCloner`, responsible for cloning Buffer content, if it wasn't possible to write it in the current Thread (it was added to async write queue).
private static class	OutputBuffer.InternalWriteHandler
public static interface	OutputBuffer.LifeCycleListener

Modifier and Type	Field and Description
private OutputBuffer.InternalWriteHandler	asyncWriteHandler
private int	bufferSize
private HttpContent.Builder<T extends HttpContent.Builder>	builder
private char[]	charsArray
private int	charsArrayLength
private CharBuffer	charsBuffer
private final OutputBuffer.ByteArrayCloner	cloner
private boolean	closed
private boolean	committed
private CompositeBuffer	compositeBuffer
private Connection<L>	connection
private FilterChainContext	ctx
private Buffer	currentBuffer
private static final int	DEFAULT_BUFFER_SIZE
private CharsetEncoder	encoder
private final Map<String, CharsetEncoder>	encoders
private boolean	fileTransferRequested
private boolean	finished
private volatile WriteHandler	handler
private boolean	headersWritten
private HttpContext	httpContext
private static final boolean	IS_BLOCKING Flag indicating whether or not async operations are being used on the input streams.
private boolean	isLastWriteNonBlocking
private boolean	isNonBlockingWriteGuaranteed
private final List<OutputBuffer.LifeCycleListener>	lifeCycleListeners
protected static final Logger	LOGGER
private static final int	MAX_CHAR_BUFFER_SIZE
private MemoryManager<E extends Buffer>	memoryManager
private static final int	MIN_BUFFER_SIZE
private HttpHeader	outputHeader
protected boolean	sendfileEnabled
private final TemporaryHeapBuffer	temporaryWriteBuffer
private Supplier<Map<String, String>>	trailersSupplier
private Runnable	writePossibleRunnable

Access	Constructor and Description
public	OutputBuffer()

Method Summary

Modifier and Type	Method and Description
protected void	blockAfterWriteIfNeeded()
public boolean	canWrite(final int length) Deprecated the `length` parameter will be ignored. Please use `canWrite()`.
public boolean	canWrite()
public boolean	canWriteChar(final int length) Deprecated
private boolean	canWritePayloadChunk()
private void	checkCharBuffer()
private void	checkCompositeBuffer()
private void	checkCurrentBuffer()
public void	close()
private boolean	doCommit()
public void	endRequest()
private void	finishCurrentBuffer()
public void	flush() Flush the response.
private boolean	flushAllBuffers(final boolean isLast)
private boolean	flushBinaryBuffers(final boolean isLast)
private void	flushBinaryBuffersIfNeeded()
private void	flushBuffer(final Buffer bufferToFlush, final boolean isLast, final MessageCloner<Buffer> messageCloner)
private void	flushCharsToBuf(final boolean canFlushToNet)
private void	flushCharsToBuf(final CharBuffer charBuf, final boolean canFlushToNet)
private void	forceCommitHeaders(final boolean isLast)
public int	Returns: the number of bytes buffered on OutputBuffer and ready to be sent. getBufferedDataSize() Get the number of bytes buffered on OutputBuffer and ready to be sent.
public int	getBufferSize()
private CharsetEncoder	getEncoder()
protected Executor	getThreadPool() Returns: `Executor`, which will be used for notifying user registered `WriteHandler`.
public Supplier<Map<String, String>>	getTrailers()
public void	initialize(final HttpHeader outputHeader, final boolean sendfileEnabled, final FilterChainContext ctx)
public boolean	Returns: `true` if content will be written in a non-blocking fashion, otherwise returns `false`. isAsyncEnabled() Deprecated will always return true Returns `true` if content will be written in a non-blocking fashion, otherwise returns `false`.
public boolean	isClosed() Returns: `true` if this `OutputBuffer` is closed, otherwise returns `false`.
public void	notifyCanWrite(final WriteHandler handler, final int length) Deprecated the `length` parameter will be ignored.
public void	notifyCanWrite(final WriteHandler handler)
private void	notifyCommit()
private void	notifyWritePossible() Notify WriteHandler
private void	notifyWritePossibleAsync() Notify WriteHandler asynchronously
public void	prepareCharacterEncoder()
public void	recycle() Recycle the output buffer.
public void	registerLifeCycleListener(final OutputBuffer.LifeCycleListener listener)
public boolean	removeLifeCycleListener(final OutputBuffer.LifeCycleListener listener)
public void	reset() Reset current response.
public void	sendfile(final File the `File` to transfer. file, final CompletionHandler<WriteResult<K, L>> `CompletionHandler` that will be notified of the transfer progress/completion or failure. handler) Calls `write(file, 0, file.length())`.
public void	sendfile(final File the `File` to transfer. file, final long the starting offset within the File offset, final long the total number of bytes to transfer length, final CompletionHandler<WriteResult<K, L>> `CompletionHandler` that will be notified of the transfer progress/completion or failure. handler) Will use `java.nio.channels.FileChannel#transferTo(long, long, java.nio.channels.WritableByteChannel)` to send file to the remote endpoint.
public void	setAsyncEnabled(boolean `true` if this `OutputBuffer will write content without blocking. @since 2.1.2 @deprecated OutputBuffer always supports async mode` `asyncEnabled)` `Deprecated` `Sets the asynchronous processing state of this OutputBuffer.`
public void	setBufferSize(final int bufferSize)
public void	setTrailers(Supplier<Map<String, String>> trailersSupplier)
private void	updateNonBlockingStatus()
public void	write(char[] cbuf, int off, int len)
public void	write(final char[] cbuf)
public void	write(final String str)
public void	write(final String str, final int off, final int len)
public void	write(final byte[] b)
public void	write(final byte[] b, final int off, final int len)
public void	writeBuffer(final Buffer the `Buffer` to write buffer) Writes the contents of the specified `Buffer` to the client.
public void	writeByte(final int b)
public void	writeByteBuffer(final ByteBuffer the `ByteBuffer` to write byteBuffer) Writes the contents of the specified `ByteBuffer` to the client.
public void	writeChar(int c)
public void	writeInterimResponse() Flush a pending informational (1xx) interim response — either a 100-Continue acknowledgement of an `Expect` header, or any other interim status such as 103 Early Hints — without committing the response.
private boolean	writingBytes()
private boolean	writingChars()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

asyncWriteHandler	back to summary
private OutputBuffer.InternalWriteHandler asyncWriteHandler

bufferSize	back to summary
private int bufferSize

builder	back to summary
private HttpContent.Builder<T extends HttpContent.Builder> builder

charsArray	back to summary
private char[] charsArray

charsArrayLength	back to summary
private int charsArrayLength

charsBuffer	back to summary
private CharBuffer charsBuffer

cloner	back to summary
private final OutputBuffer.ByteArrayCloner cloner

closed	back to summary
private boolean closed

committed	back to summary
private boolean committed

compositeBuffer	back to summary
private CompositeBuffer compositeBuffer

connection	back to summary
private Connection<L> connection

ctx	back to summary
private FilterChainContext ctx

currentBuffer	back to summary
private Buffer currentBuffer

DEFAULT_BUFFER_SIZE	back to summary
private static final int DEFAULT_BUFFER_SIZE

encoder	back to summary
private CharsetEncoder encoder

encoders	back to summary
private final Map<String, CharsetEncoder> encoders

fileTransferRequested	back to summary
private boolean fileTransferRequested

finished	back to summary
private boolean finished

handler	back to summary
private volatile WriteHandler handler

headersWritten	back to summary
private boolean headersWritten

httpContext	back to summary
private HttpContext httpContext

IS_BLOCKING	back to summary
private static final boolean IS_BLOCKING Flag indicating whether or not async operations are being used on the input streams.

isLastWriteNonBlocking	back to summary
private boolean isLastWriteNonBlocking

isNonBlockingWriteGuaranteed	back to summary
private boolean isNonBlockingWriteGuaranteed

lifeCycleListeners	back to summary
private final List<OutputBuffer.LifeCycleListener> lifeCycleListeners

LOGGER	back to summary
protected static final Logger LOGGER

MAX_CHAR_BUFFER_SIZE	back to summary
private static final int MAX_CHAR_BUFFER_SIZE

memoryManager	back to summary
private MemoryManager<E extends Buffer> memoryManager

MIN_BUFFER_SIZE	back to summary
private static final int MIN_BUFFER_SIZE

outputHeader	back to summary
private HttpHeader outputHeader

sendfileEnabled	back to summary
protected boolean sendfileEnabled

temporaryWriteBuffer	back to summary
private final TemporaryHeapBuffer temporaryWriteBuffer

trailersSupplier	back to summary
private Supplier<Map<String, String>> trailersSupplier

writePossibleRunnable	back to summary
private Runnable writePossibleRunnable

Constructor Detail

OutputBuffer	back to summary
public OutputBuffer()

Method Detail

blockAfterWriteIfNeeded	back to summary
protected void blockAfterWriteIfNeeded() throws IOException

canWrite	back to summary
public boolean canWrite(final int length) Deprecated the `length` parameter will be ignored. Please use `canWrite()`. Annotations @Deprecated @SuppressWarnings:UnusedParameters See Also `AsyncQueueWriter#canWrite(org.glassfish.grizzly.Connection, int)`

canWrite	back to summary
public boolean canWrite() See Also `AsyncQueueWriter#canWrite(org.glassfish.grizzly.Connection)`

canWriteChar	back to summary
public boolean canWriteChar(final int length) Deprecated Annotations @SuppressWarnings:UnusedDeclaration @Deprecated

canWritePayloadChunk	back to summary
private boolean canWritePayloadChunk()

checkCharBuffer	back to summary
private void checkCharBuffer()

checkCompositeBuffer	back to summary
private void checkCompositeBuffer()

checkCurrentBuffer	back to summary
private void checkCurrentBuffer()

close	back to summary
public void close() throws IOException

doCommit	back to summary
private boolean doCommit() throws IOException

endRequest	back to summary
public void endRequest() throws IOException

finishCurrentBuffer	back to summary
private void finishCurrentBuffer()

flush

back to summary

public void flush() throws IOException

Flush the response.

Exceptions

IOException:: an underlying I/O error occurred

flushAllBuffers	back to summary
private boolean flushAllBuffers(final boolean isLast) throws IOException

flushBinaryBuffers	back to summary
private boolean flushBinaryBuffers(final boolean isLast) throws IOException

flushBinaryBuffersIfNeeded	back to summary
private void flushBinaryBuffersIfNeeded() throws IOException

flushBuffer	back to summary
private void flushBuffer(final Buffer bufferToFlush, final boolean isLast, final MessageCloner<Buffer> messageCloner) throws IOException

flushCharsToBuf	back to summary
private void flushCharsToBuf(final boolean canFlushToNet) throws IOException

flushCharsToBuf	back to summary
private void flushCharsToBuf(final CharBuffer charBuf, final boolean canFlushToNet) throws IOException

forceCommitHeaders	back to summary
private void forceCommitHeaders(final boolean isLast) throws IOException

getBufferedDataSize

back to summary

public int getBufferedDataSize()

Get the number of bytes buffered on OutputBuffer and ready to be sent.

Returns:int

the number of bytes buffered on OutputBuffer and ready to be sent.

Annotations

@SuppressWarnings:UnusedDeclaration

getBufferSize	back to summary
public int getBufferSize()

getEncoder	back to summary
private CharsetEncoder getEncoder()

getThreadPool	back to summary
protected Executor getThreadPool() Returns:Executor `Executor`, which will be used for notifying user registered `WriteHandler`.

getTrailers	back to summary
public Supplier<Map<String, String>> getTrailers()

initialize	back to summary
public void initialize(final HttpHeader outputHeader, final boolean sendfileEnabled, final FilterChainContext ctx)

isAsyncEnabled back to summary

public boolean isAsyncEnabled()

Deprecated

will always return true

Returns true if content will be written in a non-blocking fashion, otherwise returns false.

Returns:boolean

true if content will be written in a non-blocking fashion, otherwise returns false.

Annotations

@Deprecated
@SuppressWarnings:UnusedDeclaration

Since

2.1.2

isClosed	back to summary
public boolean isClosed() Returns:boolean `true` if this `OutputBuffer` is closed, otherwise returns `false`. Annotations @SuppressWarnings:UnusedDeclaration

notifyCanWrite	back to summary
public void notifyCanWrite(final WriteHandler handler, final int length) Deprecated the `length` parameter will be ignored. Please use `notifyCanWrite(org.glassfish.grizzly.WriteHandler)`. Annotations @Deprecated @SuppressWarnings:UnusedParameters See Also `AsyncQueueWriter#notifyWritePossible(org.glassfish.grizzly.Connection, org.glassfish.grizzly.WriteHandler, int)`

notifyCanWrite	back to summary
public void notifyCanWrite(final WriteHandler handler)

notifyCommit	back to summary
private void notifyCommit() throws IOException

notifyWritePossible	back to summary
private void notifyWritePossible() Notify WriteHandler

notifyWritePossibleAsync	back to summary
private void notifyWritePossibleAsync() Notify WriteHandler asynchronously

prepareCharacterEncoder	back to summary
public void prepareCharacterEncoder()

recycle	back to summary
public void recycle() Recycle the output buffer. This should be called when closing the connection.

registerLifeCycleListener	back to summary
public void registerLifeCycleListener(final OutputBuffer.LifeCycleListener listener) Annotations @SuppressWarnings:UnusedDeclaration

removeLifeCycleListener	back to summary
public boolean removeLifeCycleListener(final OutputBuffer.LifeCycleListener listener) Annotations @SuppressWarnings:UnusedDeclaration

reset

back to summary

public void reset()

Reset current response.

Exceptions

IllegalStateException:: if the response has already been committed

sendfile back to summary

public void sendfile(final File file, final CompletionHandler<WriteResult<K, L>> handler)

Calls write(file, 0, file.length()).

Parameters

file:File: the File to transfer.
handler:CompletionHandler<WriteResult<K, L>>: CompletionHandler that will be notified of the transfer progress/completion or failure.

Exceptions

IllegalArgumentException:: if file is null

Since

2.2

sendfile back to summary

public void sendfile(final File file, final long offset, final long length, final CompletionHandler<WriteResult<K, L>> handler)

Will use java.nio.channels.FileChannel#transferTo(long, long, java.nio.channels.WritableByteChannel) to send file to the remote endpoint. Note that all headers necessary for the file transfer must be set prior to invoking this method as this will case the HTTP header to be flushed to the client prior to sending the file content. This should also be the last call to write any content to the remote endpoint.

It's required that the response be suspended when using this functionality. It will be assumed that if the response wasn't suspended when this method is called, that it's desired that this method manages the suspend/resume cycle.

Parameters

file:File: the File to transfer.
offset:long: the starting offset within the File
length:long: the total number of bytes to transfer
handler:CompletionHandler<WriteResult<K, L>>: CompletionHandler that will be notified of the transfer progress/completion or failure.

Exceptions

IllegalArgumentException:

if the response has already been committed at the time this method was invoked.

IllegalStateException:

if a file transfer request has already been made or if send file support isn't available.
if the response was in a suspended state when this method was invoked, but no CompletionHandler was provided.

Since

2.2

setAsyncEnabled back to summary

public void setAsyncEnabled(boolean asyncEnabled)

Deprecated

Sets the asynchronous processing state of this OutputBuffer.

Parameters

asyncEnabled:boolean: true if this OutputBuffer will write content without blocking. @since 2.1.2 @deprecated OutputBuffer always supports async mode

Annotations

@Deprecated
@SuppressWarnings:UnusedDeclaration

setBufferSize	back to summary
public void setBufferSize(final int bufferSize)

setTrailers	back to summary
public void setTrailers(Supplier<Map<String, String>> trailersSupplier)

updateNonBlockingStatus	back to summary
private void updateNonBlockingStatus()

write	back to summary
public void write(char[] cbuf, int off, int len) throws IOException

write	back to summary
public void write(final char[] cbuf) throws IOException

write	back to summary
public void write(final String str) throws IOException

write	back to summary
public void write(final String str, final int off, final int len) throws IOException

write	back to summary
public void write(final byte[] b) throws IOException

write	back to summary
public void write(final byte[] b, final int off, final int len) throws IOException

writeBuffer back to summary

public void writeBuffer(final Buffer buffer) throws IOException

Writes the contents of the specified Buffer to the client.

Note, that passed Buffer will be directly used by underlying connection, so it could be reused only if it has been flushed.

Parameters

buffer:Buffer: the Buffer to write

Exceptions

IOException:: if an error occurs during the write

writeByte	back to summary
public void writeByte(final int b) throws IOException

writeByteBuffer back to summary

public void writeByteBuffer(final ByteBuffer byteBuffer) throws IOException

Writes the contents of the specified ByteBuffer to the client.

Note, that passed ByteBuffer will be directly used by underlying connection, so it could be reused only if it has been flushed.

Parameters

byteBuffer:ByteBuffer: the ByteBuffer to write

Annotations

@SuppressWarnings:unchecked, UnusedDeclaration

Exceptions

IOException:: if an error occurs during the write

writeChar	back to summary
public void writeChar(int c) throws IOException

writeInterimResponse back to summary

public void writeInterimResponse() throws IOException

Flush a pending informational (1xx) interim response — either a 100-Continue acknowledgement of an Expect header, or any other interim status such as 103 Early Hints — without committing the response. The interim status must have been set on the response packet via org.glassfish.grizzly.http.HttpResponsePacket#setInterimStatus before invoking this method.

Exceptions

IOException:: if an error occurs writing the interim response.

writingBytes	back to summary
private boolean writingBytes()

writingChars	back to summary
private boolean writingChars()

org.glassfish.grizzly.http.io back to summary

pack-priv final Class OutputBuffer.ByteArrayCloner

Class Inheritance

extends Object
implements MessageCloner<Buffer>

java.lang.Object
org.glassfish.grizzly.http.io.OutputBuffer.ByteArrayCloner

All Implemented Interfaces

org.glassfish.grizzly.asyncqueue.MessageCloner

The MessageCloner, responsible for cloning Buffer content, if it wasn't possible to write it in the current Thread (it was added to async write queue). We do this, because write(byte[], int, int) method is not aware of async write queues, and content of the passed byte[] might be changed by user application once in gets control back.

Field Summary

Modifier and Type	Field and Description
private final TemporaryHeapBuffer	temporaryWriteBuffer

Constructor Summary

Access	Constructor and Description
public	ByteArrayCloner(final TemporaryHeapBuffer temporaryWriteBuffer)

Method Summary

Modifier and Type	Method and Description
public Buffer	clone(final Connection<L> connection, final Buffer originalMessage) Implements org.glassfish.grizzly.asyncqueue.MessageCloner.clone. Method will be called by `AsyncQueueWriter`, when message could not be written directly, and will be added to the queue.
pack-priv Buffer	clone0(final MemoryManager<E extends Buffer> memoryManager, final Buffer originalMessage)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

temporaryWriteBuffer	back to summary
private final TemporaryHeapBuffer temporaryWriteBuffer

Constructor Detail

ByteArrayCloner	back to summary
public ByteArrayCloner(final TemporaryHeapBuffer temporaryWriteBuffer)

Method Detail

clone back to summary

public Buffer clone(final Connection<L> connection, final Buffer originalMessage)

Implements org.glassfish.grizzly.asyncqueue.MessageCloner.clone.

Doc from org.glassfish.grizzly.asyncqueue.MessageCloner.clone.

Method will be called by AsyncQueueWriter, when message could not be written directly, and will be added to the queue. Cloner may create a clone of original message and return it to the AsyncQueueWriter instead of original one. Using MessageCloner, developer has a chance to clone a message only in case, when it is really required.

Annotations

@Override

clone0	back to summary
pack-priv Buffer clone0(final MemoryManager<E extends Buffer> memoryManager, final Buffer originalMessage)

org.glassfish.grizzly.http.io back to summary

private Class OutputBuffer.InternalWriteHandler

Class Inheritance

extends Object
implements WriteHandler

java.lang.Object
org.glassfish.grizzly.http.io.OutputBuffer.InternalWriteHandler

All Implemented Interfaces

org.glassfish.grizzly.WriteHandler

Field Summary

Modifier and Type	Field and Description
private volatile OutputBuffer	outputBuffer

Constructor Summary

Access	Constructor and Description
public	InternalWriteHandler(final OutputBuffer outputBuffer)

Method Summary

Modifier and Type	Method and Description
public void	detach()
public void	onError(final Throwable t) Implements org.glassfish.grizzly.WriteHandler.onError. Invoked when an error occurs processing the request asynchronously.
private static void	onError0(final OutputBuffer ob, final Throwable t)
public void	onWritePossible() Implements org.glassfish.grizzly.WriteHandler.onWritePossible. This callback will be invoked when the requirements as dictated by writer are met.
private static void	onWritePossible0(final OutputBuffer ob)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

outputBuffer	back to summary
private volatile OutputBuffer outputBuffer

Constructor Detail

InternalWriteHandler	back to summary
public InternalWriteHandler(final OutputBuffer outputBuffer)

Method Detail

detach	back to summary
public void detach()

onError

back to summary

public void onError(final Throwable t)

Implements org.glassfish.grizzly.WriteHandler.onError.

Doc from org.glassfish.grizzly.WriteHandler.onError.

Invoked when an error occurs processing the request asynchronously.

Annotations

@Override

onError0	back to summary
private static void onError0(final OutputBuffer ob, final Throwable t)

onWritePossible back to summary

public void onWritePossible() throws Exception

Implements org.glassfish.grizzly.WriteHandler.onWritePossible.

Doc from org.glassfish.grizzly.WriteHandler.onWritePossible.

This callback will be invoked when the requirements as dictated by writer are met.

Annotations

@Override

Exceptions

Exception:: Exception might be thrown by the custom handler code. This exception will be delegated for processing to onError(java.lang.Throwable).

onWritePossible0	back to summary
private static void onWritePossible0(final OutputBuffer ob) throws Exception

public Class OutputBuffer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class OutputBuffer.ByteArrayCloner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class OutputBuffer.InternalWriteHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface OutputBuffer.LifeCycleListener

Method Summary

Method Detail