com.firefly.codec.http2.stream

类 HTTP2Session

java.lang.Object

com.firefly.codec.http2.stream.HTTP2Session

所有已实现的接口:

Parser.Listener, Session, SessionSPI

直接已知子类:

HTTP2ClientSession, HTTP2ServerSession

public abstract class HTTP2Session
extends Object
implements SessionSPI, Parser.Listener

嵌套类概要

从接口继承的嵌套类/接口 com.firefly.codec.http2.stream.Session

Session.Listener

从接口继承的嵌套类/接口 com.firefly.codec.http2.decode.Parser.Listener

Parser.Listener.Adapter

构造器概要

构造器

构造器和说明
HTTP2Session(Scheduler scheduler, Session endPoint, Generator generator, Session.Listener listener, FlowControlStrategy flowControl, int initialStreamId, int streamIdleTimeout)

方法概要

限定符和类型	方法和说明
protected void	abort(Throwable failure)
boolean	close(int error, String reason, Callback callback) Invoked internally and by applications to send a GO_AWAY frame to the other peer.
protected StreamSPI	createLocalStream(int streamId, Promise<Stream> promise)
protected StreamSPI	createRemoteStream(int streamId)
void	data(StreamSPI stream, Callback callback, DataFrame frame) Enqueues the given DATA frame to be written to the connection.
void	disconnect()
void	frames(StreamSPI stream, Callback callback, Frame frame, Frame... frames) Enqueues the given frames to be written to the connection.
Session	getEndPoint()
FlowControlStrategy	getFlowControlStrategy()
Generator	getGenerator()
int	getInitialSessionRecvWindow()
int	getMaxLocalStreams()
int	getMaxRemoteStreams()
int	getRecvWindow()
int	getSendWindow()
StreamSPI	getStream(int streamId) Retrieves the stream with the given streamId.
int	getStreamCount()
long	getStreamIdleTimeout()
Collection<Stream>	getStreams()
boolean	isClosed()
boolean	isDisconnected()
boolean	isPushEnabled()
void	newStream(HeadersFrame frame, Promise<Stream> promise, Stream.Listener listener) Sends the given HEADERS frame to create a new Stream.
protected StreamSPI	newStream(int streamId, boolean local)
protected void	notifyClose(Session session, GoAwayFrame frame)
protected void	notifyFailure(Session session, Throwable failure)
protected boolean	notifyIdleTimeout(Session session)
protected Stream.Listener	notifyNewStream(Stream stream, HeadersFrame frame)
protected void	notifyPing(Session session, PingFrame frame)
protected void	notifyReset(Session session, ResetFrame frame)
protected void	notifySettings(Session session, SettingsFrame frame)
void	onConnectionFailure(int error, String reason)
void	onData(DataFrame frame)
void	onFrame(Frame frame) Callback method invoked during an HTTP/1.1 to HTTP/2 upgrade requests to process the given synthetic frame.
void	onGoAway(GoAwayFrame frame) This method is called when receiving a GO_AWAY from the other peer.
abstract void	onHeaders(HeadersFrame frame)
boolean	onIdleTimeout() This method is invoked when the idle timeout triggers.
void	onPing(PingFrame frame)
void	onPriority(PriorityFrame frame)
void	onReset(ResetFrame frame)
void	onSettings(SettingsFrame frame)
void	onSettings(SettingsFrame frame, boolean reply)
void	onShutdown() A typical close by a remote peer involves a GO_AWAY frame followed by TCP FIN.
void	onWindowUpdate(StreamSPI stream, WindowUpdateFrame frame) Callback method invoked when a WINDOW_UPDATE frame has been received.
void	onWindowUpdate(WindowUpdateFrame frame)
void	ping(PingFrame frame, Callback callback) Sends the given PING frame.
int	priority(PriorityFrame frame, Callback callback) Sends the given PRIORITY frame.
void	push(StreamSPI stream, Promise<Stream> promise, PushPromiseFrame frame, Stream.Listener listener) Enqueues the given PUSH_PROMISE frame to be written to the connection.
void	removeStream(StreamSPI stream) Removes the given stream.
protected void	reset(ResetFrame frame, Callback callback)
void	setInitialSessionRecvWindow(int initialSessionRecvWindow)
void	setMaxLocalStreams(int maxLocalStreams)
void	setMaxRemoteStreams(int maxRemoteStreams)
void	setStreamIdleTimeout(long streamIdleTimeout)
void	settings(SettingsFrame frame, Callback callback) Sends the given SETTINGS frame to configure the session.
String	toString()
int	updateRecvWindow(int delta) Updates the session receive window by the given delta.
int	updateSendWindow(int delta) Updates the session send window by the given delta.

从类继承的方法 java.lang.Object

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

从接口继承的方法 com.firefly.codec.http2.decode.Parser.Listener

onPushPromise

构造器详细资料

HTTP2Session

public HTTP2Session(Scheduler scheduler,
                    Session endPoint,
                    Generator generator,
                    Session.Listener listener,
                    FlowControlStrategy flowControl,
                    int initialStreamId,
                    int streamIdleTimeout)

方法详细资料

getFlowControlStrategy

public FlowControlStrategy getFlowControlStrategy()

getMaxLocalStreams

public int getMaxLocalStreams()

setMaxLocalStreams

public void setMaxLocalStreams(int maxLocalStreams)

getMaxRemoteStreams

public int getMaxRemoteStreams()

setMaxRemoteStreams

public void setMaxRemoteStreams(int maxRemoteStreams)

getStreamIdleTimeout

public long getStreamIdleTimeout()

setStreamIdleTimeout

public void setStreamIdleTimeout(long streamIdleTimeout)

getInitialSessionRecvWindow

public int getInitialSessionRecvWindow()

setInitialSessionRecvWindow

public void setInitialSessionRecvWindow(int initialSessionRecvWindow)

getEndPoint

public Session getEndPoint()

getGenerator

public Generator getGenerator()

onData

public void onData(DataFrame frame)

指定者:

onData 在接口中 Parser.Listener

onHeaders

public abstract void onHeaders(HeadersFrame frame)

指定者:

onHeaders 在接口中 Parser.Listener

onPriority

public void onPriority(PriorityFrame frame)

指定者:

onPriority 在接口中 Parser.Listener

onReset

public void onReset(ResetFrame frame)

指定者:

onReset 在接口中 Parser.Listener

onSettings

public void onSettings(SettingsFrame frame)

指定者:

onSettings 在接口中 Parser.Listener

onSettings

public void onSettings(SettingsFrame frame,
                       boolean reply)

onPing

public void onPing(PingFrame frame)

指定者:

onPing 在接口中 Parser.Listener

onGoAway

public void onGoAway(GoAwayFrame frame)

This method is called when receiving a GO_AWAY from the other peer. We check the close state to act appropriately: * NOT_CLOSED: we move to REMOTELY_CLOSED and queue a disconnect, so that the content of the queue is written, and then the connection closed. We notify the application after being terminated. See HTTP2Session.ControlEntry#succeeded() * In all other cases, we do nothing since other methods are already performing their actions.

指定者:

onGoAway 在接口中 Parser.Listener

参数:

frame - the GO_AWAY frame that has been received.

另请参阅:

close(int, String, Callback), onShutdown(), onIdleTimeout()

onWindowUpdate

public void onWindowUpdate(WindowUpdateFrame frame)

指定者:

onWindowUpdate 在接口中 Parser.Listener

onConnectionFailure

public void onConnectionFailure(int error,
                                String reason)

指定者:

onConnectionFailure 在接口中 Parser.Listener

newStream

public void newStream(HeadersFrame frame,
                      Promise<Stream> promise,
                      Stream.Listener listener)

从接口复制的说明: Session

Sends the given HEADERS frame to create a new Stream.

指定者:

newStream 在接口中 Session

参数:

frame - the HEADERS frame containing the HTTP headers

promise - the promise that gets notified of the stream creation

listener - the listener that gets notified of stream events

priority

public int priority(PriorityFrame frame,
                    Callback callback)

从接口复制的说明: Session

Sends the given PRIORITY frame.

If the frame references a streamId that does not exist (for example 0), then a new streamId will be allocated, to support unused anchor streams that act as parent for other streams.

指定者:

priority 在接口中 Session

参数:

frame - the PRIORITY frame to send

callback - the callback that gets notified when the frame has been sent

返回:

the new stream id generated by the PRIORITY frame, or the stream id that it is already referencing

push

public void push(StreamSPI stream,
                 Promise<Stream> promise,
                 PushPromiseFrame frame,
                 Stream.Listener listener)

从接口复制的说明: SessionSPI

Enqueues the given PUSH_PROMISE frame to be written to the connection.

Differently from SessionSPI.frames(StreamSPI, Callback, Frame, Frame...), this method generates atomically the stream id for the pushed stream.

指定者:

push 在接口中 SessionSPI

参数:

stream - the stream associated to the pushed stream

promise - the promise that gets notified of the pushed stream creation

frame - the PUSH_PROMISE frame to enqueue

listener - the listener that gets notified of pushed stream events

settings

public void settings(SettingsFrame frame,
                     Callback callback)

从接口复制的说明: Session

Sends the given SETTINGS frame to configure the session.

指定者:

settings 在接口中 Session

参数:

frame - the SETTINGS frame to send

callback - the callback that gets notified when the frame has been sent

ping

public void ping(PingFrame frame,
                 Callback callback)

从接口复制的说明: Session

Sends the given PING frame.

PING frames may be used to test the connection integrity and to measure round-trip time.

指定者:

ping 在接口中 Session

参数:

frame - the PING frame to send

callback - the callback that gets notified when the frame has been sent

reset

protected void reset(ResetFrame frame,
                     Callback callback)

close

public boolean close(int error,
                     String reason,
                     Callback callback)

Invoked internally and by applications to send a GO_AWAY frame to the other peer. We check the close state to act appropriately: * NOT_CLOSED: we move to LOCALLY_CLOSED and queue a GO_AWAY. When the GO_AWAY has been written, it will only cause the output to be shut down (not the connection closed), so that the application can still read frames arriving from the other peer. Ideally the other peer will notice the GO_AWAY and close the connection. When that happen, we close the connection from onShutdown(). Otherwise, the idle timeout mechanism will close the connection, see onIdleTimeout(). * In all other cases, we do nothing since other methods are already performing their actions.

指定者:

close 在接口中 Session

参数:

error - the error code

reason - the reason

callback - the callback to invoke when the operation is complete

返回:

true if the frame is being sent, false if the session was already closed

另请参阅:

onGoAway(GoAwayFrame), onShutdown(), onIdleTimeout()

isClosed

public boolean isClosed()

指定者:

isClosed 在接口中 Session

返回:

whether the session is not open

frames

public void frames(StreamSPI stream,
                   Callback callback,
                   Frame frame,
                   Frame... frames)

从接口复制的说明: SessionSPI

Enqueues the given frames to be written to the connection.

指定者:

frames 在接口中 SessionSPI

参数:

stream - the stream the frames belong to

callback - the callback that gets notified when the frames have been sent

frame - the first frame to enqueue

frames - additional frames to enqueue

data

public void data(StreamSPI stream,
                 Callback callback,
                 DataFrame frame)

从接口复制的说明: SessionSPI

Enqueues the given DATA frame to be written to the connection.

指定者:

data 在接口中 SessionSPI

参数:

stream - the stream the data frame belongs to

callback - the callback that gets notified when the frame has been sent

frame - the DATA frame to send

createLocalStream

protected StreamSPI createLocalStream(int streamId,
                                      Promise<Stream> promise)

createRemoteStream

protected StreamSPI createRemoteStream(int streamId)

newStream

protected StreamSPI newStream(int streamId,
                              boolean local)

removeStream

public void removeStream(StreamSPI stream)

从接口复制的说明: SessionSPI

Removes the given stream.

指定者:

removeStream 在接口中 SessionSPI

参数:

stream - the stream to remove

getStreams

public Collection<Stream> getStreams()

指定者:

getStreams 在接口中 Session

返回:

a snapshot of all the streams currently belonging to this session

getStreamCount

public int getStreamCount()

getStream

public StreamSPI getStream(int streamId)

从接口复制的说明: Session

Retrieves the stream with the given streamId.

指定者:

getStream 在接口中 Session

指定者:

getStream 在接口中 SessionSPI

参数:

streamId - the stream id of the stream looked for

返回:

the stream with the given id, or null if no such stream exist

getSendWindow

public int getSendWindow()

getRecvWindow

public int getRecvWindow()

updateSendWindow

public int updateSendWindow(int delta)

从接口复制的说明: SessionSPI

Updates the session send window by the given delta.

指定者:

updateSendWindow 在接口中 SessionSPI

参数:

delta - the delta value (positive or negative) to add to the session send window

返回:

the previous value of the session send window

updateRecvWindow

public int updateRecvWindow(int delta)

从接口复制的说明: SessionSPI

Updates the session receive window by the given delta.

指定者:

updateRecvWindow 在接口中 SessionSPI

参数:

delta - the delta value (positive or negative) to add to the session receive window

返回:

the previous value of the session receive window

onWindowUpdate

public void onWindowUpdate(StreamSPI stream,
                           WindowUpdateFrame frame)

从接口复制的说明: SessionSPI

Callback method invoked when a WINDOW_UPDATE frame has been received.

指定者:

onWindowUpdate 在接口中 SessionSPI

参数:

stream - the stream the window update belongs to, or null if the window update belongs to the session

frame - the WINDOW_UPDATE frame received

isPushEnabled

public boolean isPushEnabled()

指定者:

isPushEnabled 在接口中 SessionSPI

返回:

whether the push functionality is enabled

onShutdown

public void onShutdown()

A typical close by a remote peer involves a GO_AWAY frame followed by TCP FIN. This method is invoked when the TCP FIN is received, or when an exception is thrown while reading, and we check the close state to act appropriately: * NOT_CLOSED: means that the remote peer did not send a GO_AWAY (abrupt close) or there was an exception while reading, and therefore we terminate. * LOCALLY_CLOSED: we have sent the GO_AWAY to the remote peer, which received it and closed the connection; we queue a disconnect to close the connection on the local side. The GO_AWAY just shutdown the output, so we need this step to make sure the connection is closed. See close(int, String, Callback). * REMOTELY_CLOSED: we received the GO_AWAY, and the TCP FIN afterwards, so we do nothing since the handling of the GO_AWAY will take care of closing the connection. See onGoAway(GoAwayFrame).

指定者:

onShutdown 在接口中 SessionSPI

另请参阅:

onGoAway(GoAwayFrame), close(int, String, Callback), onIdleTimeout()

onIdleTimeout

public boolean onIdleTimeout()

This method is invoked when the idle timeout triggers. We check the close state to act appropriately: * NOT_CLOSED: it's a real idle timeout, we just initiate a close, see close(int, String, Callback). * LOCALLY_CLOSED: we have sent a GO_AWAY and only shutdown the output, but the other peer did not close the connection so we never received the TCP FIN, and therefore we terminate. * REMOTELY_CLOSED: the other peer sent us a GO_AWAY, we should have queued a disconnect, but for some reason it was not processed (for example, queue was stuck because of TCP congestion), therefore we terminate. See onGoAway(GoAwayFrame).

指定者:

onIdleTimeout 在接口中 SessionSPI

返回:

true if the session should be closed, false otherwise

另请参阅:

onGoAway(GoAwayFrame), close(int, String, Callback), onShutdown()

onFrame

public void onFrame(Frame frame)

从接口复制的说明: SessionSPI

Callback method invoked during an HTTP/1.1 to HTTP/2 upgrade requests to process the given synthetic frame.

指定者:

onFrame 在接口中 SessionSPI

参数:

frame - the synthetic frame to process

disconnect

public void disconnect()

abort

protected void abort(Throwable failure)

isDisconnected

public boolean isDisconnected()

notifyNewStream

protected Stream.Listener notifyNewStream(Stream stream,
                                          HeadersFrame frame)

notifySettings

protected void notifySettings(Session session,
                              SettingsFrame frame)

notifyPing

protected void notifyPing(Session session,
                          PingFrame frame)

notifyReset

protected void notifyReset(Session session,
                           ResetFrame frame)

notifyClose

protected void notifyClose(Session session,
                           GoAwayFrame frame)

notifyIdleTimeout

protected boolean notifyIdleTimeout(Session session)

notifyFailure

protected void notifyFailure(Session session,
                             Throwable failure)

toString

public String toString()

覆盖:

toString 在类中 Object