Package org.jdrupes.httpcodec.protocols.http.server

Class HttpResponseEncoder.Result

java.lang.Object

org.jdrupes.httpcodec.Codec.Result

org.jdrupes.httpcodec.protocols.http.HttpEncoder.Result

org.jdrupes.httpcodec.protocols.http.server.HttpResponseEncoder.Result

All Implemented Interfaces:

Codec.ProtocolSwitchResult

Enclosing class:

HttpResponseEncoder

public abstract static class HttpResponseEncoder.Result
extends HttpEncoder.Result
implements Codec.ProtocolSwitchResult

The result from encoding a response.

In addition to the usual codec result, a response encoder may signal to the invoker that the connection to the requester must be closed and that the protocol has been switched.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	HttpResponseEncoder.Result.Factory	A factory for creating new Results.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Result(boolean overflow, boolean underflow, boolean closeConnection, String newProtocol, Decoder<?,?> newDecoder, Encoder<?,?> newEncoder)	Returns a new result.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
Decoder<?,?>	newDecoder()	The decoder to be used for the next message if a protocol switch occured.
Encoder<?,?>	newEncoder()	The encoder to be used for the next message if a protocol switch occured.
String	newProtocol()	The name of the protocol to be used for the next request if a protocol switch occured.
String	toString()

Methods inherited from class org.jdrupes.httpcodec.Codec.Result

closeConnection, isOverflow, isUnderflow

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Result

protected Result(boolean overflow,
 boolean underflow,
 boolean closeConnection,
 String newProtocol,
 Decoder<?,?> newDecoder,
 Encoder<?,?> newEncoder)

Returns a new result.

Parameters:

overflow - true if the data didn’t fit in the out buffer

underflow - true if more data is expected

closeConnection - true if the connection should be closed

newProtocol - the name of the new protocol if a switch occurred

newDecoder - the new decoder if a switch occurred

newEncoder - the new decoder if a switch occurred

Method Details

newProtocol

public String newProtocol()

Description copied from interface: Codec.ProtocolSwitchResult

The name of the protocol to be used for the next request if a protocol switch occured.

Specified by:

newProtocol in interface Codec.ProtocolSwitchResult

Returns:

the name or null if no protocol switch occured

newEncoder

public Encoder<?,?> newEncoder()

Description copied from interface: Codec.ProtocolSwitchResult

The encoder to be used for the next message if a protocol switch occured.

Specified by:

newEncoder in interface Codec.ProtocolSwitchResult

Returns:

the encoder or null if no protocol switch occurred

newDecoder

public Decoder<?,?> newDecoder()

Description copied from interface: Codec.ProtocolSwitchResult

The decoder to be used for the next message if a protocol switch occured.

Specified by:

newDecoder in interface Codec.ProtocolSwitchResult

Returns:

the decoder or null if no protocol switch occurred

hashCode

public int hashCode()

Overrides:

hashCode in class Codec.Result

equals

public boolean equals(Object obj)

Overrides:

equals in class Codec.Result

toString

public String toString()

Overrides:

toString in class Codec.Result