Undertow 2.3.12.Final · io.undertow.websockets.extensions.PerMessageDeflateFunction

Implementation of permessage-deflate WebSocket Extension.

This implementation supports parameters: server_no_context_takeover, client_no_context_takeover .

This implementation does not support parameters: server_max_window_bits, client_max_window_bits .

It uses the DEFLATE implementation algorithm packaged on Deflater and Inflater classes.

Field Summary

Modifier and Type	Field and Description
private final Deflater	compress
private final boolean	compressContextTakeover
private StreamSourceFrameChannel	currentReadChannel
private final Inflater	decompress
private final boolean	decompressContextTakeover
private final int	deflaterLevel
private static final byte[]	TAIL

Constructor Summary

Access	Constructor and Description
public	PerMessageDeflateFunction(final int the level of configuration of DEFLATE algorithm implementation deflaterLevel, boolean flag for compressor context takeover or without compressor context compressContextTakeover, boolean flag for decompressor context takeover or without decompressor context decompressContextTakeover) Create a new `PerMessageDeflateExtension` instance.

Method Summary

Modifier and Type	Method and Description
private PooledByteBuffer	allocateBufferWithArray(WebSocketChannel channel, int size)
private PooledByteBuffer	decompress(WebSocketChannel channel, PooledByteBuffer pooled)
public void	dispose() Implements io.undertow.websockets.extensions.ExtensionFunction.dispose. Dispose this function.
public boolean	hasExtensionOpCode() Implements io.undertow.websockets.extensions.ExtensionFunction.hasExtensionOpCode. Validate if current extension defines a new WebSocket Opcode.
private PooledByteBuffer	largerBuffer(PooledByteBuffer smaller, WebSocketChannel channel, int newSize)
private PooledByteBuffer	toArrayBacked(ByteBuffer buffer, ByteBufferPool pool)
public synchronized PooledByteBuffer	transformForRead(PooledByteBuffer Buffer to transform pooledBuffer, StreamSourceFrameChannel working channel channel, boolean If this frame is the last fragment of a message. Note that this may not be received for every message, if the message ends with an empty frame lastFragmentOfMessage) Implements io.undertow.websockets.extensions.ExtensionFunction.transformForRead. Transform the supplied buffer per this extension.
public synchronized PooledByteBuffer	transformForWrite(PooledByteBuffer Buffer to transform pooledBuffer, StreamSinkFrameChannel working channel channel, boolean lastFrame) Implements io.undertow.websockets.extensions.ExtensionFunction.transformForWrite. Transform the supplied buffer per this extension.
public int	writeRsv(int current RSV bits status rsv) Implements io.undertow.websockets.extensions.ExtensionFunction.writeRsv. Add RSV bits (RSV1, RSV2, RSV3) to the current rsv status.

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

Field Detail

compress	back to summary
private final Deflater compress

compressContextTakeover	back to summary
private final boolean compressContextTakeover

currentReadChannel	back to summary
private StreamSourceFrameChannel currentReadChannel

decompress	back to summary
private final Inflater decompress

decompressContextTakeover	back to summary
private final boolean decompressContextTakeover

deflaterLevel	back to summary
private final int deflaterLevel

TAIL	back to summary
private static final byte[] TAIL

Constructor Detail

PerMessageDeflateFunction back to summary

PerMessageDeflateFunction	back to summary
public PerMessageDeflateFunction(final int deflaterLevel, boolean compressContextTakeover, boolean decompressContextTakeover) Create a new `PerMessageDeflateExtension` instance. Parameters deflaterLevel:int the level of configuration of DEFLATE algorithm implementation compressContextTakeover:boolean flag for compressor context takeover or without compressor context decompressContextTakeover:boolean flag for decompressor context takeover or without decompressor context

public PerMessageDeflateFunction(final int deflaterLevel, boolean compressContextTakeover, boolean decompressContextTakeover)

Create a new PerMessageDeflateExtension instance.

Parameters

deflaterLevel:int: the level of configuration of DEFLATE algorithm implementation
compressContextTakeover:boolean: flag for compressor context takeover or without compressor context
decompressContextTakeover:boolean: flag for decompressor context takeover or without decompressor context

Method Detail

allocateBufferWithArray	back to summary
private PooledByteBuffer allocateBufferWithArray(WebSocketChannel channel, int size)

decompress	back to summary
private PooledByteBuffer decompress(WebSocketChannel channel, PooledByteBuffer pooled) throws IOException

dispose	back to summary
public void dispose() Implements io.undertow.websockets.extensions.ExtensionFunction.dispose. Doc from io.undertow.websockets.extensions.ExtensionFunction.dispose. Dispose this function. Called upon connection closure Annotations @Override

dispose

back to summary

public void dispose()

Implements io.undertow.websockets.extensions.ExtensionFunction.dispose.

Doc from io.undertow.websockets.extensions.ExtensionFunction.dispose.

Dispose this function. Called upon connection closure

Annotations

@Override

hasExtensionOpCode back to summary

hasExtensionOpCode	back to summary
public boolean hasExtensionOpCode() Implements io.undertow.websockets.extensions.ExtensionFunction.hasExtensionOpCode. Doc from io.undertow.websockets.extensions.ExtensionFunction.hasExtensionOpCode. Validate if current extension defines a new WebSocket Opcode. Returns:boolean `true` if current extension defines specific Opcode `false` is current extension does not define specific Opcode Annotations @Override

public boolean hasExtensionOpCode()

Implements io.undertow.websockets.extensions.ExtensionFunction.hasExtensionOpCode.

Doc from io.undertow.websockets.extensions.ExtensionFunction.hasExtensionOpCode.

Validate if current extension defines a new WebSocket Opcode.

Returns:boolean

true if current extension defines specific Opcode false is current extension does not define specific Opcode

Annotations

@Override

largerBuffer	back to summary
private PooledByteBuffer largerBuffer(PooledByteBuffer smaller, WebSocketChannel channel, int newSize)

toArrayBacked	back to summary
private PooledByteBuffer toArrayBacked(ByteBuffer buffer, ByteBufferPool pool)

transformForRead	back to summary
public synchronized PooledByteBuffer transformForRead(PooledByteBuffer pooledBuffer, StreamSourceFrameChannel channel, boolean lastFragmentOfMessage) throws IOException Implements io.undertow.websockets.extensions.ExtensionFunction.transformForRead. Doc from io.undertow.websockets.extensions.ExtensionFunction.transformForRead. Transform the supplied buffer per this extension. The buffer can be modified in place, or a new pooled buffer can be returned (in which case be sure to free the original buffer Parameters pooledBuffer:PooledByteBuffer Buffer to transform channel:StreamSourceFrameChannel working channel lastFragmentOfMessage:boolean If this frame is the last fragment of a message. Note that this may not be received for every message, if the message ends with an empty frame Returns:PooledByteBuffer transformed buffer (may be the same one, just with modified contents) Annotations @Override

transformForRead

back to summary

public synchronized PooledByteBuffer transformForRead(PooledByteBuffer pooledBuffer, StreamSourceFrameChannel channel, boolean lastFragmentOfMessage) throws IOException

Implements io.undertow.websockets.extensions.ExtensionFunction.transformForRead.

Doc from io.undertow.websockets.extensions.ExtensionFunction.transformForRead.

Transform the supplied buffer per this extension. The buffer can be modified in place, or a new pooled buffer can be returned (in which case be sure to free the original buffer

Parameters

pooledBuffer:PooledByteBuffer: Buffer to transform
channel:StreamSourceFrameChannel: working channel
lastFragmentOfMessage:boolean: If this frame is the last fragment of a message. Note that this may not be received for every message, if the message ends with an empty frame

Returns:PooledByteBuffer

transformed buffer (may be the same one, just with modified contents)

Annotations

@Override

transformForWrite	back to summary
public synchronized PooledByteBuffer transformForWrite(PooledByteBuffer pooledBuffer, StreamSinkFrameChannel channel, boolean lastFrame) throws IOException Implements io.undertow.websockets.extensions.ExtensionFunction.transformForWrite. Doc from io.undertow.websockets.extensions.ExtensionFunction.transformForWrite. Transform the supplied buffer per this extension. The buffer can be modified in place, or a new pooled buffer can be returned (in which case be sure to free the original buffer Parameters pooledBuffer:PooledByteBuffer Buffer to transform channel:StreamSinkFrameChannel working channel Returns:PooledByteBuffer transformed buffer (may be the same one, just with modified contents) Annotations @Override

transformForWrite

back to summary

public synchronized PooledByteBuffer transformForWrite(PooledByteBuffer pooledBuffer, StreamSinkFrameChannel channel, boolean lastFrame) throws IOException

Implements io.undertow.websockets.extensions.ExtensionFunction.transformForWrite.

Doc from io.undertow.websockets.extensions.ExtensionFunction.transformForWrite.

Transform the supplied buffer per this extension. The buffer can be modified in place, or a new pooled buffer can be returned (in which case be sure to free the original buffer

Parameters

pooledBuffer:PooledByteBuffer: Buffer to transform
channel:StreamSinkFrameChannel: working channel

Returns:PooledByteBuffer

transformed buffer (may be the same one, just with modified contents)

Annotations

@Override

writeRsv	back to summary
public int writeRsv(int rsv) Implements io.undertow.websockets.extensions.ExtensionFunction.writeRsv. Doc from io.undertow.websockets.extensions.ExtensionFunction.writeRsv. Add RSV bits (RSV1, RSV2, RSV3) to the current rsv status. Parameters rsv:int current RSV bits status Returns:int rsv status Annotations @Override

writeRsv

back to summary

public int writeRsv(int rsv)

Implements io.undertow.websockets.extensions.ExtensionFunction.writeRsv.

Doc from io.undertow.websockets.extensions.ExtensionFunction.writeRsv.

Add RSV bits (RSV1, RSV2, RSV3) to the current rsv status.

Parameters