Package org.jdrupes.httpcodec

Class ClientEngine<Q extends MessageHeader,R extends MessageHeader>

java.lang.Object

org.jdrupes.httpcodec.Engine

org.jdrupes.httpcodec.ClientEngine<Q,R>

Type Parameters:

Q - the message header type handled be the encoder (the request)

R - the message header type handled by the decoder (the response)

public class ClientEngine<Q extends MessageHeader,R extends MessageHeader>
extends Engine

An engine that can be used as a client.

It has an associated request encoder and a response decoder. Using a ClientEngine has two main advantages over using an encoder and decoder directly. It links encoder and decoder (see Encoder.setPeerDecoder(Decoder) and Decoder.setPeerEncoder(Encoder)) and it replaces the encoder and decoder if the decoded result indicates a switch. The change takes place upon the next encode or decode invocation. The “old” encoders and decoders are thus still available when the result of a decode invocation, that indicates a switch, is processed.

Constructor Summary

Constructors

Constructor	Description
ClientEngine(Encoder<Q,R> requestEncoder, Decoder<R,Q> responseDecoder)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
Optional<Q>	currentRequest()	Returns the last encoded request.
Decoder.Result<Q>	decode(ByteBuffer in, Buffer out, boolean endOfInput)	Convenience method to invoke the decoder’s decode method.
Codec.Result	encode(Buffer in, ByteBuffer out, boolean endOfInput)	Convenience method to invoke the encoder’s encode method.
Codec.Result	encode(ByteBuffer out)	Convenience method to invoke the encoder’s encode method.
void	encode(Q messageHeader)	Convenience method to invoke the encoder’s encode method.
Encoder<Q,R>	requestEncoder()
Decoder<R,Q>	responseDecoder()

Methods inherited from class org.jdrupes.httpcodec.Engine

setSwitchedTo, switchedTo

Methods inherited from class java.lang.Object

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

Constructor Details

ClientEngine

public ClientEngine(Encoder<Q,R> requestEncoder,
 Decoder<R,Q> responseDecoder)

Creates a new instance.

Parameters:

requestEncoder - the encoder for the request

responseDecoder - the decoder for the response

Method Details

requestEncoder

public Encoder<Q,R> requestEncoder()

Returns:

the requestEncoder

responseDecoder

public Decoder<R,Q> responseDecoder()

Returns:

the responseDecoder

encode

public Codec.Result encode(ByteBuffer out)

Convenience method to invoke the encoder’s encode method.

Parameters:

out - the buffer to use for the result

Returns:

the result

encode

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

Convenience method to invoke the encoder’s encode method.

Parameters:

in - the buffer with the data to encode

out - the buffer to use for the result

endOfInput - true if end of input

Returns:

the result

encode

public void encode(Q messageHeader)

Convenience method to invoke the encoder’s encode method.

Parameters:

messageHeader - the message header

decode

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

Convenience method to invoke the decoder’s decode method.

Parameters:

in - the buffer with the data to decode

out - the buffer to use for the result

endOfInput - true if end of input

Returns:

the result

Throws:

ProtocolException - if the input violates the protocol

See Also:

• HttpResponseDecoder.decode(java.nio.ByteBuffer, java.nio.Buffer, boolean)

currentRequest

public Optional<Q> currentRequest()

Returns the last encoded request.

Returns:

the request