Package org.omegazero.http.h1

Class HTTP1ResponseReceiver

java.lang.Object

org.omegazero.http.h1.HTTP1MessageReceiver

org.omegazero.http.h1.HTTP1ResponseReceiver

public class HTTP1ResponseReceiver
extends HTTP1MessageReceiver

A special HTTP1MessageReceiver used for receiving HTTPResponses.

Since:

1.2.1

Field Summary

Fields inherited from class org.omegazero.http.h1.HTTP1MessageReceiver

DEFAULT_MAX_HEADER_SIZE, lHeaders

Constructor Summary

Constructors

Constructor	Description
HTTP1ResponseReceiver()	Creates a new HTTP1ResponseReceiver with the default maximum message size.
HTTP1ResponseReceiver(int maxHeaderSize)	Creates a new HTTP1ResponseReceiver.

Method Summary

Modifier and Type	Method	Description
HTTPResponse	get()	Returns the HTTPMessage after successfully receiving it (HTTP1MessageReceiver.receive(byte[], int) returns a non-negative integer).
<T extends HTTPResponse> T	get(HTTPResponseSupplier<T> supplier)	Returns the HTTPResponse after successfully receiving it.
protected void	receiveStartLine(String[] startLine)	Called when a HTTP/1 start line is received.
void	reset()	Resets this HTTP1MessageReceiver to allow receipt of additional HTTPMessages.

Methods inherited from class org.omegazero.http.h1.HTTP1MessageReceiver

getHeaderSize, getVersion, isStartLineReceived, msgInit, receive, receiveHeader, receiveVersion

Methods inherited from class java.lang.Object

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

Constructor Details

HTTP1ResponseReceiver

public HTTP1ResponseReceiver()

Creates a new HTTP1ResponseReceiver with the default maximum message size.

HTTP1ResponseReceiver

public HTTP1ResponseReceiver(int maxHeaderSize)

Creates a new HTTP1ResponseReceiver.

Parameters:

maxHeaderSize - The maximum size in bytes of a single HTTP message

Method Details

receiveStartLine

protected void receiveStartLine(String[] startLine)
                         throws InvalidHTTPMessageException

Description copied from class: HTTP1MessageReceiver

Called when a HTTP/1 start line is received.

Specified by:

receiveStartLine in class HTTP1MessageReceiver

Parameters:

startLine - The start line components

Throws:

InvalidHTTPMessageException - If the start line is malformed

get

public HTTPResponse get()

Returns the HTTPMessage after successfully receiving it (HTTP1MessageReceiver.receive(byte[], int) returns a non-negative integer).

A call to this method should be followed by a call to HTTP1MessageReceiver.reset() to allow the next HTTP message to be received.

It is unspecified whether multiple calls to this method return the same HTTPMessage instance.

Specified by:

get in class HTTP1MessageReceiver

Returns:

The HTTPMessage

See Also:

• get(HTTPResponseSupplier)

get

public <T extends HTTPResponse> T get(HTTPResponseSupplier<T> supplier)

Returns the HTTPResponse after successfully receiving it. See get().

Type Parameters:

T - The specific HTTPResponse type this method creates

Parameters:

supplier - A HTTPResponseSupplier for creating the HTTPResponse

Returns:

The HTTPResponse

Throws:

IllegalStateException - If no HTTPMessage was received yet

reset

public void reset()

Description copied from class: HTTP1MessageReceiver

Resets this HTTP1MessageReceiver to allow receipt of additional HTTPMessages.

Overrides:

reset in class HTTP1MessageReceiver