okhttp3.internal.http2

Class Http2Connection.ReaderRunnable

java.lang.Object

okhttp3.internal.NamedRunnable

okhttp3.internal.http2.Http2Connection.ReaderRunnable

All Implemented Interfaces:

java.lang.Runnable, Http2Reader.Handler

Enclosing class:

Http2Connection

class Http2Connection.ReaderRunnable
extends NamedRunnable
implements Http2Reader.Handler

Methods in this class must not lock FrameWriter. If a method needs to write a frame, create an async task to do so.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Http2Reader	reader

Fields inherited from class okhttp3.internal.NamedRunnable

name

Constructor Summary

Constructors

Constructor and Description
ReaderRunnable(Http2Reader reader)

Method Summary

Modifier and Type	Method and Description
void	ackSettings() HTTP/2 only.
void	alternateService(int streamId, java.lang.String origin, okio.ByteString protocol, java.lang.String host, int port, long maxAge) HTTP/2 only.
private void	applyAndAckSettings(Settings peerSettings)
void	data(boolean inFinished, int streamId, okio.BufferedSource source, int length)
protected void	execute()
void	goAway(int lastGoodStreamId, ErrorCode errorCode, okio.ByteString debugData) The peer tells us to stop creating streams.
void	headers(boolean inFinished, int streamId, int associatedStreamId, java.util.List<Header> headerBlock) Create or update incoming headers, creating the corresponding streams if necessary.
void	ping(boolean reply, int payload1, int payload2) Read a connection-level ping from the peer.
void	priority(int streamId, int streamDependency, int weight, boolean exclusive) Called when reading a headers or priority frame.
void	pushPromise(int streamId, int promisedStreamId, java.util.List<Header> requestHeaders) HTTP/2 only.
void	rstStream(int streamId, ErrorCode errorCode)
void	settings(boolean clearPrevious, Settings newSettings)
void	windowUpdate(int streamId, long windowSizeIncrement) Notifies that an additional windowSizeIncrement bytes can be sent on streamId, or the connection if streamId is zero.

Methods inherited from class okhttp3.internal.NamedRunnable

run

Methods inherited from class java.lang.Object

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

Field Detail

reader

final Http2Reader reader

Constructor Detail

ReaderRunnable

ReaderRunnable(Http2Reader reader)

Method Detail

execute

protected void execute()

Specified by:

execute in class NamedRunnable

data

public void data(boolean inFinished,
                 int streamId,
                 okio.BufferedSource source,
                 int length)
          throws java.io.IOException

Specified by:

data in interface Http2Reader.Handler

Throws:

java.io.IOException

headers

public void headers(boolean inFinished,
                    int streamId,
                    int associatedStreamId,
                    java.util.List<Header> headerBlock)

Description copied from interface: Http2Reader.Handler

Create or update incoming headers, creating the corresponding streams if necessary. Frames that trigger this are HEADERS and PUSH_PROMISE.

Specified by:

headers in interface Http2Reader.Handler

Parameters:

inFinished - true if the sender will not send further frames.

streamId - the stream owning these headers.

associatedStreamId - the stream that triggered the sender to create this stream.

rstStream

public void rstStream(int streamId,
                      ErrorCode errorCode)

Specified by:

rstStream in interface Http2Reader.Handler

settings

public void settings(boolean clearPrevious,
                     Settings newSettings)

Specified by:

settings in interface Http2Reader.Handler

applyAndAckSettings

private void applyAndAckSettings(Settings peerSettings)

ackSettings

public void ackSettings()

Description copied from interface: Http2Reader.Handler

HTTP/2 only.

Specified by:

ackSettings in interface Http2Reader.Handler

ping

public void ping(boolean reply,
                 int payload1,
                 int payload2)

Description copied from interface: Http2Reader.Handler

Read a connection-level ping from the peer. ack indicates this is a reply. The data in payload1 and payload2 opaque binary, and there are no rules on the content.

Specified by:

ping in interface Http2Reader.Handler

goAway

public void goAway(int lastGoodStreamId,
                   ErrorCode errorCode,
                   okio.ByteString debugData)

Description copied from interface: Http2Reader.Handler

The peer tells us to stop creating streams. It is safe to replay streams with ID > lastGoodStreamId on a new connection. In- flight streams with ID <= lastGoodStreamId can only be replayed on a new connection if they are idempotent.

Specified by:

goAway in interface Http2Reader.Handler

Parameters:

lastGoodStreamId - the last stream ID the peer processed before sending this message. If lastGoodStreamId is zero, the peer processed no frames.

errorCode - reason for closing the connection.

debugData - only valid for HTTP/2; opaque debug data to send.

windowUpdate

public void windowUpdate(int streamId,
                         long windowSizeIncrement)

Description copied from interface: Http2Reader.Handler

Notifies that an additional windowSizeIncrement bytes can be sent on streamId, or the connection if streamId is zero.

Specified by:

windowUpdate in interface Http2Reader.Handler

priority

public void priority(int streamId,
                     int streamDependency,
                     int weight,
                     boolean exclusive)

Description copied from interface: Http2Reader.Handler

Called when reading a headers or priority frame. This may be used to change the stream's weight from the default (16) to a new value.

Specified by:

priority in interface Http2Reader.Handler

Parameters:

streamId - stream which has a priority change.

streamDependency - the stream ID this stream is dependent on.

weight - relative proportion of priority in [1..256].

exclusive - inserts this stream ID as the sole child of streamDependency.

pushPromise

public void pushPromise(int streamId,
                        int promisedStreamId,
                        java.util.List<Header> requestHeaders)

Description copied from interface: Http2Reader.Handler

HTTP/2 only. Receive a push promise header block.

A push promise contains all the headers that pertain to a server-initiated request, and a promisedStreamId to which response frames will be delivered. Push promise frames are sent as a part of the response to streamId.

Specified by:

pushPromise in interface Http2Reader.Handler

Parameters:

streamId - client-initiated stream ID. Must be an odd number.

promisedStreamId - server-initiated stream ID. Must be an even number.

requestHeaders - minimally includes :method, :scheme, :authority, and (@code :path}.

alternateService

public void alternateService(int streamId,
                             java.lang.String origin,
                             okio.ByteString protocol,
                             java.lang.String host,
                             int port,
                             long maxAge)

Description copied from interface: Http2Reader.Handler

HTTP/2 only. Expresses that resources for the connection or a client- initiated stream are available from a different network location or protocol configuration.

See alt-svc

Specified by:

alternateService in interface Http2Reader.Handler

Parameters:

streamId - when a client-initiated stream ID (odd number), the origin of this alternate service is the origin of the stream. When zero, the origin is specified in the origin parameter.

origin - when present, the origin is typically represented as a combination of scheme, host and port. When empty, the origin is that of the streamId.

protocol - an ALPN protocol, such as h2.

host - an IP address or hostname.

port - the IP port associated with the service.

maxAge - time in seconds that this alternative is considered fresh.