org.apache.hc.core5.websocket

Class PerMessageDeflateExtension

java.lang.Object

org.apache.hc.core5.websocket.PerMessageDeflateExtension

All Implemented Interfaces:

WebSocketExtension

public final class PerMessageDeflateExtension
extends Object
implements WebSocketExtension

Constructor Summary

Constructors

Constructor and Description
PerMessageDeflateExtension()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hc.core5.websocket.WebSocketExtension

usesRsv2, usesRsv3

Constructor Detail

PerMessageDeflateExtension

public PerMessageDeflateExtension()

Method Detail

getName

public String getName()

Specified by:

getName in interface WebSocketExtension

usesRsv1

public boolean usesRsv1()

Specified by:

usesRsv1 in interface WebSocketExtension

decode

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

Specified by:

decode in interface WebSocketExtension

Throws:

WebSocketException

decode

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

Description copied from interface: WebSocketExtension

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.

Specified by:

decode in interface WebSocketExtension

Throws:

WebSocketException

encode

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

Specified by:

encode in interface WebSocketExtension

Throws:

WebSocketException

getResponseData

public WebSocketExtensionData getResponseData()

Specified by:

getResponseData in interface WebSocketExtension

close

public void close()

Description copied from interface: WebSocketExtension

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

Specified by:

close in interface WebSocketExtension