Package org.omegazero.http.h2

Class HTTP2Client

java.lang.Object

org.omegazero.http.h2.HTTP2Endpoint

org.omegazero.http.h2.HTTP2Client

public class HTTP2Client
extends HTTP2Endpoint

An instance of this class represents a HTTP/2 client, a special type of HTTP2Endpoint.

Since:

1.2.1

Field Summary

Fields inherited from class org.omegazero.http.h2.HTTP2Endpoint

closeWaitStreams, closeWaitTimeout, connection, highestStreamId, hpack, peerInitiatedStreams, settings, streams

Constructor Summary

Constructors

Constructor	Description
HTTP2Client(WritableSocket connection, HTTP2Settings settings, HPackContext hpack)	Creates a new HTTP2Client instance.
HTTP2Client(WritableSocket connection, HTTP2Settings settings, HPackContext.Session hpackSession, boolean useHuffmanEncoding)	Creates a new HTTP2Client instance.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this client.
MessageStream	createRequestStream()	Creates a new MessageStream to send a request with.
MessageStream	handlePushPromise(HTTPRequest promisedRequest)	Creates a new MessageStream that expects to receive a promise response by the server.
protected HTTP2Stream	newStreamForFrame(int streamId, int type, int flags, byte[] payload)	Processes a frame received on a previously nonexistent stream and creates a new HTTP2Stream for it, if appropriate.
void	onMessageStreamClosed(MessageStream messageStream)	This method must be called by the application after a message stream returned by createRequestStream() or handlePushPromise(HTTPRequest) closed to remove it from internal storage.
protected void	onSettingsUpdate(HTTP2Settings settings)	This method is called when a SETTINGS frame is received from the server.
void	start()	Starts the HTTP/2 client by sending the client connection preface and SETTINGS frame.

Methods inherited from class org.omegazero.http.h2.HTTP2Endpoint

checkLocalCreateStream, checkRemoteCreateStream, getConnection, getControlStream, getOpenLocallyInitiatedMessageStreamCount, getOpenMessageStreamCount, getOpenPeerInitiatedMessageStreamCount, getStream, getStreams, handleConnectionWindowUpdate, processData, processData0, registerStream, registerStream, streamClosed

Methods inherited from class java.lang.Object

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

Constructor Details

HTTP2Client

public HTTP2Client(WritableSocket connection,
 HTTP2Settings settings,
 HPackContext.Session hpackSession,
 boolean useHuffmanEncoding)

Creates a new HTTP2Client instance.

Parameters:

connection - The underlying connection

settings - The local settings

hpackSession - The HPACK session to use

useHuffmanEncoding - Whether to enable HPACK Huffman Coding

HTTP2Client

public HTTP2Client(WritableSocket connection,
 HTTP2Settings settings,
 HPackContext hpack)

Creates a new HTTP2Client instance.

Parameters:

connection - The underlying connection

settings - The local settings

hpack - The HPackContext to use

Method Details

start

public void start()

Starts the HTTP/2 client by sending the client connection preface and SETTINGS frame.

createRequestStream

public MessageStream createRequestStream()

Creates a new MessageStream to send a request with. The caller will need to call MessageStream.sendHTTPMessage(org.omegazero.http.common.HTTPMessage, boolean) on the returned stream to start the message exchange.

Returns:

The created MessageStream, or null if no MessageStream could be created

See Also:

• onMessageStreamClosed(MessageStream)

handlePushPromise

public MessageStream handlePushPromise(HTTPRequest promisedRequest)
                                throws HTTP2ConnectionError

Creates a new MessageStream that expects to receive a promise response by the server.

The stream ID of the HTTPRequest is the promised stream ID by the server and must be an even number.

Usable in the onPushPromise callback of a MessageStream.

Parameters:

promisedRequest - The promise request sent by the server

Returns:

The created MessageStream

Throws:

IllegalArgumentException - If the given request is not a valid pushed request

HTTP2ConnectionError - If MAX_CONCURRENT_STREAMS is exceeded

See Also:

• onMessageStreamClosed(MessageStream)

onMessageStreamClosed

public void onMessageStreamClosed(MessageStream messageStream)

This method must be called by the application after a message stream returned by createRequestStream() or handlePushPromise(HTTPRequest) closed to remove it from internal storage. Calls HTTP2Endpoint.streamClosed(MessageStream).

Parameters:

messageStream - The closed message stream

Throws:

IllegalStateException - If the stream is not closed

close

public void close()

Closes this client. Prior to closing the underlying connection, all active message streams are canceled and a GOAWAY frame is sent with no error.

Throws:

IOException - If an IO error occurs

onSettingsUpdate

protected void onSettingsUpdate(HTTP2Settings settings)

This method is called when a SETTINGS frame is received from the server.

Parameters:

settings - The new remote settings

newStreamForFrame

protected HTTP2Stream newStreamForFrame(int streamId,
 int type,
 int flags,
 byte[] payload)

Description copied from class: HTTP2Endpoint

Processes a frame received on a previously nonexistent stream and creates a new HTTP2Stream for it, if appropriate.

The returned stream is registered automatically using HTTP2Endpoint.registerStream(HTTP2Stream, boolean). If null is returned (no stream was created), and the frame type is not PRIORITY, it will be treated as a connection error of type PROTOCOL_ERROR.

When creating a stream, the implementation should call HTTP2Endpoint.checkRemoteCreateStream() first.

Specified by:

newStreamForFrame in class HTTP2Endpoint

Parameters:

streamId - The stream ID of the new stream

type - The frame type

flags - The frame flags

payload - The frame payload

Returns:

The new stream, or null if no stream is appropriate