Package org.jdrupes.httpcodec.protocols.websocket

Class WsEncoder

java.lang.Object

org.jdrupes.httpcodec.protocols.websocket.WsCodec

org.jdrupes.httpcodec.protocols.websocket.WsEncoder

All Implemented Interfaces:

Codec, Encoder<WsFrameHeader,WsFrameHeader>

public class WsEncoder
extends WsCodec
implements Encoder<WsFrameHeader,WsFrameHeader>

The Websocket encoder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WsEncoder.Result	Results from HttpEncoder provide no additional information compared to Codec.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
WsEncoder(boolean mask)	Creates new encoder.

Method Summary

Modifier and Type	Method	Description
WsEncoder.Result	encode(Buffer in, ByteBuffer out, boolean endOfInput)	Encodes a message.
void	encode(WsFrameHeader messageHeader)	Set the header of the message that is to be encoded.
Class<WsFrameHeader>	encoding()	Returns the type of the messages encoded by this encoder.
Optional<WsFrameHeader>	header()	Returns the last message (header) encoded.
protected WsEncoder.Result.Factory	resultFactory()	Returns the result factory for this codec.
Encoder<WsFrameHeader,WsFrameHeader>	setPeerDecoder(Decoder<WsFrameHeader,WsFrameHeader> decoder)	Sets the peer decoder.

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

Methods inherited from interface org.jdrupes.httpcodec.Encoder

encode

Constructor Details

WsEncoder

public WsEncoder(boolean mask)

Creates new encoder.

Parameters:

mask - set if the data is to be masked (client)

Method Details

setPeerDecoder

public Encoder<WsFrameHeader,WsFrameHeader> setPeerDecoder(Decoder<WsFrameHeader,WsFrameHeader> decoder)

Description copied from interface: Encoder

Sets the peer decoder.

Some decoder implementations need to know the state of the decoder or the last decoded message.

Specified by:

setPeerDecoder in interface Encoder<WsFrameHeader,WsFrameHeader>

Parameters:

decoder - the decoder

Returns:

the encoder

resultFactory

protected WsEncoder.Result.Factory resultFactory()

Returns the result factory for this codec.

Returns:

the factory

encoding

public Class<WsFrameHeader> encoding()

Description copied from interface: Encoder

Returns the type of the messages encoded by this encoder.

Specified by:

encoding in interface Encoder<WsFrameHeader,WsFrameHeader>

Returns:

the value

encode

public void encode(WsFrameHeader messageHeader)

Description copied from interface: Encoder

Set the header of the message that is to be encoded.

Must be invoked before the first invocation to any encode method for a given message.

Specified by:

encode in interface Encoder<WsFrameHeader,WsFrameHeader>

Parameters:

messageHeader - the message header

encode

public WsEncoder.Result encode(Buffer in,
 ByteBuffer out,
 boolean endOfInput)

Description copied from interface: Encoder

Encodes a message.

First encodes the message header set by Encoder.encode(MessageHeader) and then (optionally) adds payload data from in.

Specified by:

encode in interface Encoder<WsFrameHeader,WsFrameHeader>

Parameters:

in - the body data

out - the buffer to which data is written

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

header

public Optional<WsFrameHeader> header()

Description copied from interface: Encoder

Returns the last message (header) encoded.

Specified by:

header in interface Encoder<WsFrameHeader,WsFrameHeader>

Returns:

the result