org.apache.hc.core5.websocket

Interface WebSocketExtension

All Known Implementing Classes:

PerMessageDeflateExtension

public interface WebSocketExtension

Method Summary

Modifier and Type	Method and Description
default void	close() Releases any native resources held by this extension (e.g. a Deflater or Inflater).
default ByteBuffer	decode(WebSocketFrameType type, boolean fin, ByteBuffer payload)
default ByteBuffer	decode(WebSocketFrameType type, boolean fin, ByteBuffer payload, long maxOutputSize) Decode a frame payload, aborting as soon as the produced output exceeds maxOutputSize.
default ByteBuffer	encode(WebSocketFrameType type, boolean fin, ByteBuffer payload)
String	getName()
default WebSocketExtensionData	getResponseData()
default boolean	usesRsv1()
default boolean	usesRsv2()
default boolean	usesRsv3()

Method Detail

getName

String getName()

usesRsv1

default boolean usesRsv1()

usesRsv2

default boolean usesRsv2()

usesRsv3

default boolean usesRsv3()

decode

default ByteBuffer decode(WebSocketFrameType type,
                          boolean fin,
                          ByteBuffer payload)
                   throws WebSocketException

Throws:

WebSocketException

decode

default ByteBuffer decode(WebSocketFrameType type,
                          boolean fin,
                          ByteBuffer payload,
                          long maxOutputSize)
                   throws WebSocketException

Decode a frame payload, aborting as soon as the produced output exceeds maxOutputSize. A non-positive limit means no limit. Implementations that may expand input (e.g. permessage-deflate) MUST honour the limit during the expansion step, not only after it, to prevent decompression-bomb attacks.

Throws:

WebSocketException

Since:

5.7

encode

default ByteBuffer encode(WebSocketFrameType type,
                          boolean fin,
                          ByteBuffer payload)
                   throws WebSocketException

Throws:

WebSocketException

getResponseData

default WebSocketExtensionData getResponseData()

close

default void close()

Releases any native resources held by this extension (e.g. a Deflater or Inflater). Called once when the owning session terminates.

Since:

5.7