Modifier and Type	Class and Description
private static class	BufferedContentSink.Flusher

Field Summary

Modifier and Type	Field and Description
private ByteBufferAggregator	_aggregator
private final ByteBufferPool	_bufferPool
private final Content.Sink	_delegate
private final boolean	_direct
private boolean	_firstWrite
private final BufferedContentSink.Flusher	_flusher
private boolean	_lastWritten
private final int	_maxAggregationSize
private final int	_maxBufferSize
public static final ByteBuffer	FLUSH_BUFFER An empty `ByteBuffer`, which if `written` will invoke a `flush(Callback)` operation.
private static final Logger	LOG
private static final int	START_BUFFER_SIZE

Access	Constructor and Description
public	BufferedContentSink(Content.Sink delegate, ByteBufferPool bufferPool, boolean direct, int maxAggregationSize, int maxBufferSize)

Method Summary

Modifier and Type	Method and Description
private void	aggregateAndFlush(boolean last, ByteBuffer currentBuffer, Callback callback) Aggregates the given buffer, flushing the aggregated buffer if necessary.
public void	flush(Callback Callback completed when the flush is complete callback) Flush the buffered content.
private void	flush(boolean last, ByteBuffer currentBuffer, Callback callback) Flushes the aggregated buffer if something was aggregated, then flushes the given buffer, bypassing the aggregator.
public void	write(boolean whether the ByteBuffer is the last to write last, ByteBuffer the ByteBuffer to write byteBuffer, Callback the callback to notify when the write operation is complete callback) Implements org.eclipse.jetty.io.Content.Sink.write. Writes the given `ByteBuffer`, notifying the `Callback` when the write is complete.

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

Field Detail

_aggregator	back to summary
private ByteBufferAggregator _aggregator

_bufferPool	back to summary
private final ByteBufferPool _bufferPool

_delegate	back to summary
private final Content.Sink _delegate

_direct	back to summary
private final boolean _direct

_firstWrite	back to summary
private boolean _firstWrite

_flusher	back to summary
private final BufferedContentSink.Flusher _flusher

_lastWritten	back to summary
private boolean _lastWritten

_maxAggregationSize	back to summary
private final int _maxAggregationSize

_maxBufferSize	back to summary
private final int _maxBufferSize

FLUSH_BUFFER	back to summary
public static final ByteBuffer FLUSH_BUFFER An empty `ByteBuffer`, which if `written` will invoke a `flush(Callback)` operation.

LOG	back to summary
private static final Logger LOG

START_BUFFER_SIZE	back to summary
private static final int START_BUFFER_SIZE

BufferedContentSink	back to summary
public BufferedContentSink(Content.Sink delegate, ByteBufferPool bufferPool, boolean direct, int maxAggregationSize, int maxBufferSize)

Method Detail

aggregateAndFlush	back to summary
private void aggregateAndFlush(boolean last, ByteBuffer currentBuffer, Callback callback) Aggregates the given buffer, flushing the aggregated buffer if necessary.

flush	back to summary
public void flush(Callback callback) Flush the buffered content. Parameters callback:Callback Callback completed when the flush is complete

flush

back to summary

public void flush(Callback callback)

Flush the buffered content.

Parameters

callback:Callback: Callback completed when the flush is complete

flush	back to summary
private void flush(boolean last, ByteBuffer currentBuffer, Callback callback) Flushes the aggregated buffer if something was aggregated, then flushes the given buffer, bypassing the aggregator.

write back to summary

write	back to summary
public void write(boolean last, ByteBuffer byteBuffer, Callback callback) Implements org.eclipse.jetty.io.Content.Sink.write. Doc from org.eclipse.jetty.io.Content.Sink.write. Writes the given `ByteBuffer`, notifying the `Callback` when the write is complete. Implementations guarantee that calls to this method are safely reentrant so that stack overflows are avoided in the case of mutual recursion between the execution of the `Callback` and a call to this method. Parameters last:boolean whether the ByteBuffer is the last to write byteBuffer:ByteBuffer the ByteBuffer to write callback:Callback the callback to notify when the write operation is complete Annotations @Override

public void write(boolean last, ByteBuffer byteBuffer, Callback callback)

Implements org.eclipse.jetty.io.Content.Sink.write.

Doc from org.eclipse.jetty.io.Content.Sink.write.

Writes the given ByteBuffer, notifying the Callback when the write is complete.

Implementations guarantee that calls to this method are safely reentrant so that stack overflows are avoided in the case of mutual recursion between the execution of the Callback and a call to this method.

Parameters

last:boolean: whether the ByteBuffer is the last to write
byteBuffer:ByteBuffer: the ByteBuffer to write
callback:Callback: the callback to notify when the write operation is complete

Annotations

@Override

org.eclipse.jetty.io.content back to summary

private Class BufferedContentSink.Flusher

Class Inheritance

extends IteratingCallback

java.lang.Object
org.eclipse.jetty.util.IteratingCallback
org.eclipse.jetty.io.content.BufferedContentSink.Flusher

Field Summary

Modifier and Type	Field and Description
private ByteBuffer	_buffer
private Callback	_callback
private boolean	_last
private boolean	_lastWritten
private final Content.Sink	_sink
private static final ByteBuffer	COMPLETE_CALLBACK

Constructor Summary

Access	Constructor and Description
pack-priv	Flusher(Content.Sink sink)

Method Summary

Modifier and Type	Method and Description
pack-priv void	offer(Callback callback)
pack-priv void	offer(boolean last, ByteBuffer byteBuffer, Callback callback)
protected void	onCompleteFailure(Throwable the throwable to indicate cause of failure cause) Overrides org.eclipse.jetty.util.IteratingCallback.onCompleteFailure. Invoked when the overall task has completed with a failure.
protected IteratingCallback.Action	process() Implements abstract org.eclipse.jetty.util.IteratingCallback.process. Method called by `iterate()` to process the asynchronous sub-task.
public void	succeeded() Overrides org.eclipse.jetty.util.IteratingCallback.succeeded. Overrides default org.eclipse.jetty.util.Callback.succeeded. Method to invoke when the asynchronous sub-task succeeds.

Inherited from org.eclipse.jetty.util.IteratingCallback:: abort close failed isAborted isClosed isFailed isSucceeded iterate onCompleteSuccess reset toString

Field Detail

_buffer	back to summary
private ByteBuffer _buffer

_callback	back to summary
private Callback _callback

_last	back to summary
private boolean _last

_lastWritten	back to summary
private boolean _lastWritten

_sink	back to summary
private final Content.Sink _sink

COMPLETE_CALLBACK	back to summary
private static final ByteBuffer COMPLETE_CALLBACK

Constructor Detail

Flusher	back to summary
pack-priv Flusher(Content.Sink sink)

Method Detail

offer	back to summary
pack-priv void offer(Callback callback)

offer	back to summary
pack-priv void offer(boolean last, ByteBuffer byteBuffer, Callback callback)

onCompleteFailure	back to summary
protected void onCompleteFailure(Throwable cause) Overrides org.eclipse.jetty.util.IteratingCallback.onCompleteFailure. Doc from org.eclipse.jetty.util.IteratingCallback.onCompleteFailure. Invoked when the overall task has completed with a failure. Parameters cause:Throwable the throwable to indicate cause of failure Annotations @Override

onCompleteFailure

back to summary

protected void onCompleteFailure(Throwable cause)

Overrides org.eclipse.jetty.util.IteratingCallback.onCompleteFailure.

Doc from org.eclipse.jetty.util.IteratingCallback.onCompleteFailure.

Invoked when the overall task has completed with a failure.

Parameters

cause:Throwable: the throwable to indicate cause of failure

Annotations

@Override

process back to summary

process	back to summary
protected IteratingCallback.Action process() Implements abstract org.eclipse.jetty.util.IteratingCallback.process. Doc from org.eclipse.jetty.util.IteratingCallback.process. Method called by `iterate()` to process the asynchronous sub-task. Implementations must initiate the asynchronous execution of the sub-task (if any) and return an appropriate action: `Action#IDLE` when no sub tasks are available for execution but the overall job is not completed yet `Action#SCHEDULED` when the sub task asynchronous execution has been started `Action#SUCCEEDED` when the overall job is completed Returns:IteratingCallback.Action the appropriate Action Annotations @Override

protected IteratingCallback.Action process()

Implements abstract org.eclipse.jetty.util.IteratingCallback.process.

Doc from org.eclipse.jetty.util.IteratingCallback.process.

Method called by iterate() to process the asynchronous sub-task.

Implementations must initiate the asynchronous execution of the sub-task (if any) and return an appropriate action:

Action#IDLE when no sub tasks are available for execution but the overall job is not completed yet
Action#SCHEDULED when the sub task asynchronous execution has been started
Action#SUCCEEDED when the overall job is completed

Returns:IteratingCallback.Action

the appropriate Action

Annotations

@Override

succeeded back to summary

succeeded	back to summary
public void succeeded() Overrides org.eclipse.jetty.util.IteratingCallback.succeeded. Overrides default org.eclipse.jetty.util.Callback.succeeded. Doc from org.eclipse.jetty.util.IteratingCallback.succeeded. Method to invoke when the asynchronous sub-task succeeds. Subclasses that override this method must always remember to call `super.succeeded()`. Annotations @Override

public void succeeded()

Overrides org.eclipse.jetty.util.IteratingCallback.succeeded.

Overrides default org.eclipse.jetty.util.Callback.succeeded.

Doc from org.eclipse.jetty.util.IteratingCallback.succeeded.

Method to invoke when the asynchronous sub-task succeeds.

Subclasses that override this method must always remember to call super.succeeded().

Annotations