Package org.jdrupes.httpcodec.protocols.websocket

Class WsDecoder

java.lang.Object

org.jdrupes.httpcodec.protocols.websocket.WsCodec

org.jdrupes.httpcodec.protocols.websocket.WsDecoder

All Implemented Interfaces:

Codec, Decoder<WsFrameHeader,WsFrameHeader>

public class WsDecoder
extends WsCodec
implements Decoder<WsFrameHeader,WsFrameHeader>

The Websocket decoder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WsDecoder.Result	Results from WsDecoder add no additional information to Decoder.Result.

Nested classes/interfaces inherited from class org.jdrupes.httpcodec.protocols.websocket.WsCodec

WsCodec.ClosingState

Nested classes/interfaces inherited from interface org.jdrupes.httpcodec.Codec

Codec.ProtocolSwitchResult

Field Summary

Fields inherited from interface org.jdrupes.httpcodec.Codec

EMPTY_IN

Constructor Summary

Constructors

Constructor	Description
WsDecoder()

Method Summary

Modifier and Type	Method	Description
Decoder.Result<WsFrameHeader>	decode(ByteBuffer in, Buffer out, boolean endOfInput)	Decodes the next chunk of data.
Class<WsFrameHeader>	decoding()	Returns the type of the messages decoded by this decoder.
Optional<WsFrameHeader>	header()	Returns the last message (header) received.
protected WsDecoder.Result.Factory	resultFactory()	Returns the result factory for this codec.
Decoder<WsFrameHeader,WsFrameHeader>	setPeerEncoder(Encoder<WsFrameHeader,WsFrameHeader> encoder)	Sets the peer encoder.

Methods inherited from class org.jdrupes.httpcodec.protocols.websocket.WsCodec

closingState, linkClosingState, setClosingState

Methods inherited from class java.lang.Object

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

Constructor Details

WsDecoder

public WsDecoder()

Method Details

setPeerEncoder

public Decoder<WsFrameHeader,WsFrameHeader> setPeerEncoder(Encoder<WsFrameHeader,WsFrameHeader> encoder)

Description copied from interface: Decoder

Sets the peer encoder.

Some decoders need to know the state of the encoder or the last encoded message.

Specified by:

setPeerEncoder in interface Decoder<WsFrameHeader,WsFrameHeader>

Parameters:

encoder - the encoder

Returns:

the decoder

resultFactory

protected WsDecoder.Result.Factory resultFactory()

Returns the result factory for this codec.

Returns:

the factory

decoding

public Class<WsFrameHeader> decoding()

Description copied from interface: Decoder

Returns the type of the messages decoded by this decoder.

Specified by:

decoding in interface Decoder<WsFrameHeader,WsFrameHeader>

Returns:

the value

header

public Optional<WsFrameHeader> header()

Description copied from interface: Decoder

Returns the last message (header) received.

If a header is completed during a Decoder.decode(ByteBuffer, Buffer, boolean) invocation, the result’s Decoder.Result.isHeaderCompleted() is true and the header can be retrieved using this method. It remains available until decode is invoked for a new message (i.e. is invoked again after returning a result with Codec.Result.isUnderflow() being false.

Specified by:

header in interface Decoder<WsFrameHeader,WsFrameHeader>

Returns:

the result

decode

public Decoder.Result<WsFrameHeader> decode(ByteBuffer in,
 Buffer out,
 boolean endOfInput)
                                     throws ProtocolException

Description copied from interface: Decoder

Decodes the next chunk of data.

This method will never leave remaining data in the in buffer unless a header has been decoded completely and/or the out buffer is full. In either case, decoding will therefore continue when the method is invoked again with the same in buffer and another (or emptied) out buffer. It is never necessary (though possible) to add data to an existing in buffer.

Specified by:

decode in interface Decoder<WsFrameHeader,WsFrameHeader>

Parameters:

in - holds the data to be decoded

out - gets the body data (if any) written to it

endOfInput - true if there is no input left beyond the data currently in the in buffer (indicates end of body or no body at all)

Returns:

the result

Throws:

ProtocolException - if the message violates the HTTP