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

Modifier and Type	Field and Description
private final ExtensionFunction[]	delegates

Access	Constructor and Description
private	CompositeExtensionFunction(ExtensionFunction... delegates)

Method Summary

Modifier and Type	Method and Description
public static ExtensionFunction	compose(List<ExtensionFunction> functions)
public static ExtensionFunction	compose(ExtensionFunction... functions)
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.
public 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 lastFragementOfMessage) Implements io.undertow.websockets.extensions.ExtensionFunction.transformForRead. Transform the supplied buffer per this extension.
public 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

delegates	back to summary
private final ExtensionFunction[] delegates

CompositeExtensionFunction	back to summary
private CompositeExtensionFunction(ExtensionFunction... delegates)

Method Detail

compose	back to summary
public static ExtensionFunction compose(List<ExtensionFunction> functions)

compose	back to summary
public static ExtensionFunction compose(ExtensionFunction... functions)

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

transformForRead	back to summary
public PooledByteBuffer transformForRead(PooledByteBuffer pooledBuffer, StreamSourceFrameChannel channel, boolean lastFragementOfMessage) 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 lastFragementOfMessage: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 PooledByteBuffer transformForRead(PooledByteBuffer pooledBuffer, StreamSourceFrameChannel channel, boolean lastFragementOfMessage) 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
lastFragementOfMessage: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 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 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