Modifier and Type	Class and Description
private static class	HttpPipelineOptAddOn.PlugFilter The filter, that works as a plug in the FilterChain, and buffers output data before passing it down to a transport filter, which will write the data to network.

Modifier and Type	Field and Description
private static final int	DEFAULT_MAX_BUFFER_SIZE
private final int	maxBufferSize max number of response bytes to buffer before flush

Access	Constructor and Description
public	HttpPipelineOptAddOn() Constructs `HttpPipelineOptAddOn`.
public	HttpPipelineOptAddOn(final int the max number of response bytes to buffer before flush maxBufferSize) Constructs `HttpPipelineOptAddOn`.

Modifier and Type	Method and Description
public void	setup(final NetworkListener networkListener, final FilterChainBuilder builder) Implements org.glassfish.grizzly.http.server.AddOn.setup. The method, which will be invoked by `HttpServer` in order to initialize the AddOn on the passed `NetworkListener`.

DEFAULT_MAX_BUFFER_SIZE	back to summary
private static final int DEFAULT_MAX_BUFFER_SIZE

maxBufferSize	back to summary
private final int maxBufferSize max number of response bytes to buffer before flush

HttpPipelineOptAddOn	back to summary
public HttpPipelineOptAddOn() Constructs `HttpPipelineOptAddOn`.

HttpPipelineOptAddOn	back to summary
public HttpPipelineOptAddOn(final int maxBufferSize) Constructs `HttpPipelineOptAddOn`. Parameters maxBufferSize:int the max number of response bytes to buffer before flush

setup	back to summary
public void setup(final NetworkListener networkListener, final FilterChainBuilder builder) Implements org.glassfish.grizzly.http.server.AddOn.setup. Doc from org.glassfish.grizzly.http.server.AddOn.setup. The method, which will be invoked by `HttpServer` in order to initialize the AddOn on the passed `NetworkListener`. Most of the time the AddOn implementation will update the passed `NetworkListener`'s `FilterChainBuilder` by adding custom `org.glassfish.grizzly.filterchain.Filter`(s), which implement AddOn's logic. Annotations @Override

org.glassfish.grizzly.http.server.util back to summary

private Class HttpPipelineOptAddOn.PlugFilter

Class Inheritance

java.lang.Object
org.glassfish.grizzly.filterchain.BaseFilter
org.glassfish.grizzly.http.server.util.HttpPipelineOptAddOn.PlugFilter

The filter, that works as a plug in the FilterChain, and buffers output data before passing it down to a transport filter, which will write the data to network.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	HttpPipelineOptAddOn.PlugFilter.AggrCompletionHandler
public static class	HttpPipelineOptAddOn.PlugFilter.Plug

Field Summary

Modifier and Type	Field and Description
private final int	maxBufferSize
private final Attribute<HttpPipelineOptAddOn.PlugFilter.Plug>	plugAttr

Constructor Summary

Access	Constructor and Description
public	PlugFilter(final int maxBufferSize, final AttributeBuilder builder)

Method Summary

Modifier and Type	Method and Description
public NextAction	handleRead(final FilterChainContext ctx) Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleRead. Implements org.glassfish.grizzly.filterchain.Filter.handleRead. Execute a unit of processing work to be performed, when channel will become available for reading.
public NextAction	handleWrite(final FilterChainContext ctx) Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleWrite. Implements org.glassfish.grizzly.filterchain.Filter.handleWrite. Execute a unit of processing work to be performed, when some data should be written on channel.

Inherited from org.glassfish.grizzly.filterchain.BaseFilter:: createContext exceptionOccurred handleAccept handleClose handleConnect handleEvent onAdded onFilterChainChanged onRemoved toString

Field Detail

maxBufferSize	back to summary
private final int maxBufferSize

plugAttr	back to summary
private final Attribute<HttpPipelineOptAddOn.PlugFilter.Plug> plugAttr

Constructor Detail

PlugFilter	back to summary
public PlugFilter(final int maxBufferSize, final AttributeBuilder builder)

Method Detail

handleRead back to summary

handleRead	back to summary
public NextAction handleRead(final FilterChainContext ctx) throws IOException Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleRead. Implements org.glassfish.grizzly.filterchain.Filter.handleRead. Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleRead. Execute a unit of processing work to be performed, when channel will become available for reading. This `Filter` may either complete the required processing and return false, or delegate remaining processing to the next `Filter` in a `FilterChain` containing this `Filter` by returning true. Annotations @Override

public NextAction handleRead(final FilterChainContext ctx) throws IOException

Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleRead.

Implements org.glassfish.grizzly.filterchain.Filter.handleRead.

Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleRead.

Execute a unit of processing work to be performed, when channel will become available for reading. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Annotations

@Override

handleWrite back to summary

handleWrite	back to summary
public NextAction handleWrite(final FilterChainContext ctx) throws IOException Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleWrite. Implements org.glassfish.grizzly.filterchain.Filter.handleWrite. Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleWrite. Execute a unit of processing work to be performed, when some data should be written on channel. This `Filter` may either complete the required processing and return false, or delegate remaining processing to the next `Filter` in a `FilterChain` containing this `Filter` by returning true. Annotations @Override @SuppressWarnings:unchecked

public NextAction handleWrite(final FilterChainContext ctx) throws IOException

Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleWrite.

Implements org.glassfish.grizzly.filterchain.Filter.handleWrite.

Doc from org.glassfish.grizzly.filterchain.BaseFilter.handleWrite.

Execute a unit of processing work to be performed, when some data should be written on channel. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Annotations

@Override
@SuppressWarnings:unchecked

org.glassfish.grizzly.http.server.util back to summary

public final Class HttpPipelineOptAddOn.PlugFilter.AggrCompletionHandler

Class Inheritance

extends Object
implements CompletionHandler

java.lang.Object
org.glassfish.grizzly.http.server.util.HttpPipelineOptAddOn.PlugFilter.AggrCompletionHandler

All Implemented Interfaces

org.glassfish.grizzly.CompletionHandler

Field Summary

Modifier and Type	Field and Description
private CompletionHandler<E>[]	handlers
private int	sz

Constructor Summary

Access	Constructor and Description
public	AggrCompletionHandler()

Method Summary

Modifier and Type	Method and Description
public void	add(final CompletionHandler<E> handler)
public void	cancelled() Implements org.glassfish.grizzly.CompletionHandler.cancelled. The operation was cancelled.
public void	clear()
public void	completed(final Object result) Implements org.glassfish.grizzly.CompletionHandler.completed. The operation was completed.
private void	ensureSize()
public void	failed(final Throwable throwable) Implements org.glassfish.grizzly.CompletionHandler.failed. The operation was failed.
public void	updated(final Object result) Implements org.glassfish.grizzly.CompletionHandler.updated. The callback method may be called, when there is some progress in operation execution, but it is still not completed

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

Field Detail

handlers	back to summary
private CompletionHandler<E>[] handlers

sz	back to summary
private int sz

Constructor Detail

AggrCompletionHandler	back to summary
public AggrCompletionHandler()

Method Detail

add	back to summary
public void add(final CompletionHandler<E> handler)

cancelled	back to summary
public void cancelled() Implements org.glassfish.grizzly.CompletionHandler.cancelled. Doc from org.glassfish.grizzly.CompletionHandler.cancelled. The operation was cancelled. Annotations @Override

cancelled

back to summary

public void cancelled()

Implements org.glassfish.grizzly.CompletionHandler.cancelled.

Doc from org.glassfish.grizzly.CompletionHandler.cancelled.

The operation was cancelled.

Annotations

@Override

clear	back to summary
public void clear()

completed	back to summary
public void completed(final Object result) Implements org.glassfish.grizzly.CompletionHandler.completed. Doc from org.glassfish.grizzly.CompletionHandler.completed. The operation was completed. Annotations @Override @SuppressWarnings:unchecked

completed

back to summary

public void completed(final Object result)

Implements org.glassfish.grizzly.CompletionHandler.completed.

Doc from org.glassfish.grizzly.CompletionHandler.completed.

The operation was completed.

Annotations

@Override
@SuppressWarnings:unchecked

ensureSize	back to summary
private void ensureSize()

failed	back to summary
public void failed(final Throwable throwable) Implements org.glassfish.grizzly.CompletionHandler.failed. Doc from org.glassfish.grizzly.CompletionHandler.failed. The operation was failed. Annotations @Override

failed

back to summary

public void failed(final Throwable throwable)

Implements org.glassfish.grizzly.CompletionHandler.failed.

Doc from org.glassfish.grizzly.CompletionHandler.failed.

The operation was failed.

Annotations

@Override

updated	back to summary
public void updated(final Object result) Implements org.glassfish.grizzly.CompletionHandler.updated. Doc from org.glassfish.grizzly.CompletionHandler.updated. The callback method may be called, when there is some progress in operation execution, but it is still not completed Annotations @Override @SuppressWarnings:unchecked

updated

back to summary

public void updated(final Object result)

Implements org.glassfish.grizzly.CompletionHandler.updated.

Doc from org.glassfish.grizzly.CompletionHandler.updated.

The callback method may be called, when there is some progress in operation execution, but it is still not completed

Annotations

@Override
@SuppressWarnings:unchecked

org.glassfish.grizzly.http.server.util back to summary

public Class HttpPipelineOptAddOn.PlugFilter.Plug

Class Inheritance

extends Adapter

java.lang.Object
org.glassfish.grizzly.IOEventLifeCycleListener.Adapter
org.glassfish.grizzly.http.server.util.HttpPipelineOptAddOn.PlugFilter.Plug

Field Summary

Modifier and Type	Field and Description
private HttpPipelineOptAddOn.PlugFilter.AggrCompletionHandler	aggrCompletionHandler
private CompositeBuffer	buffer
private static final ThreadCache.CachedTypeIndex<HttpPipelineOptAddOn.PlugFilter.Plug>	CACHE_IDX
private final MessageCloner<Buffer>	cloner
private FilterChainContext	ctx
private boolean	isPlugged
private boolean	isWrittenInThisThread
private HttpPipelineOptAddOn.PlugFilter	plugFilter

Constructor Summary

Access	Constructor and Description
public	Plug()

Method Summary

Modifier and Type	Method and Description
private boolean	append(final Buffer msg, final CompletionHandler<E> completionHandler) Appends buffer to the queue.
public static HttpPipelineOptAddOn.PlugFilter.Plug	create(final FilterChainContext ctx, final HttpPipelineOptAddOn.PlugFilter plugFilter)
private void	flush() flushes buffered data
pack-priv HttpPipelineOptAddOn.PlugFilter.Plug	init(final FilterChainContext ctx, final HttpPipelineOptAddOn.PlugFilter plugFilter)
private HttpPipelineOptAddOn.PlugFilter.AggrCompletionHandler	obtainAggrCompletionHandler()
private CompositeBuffer	obtainCompositeBuffer()
public void	onComplete(final Context context, final Object data) Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onComplete. Implements org.glassfish.grizzly.IOEventLifeCycleListener.onComplete. `IOEvent` processing completed.
public void	onContextManualIOEventControl(final Context context) Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onContextManualIOEventControl. Implements org.glassfish.grizzly.IOEventLifeCycleListener.onContextManualIOEventControl. Processing switched to the manual IOEvent control.
public void	onContextSuspend(final Context context) Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onContextSuspend. Implements org.glassfish.grizzly.IOEventLifeCycleListener.onContextSuspend. `IOEvent` processing suspended.
private void	recycle()
private int	size()
private void	unplug(final Context context) Releases the plug, which means we have to flush all the data and remove the PlugFilter attr from the context.

Inherited from org.glassfish.grizzly.IOEventLifeCycleListener.Adapter:: onContextResume onError onLeave onNotRun onReregister onRerun onTerminate

Field Detail

aggrCompletionHandler	back to summary
private HttpPipelineOptAddOn.PlugFilter.AggrCompletionHandler aggrCompletionHandler

buffer	back to summary
private CompositeBuffer buffer

CACHE_IDX	back to summary
private static final ThreadCache.CachedTypeIndex<HttpPipelineOptAddOn.PlugFilter.Plug> CACHE_IDX

cloner	back to summary
private final MessageCloner<Buffer> cloner

ctx	back to summary
private FilterChainContext ctx

isPlugged	back to summary
private boolean isPlugged

isWrittenInThisThread	back to summary
private boolean isWrittenInThisThread

plugFilter	back to summary
private HttpPipelineOptAddOn.PlugFilter plugFilter

Constructor Detail

Plug	back to summary
public Plug()

Method Detail

append	back to summary
private boolean append(final Buffer msg, final CompletionHandler<E> completionHandler) Appends buffer to the queue.

create	back to summary
public static HttpPipelineOptAddOn.PlugFilter.Plug create(final FilterChainContext ctx, final HttpPipelineOptAddOn.PlugFilter plugFilter)

flush	back to summary
private void flush() flushes buffered data Annotations @SuppressWarnings:unchecked

flush

back to summary

private void flush()

flushes buffered data

Annotations

@SuppressWarnings:unchecked

init	back to summary
pack-priv HttpPipelineOptAddOn.PlugFilter.Plug init(final FilterChainContext ctx, final HttpPipelineOptAddOn.PlugFilter plugFilter)

obtainAggrCompletionHandler	back to summary
private HttpPipelineOptAddOn.PlugFilter.AggrCompletionHandler obtainAggrCompletionHandler()

obtainCompositeBuffer	back to summary
private CompositeBuffer obtainCompositeBuffer()

onComplete back to summary

onComplete	back to summary
public void onComplete(final Context context, final Object data) throws IOException Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onComplete. Implements org.glassfish.grizzly.IOEventLifeCycleListener.onComplete. Doc from org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onComplete. `IOEvent` processing completed. Annotations @Override Exceptions IOException: Doc from org.glassfish.grizzly.IOEventLifeCycleListener.onComplete. on error

public void onComplete(final Context context, final Object data) throws IOException

Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onComplete.

Implements org.glassfish.grizzly.IOEventLifeCycleListener.onComplete.

Doc from org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onComplete.

IOEvent processing completed.

Annotations

@Override

Exceptions

IOException:

Doc from org.glassfish.grizzly.IOEventLifeCycleListener.onComplete.

on error

onContextManualIOEventControl back to summary

public void onContextManualIOEventControl(final Context context) throws IOException

Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onContextManualIOEventControl.

Implements org.glassfish.grizzly.IOEventLifeCycleListener.onContextManualIOEventControl.

Doc from org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onContextManualIOEventControl.

Processing switched to the manual IOEvent control. Connection#enableIOEvent(org.glassfish.grizzly.IOEvent) or Connection#disableIOEvent(org.glassfish.grizzly.IOEvent) might be explicitly called.

Annotations

@Override

onContextSuspend back to summary

public void onContextSuspend(final Context context) throws IOException

Overrides org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onContextSuspend.

Implements org.glassfish.grizzly.IOEventLifeCycleListener.onContextSuspend.

Doc from org.glassfish.grizzly.IOEventLifeCycleListener.Adapter.onContextSuspend.

IOEvent processing suspended.

Annotations

@Override

Exceptions

IOException:

Doc from org.glassfish.grizzly.IOEventLifeCycleListener.onContextSuspend.

on error

recycle	back to summary
private void recycle()

size	back to summary
private int size()

unplug	back to summary
private void unplug(final Context context) Releases the plug, which means we have to flush all the data and remove the PlugFilter attr from the context.