Package org.jdrupes.httpcodec

Interface Decoder<T extends MessageHeader,R extends MessageHeader>

Type Parameters:

T - the type of message decoded by this decoder

R - the type of message that may be generated as response (see Decoder.Result.response())

All Superinterfaces:

Codec

All Known Implementing Classes:

HttpDecoder, HttpRequestDecoder, HttpResponseDecoder, WsDecoder

public interface Decoder<T extends MessageHeader,R extends MessageHeader>
extends Codec

The general interface of a decoder.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Decoder.Result<R extends MessageHeader>	The result from decoding.

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

Codec.ProtocolSwitchResult

Field Summary

Fields inherited from interface org.jdrupes.httpcodec.Codec

EMPTY_IN

Method Summary

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

Method Details

setPeerEncoder

Decoder<T,R> setPeerEncoder(Encoder<R,T> encoder)

Sets the peer encoder.

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

Parameters:

encoder - the encoder

Returns:

the decoder

decoding

Class<T> decoding()

Returns the type of the messages decoded by this decoder.

Returns:

the value

decode

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

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.

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

header

Optional<T> header()

Returns the last message (header) received.

If a header is completed during a 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.

Returns:

the result