com.firefly.codec.http2.stream

接口 SessionSPI

所有超级接口:

Session

所有已知实现类:

HTTP2ClientSession, HTTP2ServerSession, HTTP2Session

public interface SessionSPI
extends Session

The SPI interface for implementing a HTTP/2 session.

This class extends Session by adding the methods required to implement the HTTP/2 session functionalities.

嵌套类概要

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

Session.Listener

方法概要

限定符和类型	方法和说明
void	data(StreamSPI stream, Callback callback, DataFrame frame) Enqueues the given DATA frame to be written to the connection.
void	frames(StreamSPI stream, Callback callback, Frame frame, Frame... frames) Enqueues the given frames to be written to the connection.
long	getBytesWritten()
StreamSPI	getStream(int streamId) Retrieves the stream with the given streamId.
boolean	isPushEnabled()
void	onFrame(Frame frame) Callback method invoked during an HTTP/1.1 to HTTP/2 upgrade requests to process the given synthetic frame.
boolean	onIdleTimeout() Callback invoked when the idle timeout expires.
void	onShutdown() Callback invoked when the connection reads -1.
void	onWindowUpdate(StreamSPI stream, WindowUpdateFrame frame) Callback method invoked when a WINDOW_UPDATE frame has been received.
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.
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.

从接口继承的方法 com.firefly.codec.http2.stream.Session

close, getStreams, isClosed, newStream, ping, priority, settings

方法详细资料

getStream

StreamSPI getStream(int streamId)

从接口复制的说明: Session

Retrieves the stream with the given streamId.

指定者:

getStream 在接口中 Session

参数:

streamId - the stream id of the stream looked for

返回:

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

removeStream

void removeStream(StreamSPI stream)

Removes the given stream.

参数:

stream - the stream to remove

frames

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

Enqueues the given frames to be written to the connection.

参数:

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

push

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

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

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

参数:

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

data

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

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

参数:

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

updateSendWindow

int updateSendWindow(int delta)

Updates the session send window by the given delta.

参数:

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

返回:

the previous value of the session send window

updateRecvWindow

int updateRecvWindow(int delta)

Updates the session receive window by the given delta.

参数:

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

返回:

the previous value of the session receive window

onWindowUpdate

void onWindowUpdate(StreamSPI stream,
                    WindowUpdateFrame frame)

Callback method invoked when a WINDOW_UPDATE frame has been received.

参数:

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

boolean isPushEnabled()

返回:

whether the push functionality is enabled

onShutdown

void onShutdown()

Callback invoked when the connection reads -1.

另请参阅:

onIdleTimeout(), Session.close(int, String, Callback)

onIdleTimeout

boolean onIdleTimeout()

Callback invoked when the idle timeout expires.

另请参阅:

onShutdown(), Session.close(int, String, Callback)

onFrame

void onFrame(Frame frame)

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

参数:

frame - the synthetic frame to process

getBytesWritten

long getBytesWritten()

返回:

the number of bytes written by this session