DefaultHttp2LocalFlowController (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.handler.codec.http2.DefaultHttp2LocalFlowController

所有已实现的接口:

Http2FlowController, Http2LocalFlowController
```
@UnstableApi
public class DefaultHttp2LocalFlowController
extends java.lang.Object
implements Http2LocalFlowController
```
Basic implementation of Http2LocalFlowController.
This class is NOT thread safe. The assumption is all methods must be invoked from a single thread. Typically this thread is the event loop thread for the ChannelHandlerContext managed by this class.

字段概要

字段
限定符和类型	字段和说明
`static float`	`DEFAULT_WINDOW_UPDATE_RATIO` The default ratio of window size to initial window size below which a `WINDOW_UPDATE` is sent to expand the window.

构造器概要

构造器
构造器和说明
`DefaultHttp2LocalFlowController(Http2Connection connection)`
`DefaultHttp2LocalFlowController(Http2Connection connection, float windowUpdateRatio, boolean autoRefillConnectionWindow)` Constructs a controller with the given settings.

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`void`	`channelHandlerContext(ChannelHandlerContext ctx)` Set the `ChannelHandlerContext` for which to apply flow control on.
`boolean`	`consumeBytes(Http2Stream stream, int numBytes)` Indicates that the application has consumed a number of bytes for the given stream and is therefore ready to receive more data from the remote endpoint.
`DefaultHttp2LocalFlowController`	`frameWriter(Http2FrameWriter frameWriter)` Sets the writer to be use for sending `WINDOW_UPDATE` frames.
`void`	`incrementWindowSize(Http2Stream stream, int delta)` Increments the size of the stream's flow control window by the given delta.
`int`	`initialWindowSize()` Gets the connection-wide initial flow control window size that is used as the basis for new stream flow control windows.
`int`	`initialWindowSize(Http2Stream stream)` Get the initial flow control window size for the given stream.
`void`	`initialWindowSize(int newWindowSize)` Sets the connection-wide initial flow control window and updates all stream windows (but not the connection stream window) by the delta.
`void`	`receiveFlowControlledFrame(Http2Stream stream, ByteBuf data, int padding, boolean endOfStream)` Receives an inbound `DATA` frame from the remote endpoint and applies flow control policies to it for both the `stream` as well as the connection.
`int`	`unconsumedBytes(Http2Stream stream)` The number of bytes for the given stream that have been received but not yet consumed by the application.
`int`	`windowSize(Http2Stream stream)` Get the portion of the flow control window for the given stream that is currently available for sending/receiving frames which are subject to flow control.
`float`	`windowUpdateRatio()` The window update ratio is used to determine when a window update must be sent.
`void`	`windowUpdateRatio(float ratio)` The window update ratio is used to determine when a window update must be sent.
`float`	`windowUpdateRatio(Http2Stream stream)` The window update ratio is used to determine when a window update must be sent.
`void`	`windowUpdateRatio(Http2Stream stream, float ratio)` The window update ratio is used to determine when a window update must be sent.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DEFAULT_WINDOW_UPDATE_RATIO
```
public static final float DEFAULT_WINDOW_UPDATE_RATIO
```
    The default ratio of window size to initial window size below which a WINDOW_UPDATE is sent to expand the window.
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - DefaultHttp2LocalFlowController
```
public DefaultHttp2LocalFlowController(Http2Connection connection)
```
  - DefaultHttp2LocalFlowController
```
public DefaultHttp2LocalFlowController(Http2Connection connection,
                                       float windowUpdateRatio,
                                       boolean autoRefillConnectionWindow)
```
    Constructs a controller with the given settings.
    
    参数:
    
    connection - the connection state.
    
    windowUpdateRatio - the window percentage below which to send a WINDOW_UPDATE.
    
    autoRefillConnectionWindow - if true, effectively disables the connection window in the flow control algorithm as they will always refill automatically without requiring the application to consume the bytes. When enabled, the maximum bytes you must be prepared to queue is proportional to maximum number of concurrent streams * the initial window size per stream (SETTINGS_MAX_CONCURRENT_STREAMS SETTINGS_INITIAL_WINDOW_SIZE).
- 方法详细资料
  - frameWriter
```
public DefaultHttp2LocalFlowController frameWriter(Http2FrameWriter frameWriter)
```
    从接口复制的说明: Http2LocalFlowController
    
    Sets the writer to be use for sending WINDOW_UPDATE frames. This must be called before any flow controlled data is received.
    
    指定者:
    
    frameWriter 在接口中 Http2LocalFlowController
    
    参数:
    
    frameWriter - the HTTP/2 frame writer.
  - channelHandlerContext
```
public void channelHandlerContext(ChannelHandlerContext ctx)
```
    从接口复制的说明: Http2FlowController
    
    Set the ChannelHandlerContext for which to apply flow control on.
    This must be called to properly initialize the Http2FlowController. Not calling this is considered a programming error.
    
    指定者:
    
    channelHandlerContext 在接口中 Http2FlowController
    
    参数:
    
    ctx - The ChannelHandlerContext for which to apply flow control on.
  - initialWindowSize
```
public void initialWindowSize(int newWindowSize)
                       throws Http2Exception
```
    从接口复制的说明: Http2FlowController
    
    Sets the connection-wide initial flow control window and updates all stream windows (but not the connection stream window) by the delta.
    Represents the value for SETTINGS_INITIAL_WINDOW_SIZE. This method should only be called by Netty (not users) as a result of a receiving a SETTINGS frame.
    
    指定者:
    
    initialWindowSize 在接口中 Http2FlowController
    
    参数:
    
    newWindowSize - the new initial window size.
    
    抛出:
    
    Http2Exception - thrown if any protocol-related error occurred.
  - initialWindowSize
```
public int initialWindowSize()
```
    从接口复制的说明: Http2FlowController
    
    Gets the connection-wide initial flow control window size that is used as the basis for new stream flow control windows.
    Represents the value for SETTINGS_INITIAL_WINDOW_SIZE. The initial value returned by this method must be Http2CodecUtil.DEFAULT_WINDOW_SIZE.
    
    指定者:
    
    initialWindowSize 在接口中 Http2FlowController
  - windowSize
```
public int windowSize(Http2Stream stream)
```
    从接口复制的说明: Http2FlowController
    
    Get the portion of the flow control window for the given stream that is currently available for sending/receiving frames which are subject to flow control. This quantity is measured in number of bytes.
    
    指定者:
    
    windowSize 在接口中 Http2FlowController
  - initialWindowSize
```
public int initialWindowSize(Http2Stream stream)
```
    从接口复制的说明: Http2LocalFlowController
    
    Get the initial flow control window size for the given stream. This quantity is measured in number of bytes. Note the unavailable window portion can be calculated by Http2FlowController.initialWindowSize() - Http2FlowController.windowSize(Http2Stream).
    
    指定者:
    
    initialWindowSize 在接口中 Http2LocalFlowController
  - incrementWindowSize
```
public void incrementWindowSize(Http2Stream stream,
                                int delta)
                         throws Http2Exception
```
    从接口复制的说明: Http2FlowController
    
    Increments the size of the stream's flow control window by the given delta.
    In the case of a Http2RemoteFlowController this is called upon receipt of a WINDOW_UPDATE frame from the remote endpoint to mirror the changes to the window size.
    For a Http2LocalFlowController this can be called to request the expansion of the window size published by this endpoint. It is up to the implementation, however, as to when a WINDOW_UPDATE is actually sent.
    
    指定者:
    
    incrementWindowSize 在接口中 Http2FlowController
    
    参数:
    
    stream - The subject stream. Use Http2Connection.connectionStream() for requesting the size of the connection window.
    
    delta - the change in size of the flow control window.
    
    抛出:
    
    Http2Exception - thrown if a protocol-related error occurred.
  - consumeBytes
```
public boolean consumeBytes(Http2Stream stream,
                            int numBytes)
                     throws Http2Exception
```
    从接口复制的说明: Http2LocalFlowController
    
    Indicates that the application has consumed a number of bytes for the given stream and is therefore ready to receive more data from the remote endpoint. The application must consume any bytes that it receives or the flow control window will collapse. Consuming bytes enables the flow controller to send WINDOW_UPDATE to restore a portion of the flow control window for the stream.
    If stream is null or closed (i.e. Http2Stream.state() method returns Http2Stream.State.CLOSED), calling this method has no effect.
    
    指定者:
    
    consumeBytes 在接口中 Http2LocalFlowController
    
    参数:
    
    stream - the stream for which window space should be freed. The connection stream object must not be used. If stream is null or closed (i.e. Http2Stream.state() method returns Http2Stream.State.CLOSED), calling this method has no effect.
    
    numBytes - the number of bytes to be returned to the flow control window.
    
    返回:
    
    true if a WINDOW_UPDATE was sent, false otherwise.
    
    抛出:
    
    Http2Exception - if the number of bytes returned exceeds the Http2LocalFlowController.unconsumedBytes(Http2Stream) for the stream.
  - unconsumedBytes
```
public int unconsumedBytes(Http2Stream stream)
```
    从接口复制的说明: Http2LocalFlowController
    
    The number of bytes for the given stream that have been received but not yet consumed by the application.
    
    指定者:
    
    unconsumedBytes 在接口中 Http2LocalFlowController
    
    参数:
    
    stream - the stream for which window space should be freed.
    
    返回:
    
    the number of unconsumed bytes for the stream.
  - windowUpdateRatio
```
public void windowUpdateRatio(float ratio)
```
    The window update ratio is used to determine when a window update must be sent. If the ratio of bytes processed since the last update has meet or exceeded this ratio then a window update will be sent. This is the global window update ratio that will be used for new streams.
    
    参数:
    
    ratio - the ratio to use when checking if a WINDOW_UPDATE is determined necessary for new streams.
    
    抛出:
    
    java.lang.IllegalArgumentException - If the ratio is out of bounds (0, 1).
  - windowUpdateRatio
```
public float windowUpdateRatio()
```
    The window update ratio is used to determine when a window update must be sent. If the ratio of bytes processed since the last update has meet or exceeded this ratio then a window update will be sent. This is the global window update ratio that will be used for new streams.
  - windowUpdateRatio
```
public void windowUpdateRatio(Http2Stream stream,
                              float ratio)
                       throws Http2Exception
```
    The window update ratio is used to determine when a window update must be sent. If the ratio of bytes processed since the last update has meet or exceeded this ratio then a window update will be sent. This window update ratio will only be applied to streamId.
    Note it is the responsibly of the caller to ensure that the initial SETTINGS frame is sent before this is called. It would be considered a Http2Error.PROTOCOL_ERROR if a WINDOW_UPDATE was generated by this method before the initial SETTINGS frame is sent.
    
    参数:
    
    stream - the stream for which ratio applies to.
    
    ratio - the ratio to use when checking if a WINDOW_UPDATE is determined necessary.
    
    抛出:
    
    Http2Exception - If a protocol-error occurs while generating WINDOW_UPDATE frames
  - windowUpdateRatio
```
public float windowUpdateRatio(Http2Stream stream)
                        throws Http2Exception
```
    The window update ratio is used to determine when a window update must be sent. If the ratio of bytes processed since the last update has meet or exceeded this ratio then a window update will be sent. This window update ratio will only be applied to streamId.
    
    抛出:
    
    Http2Exception - If no stream corresponding to stream could be found.
  - receiveFlowControlledFrame
```
public void receiveFlowControlledFrame(Http2Stream stream,
                                       ByteBuf data,
                                       int padding,
                                       boolean endOfStream)
                                throws Http2Exception
```
    从接口复制的说明: Http2LocalFlowController
    
    Receives an inbound DATA frame from the remote endpoint and applies flow control policies to it for both the stream as well as the connection. If any flow control policies have been violated, an exception is raised immediately, otherwise the frame is considered to have "passed" flow control.
    If stream is null or closed, flow control should only be applied to the connection window and the bytes are immediately consumed.
    
    指定者:
    
    receiveFlowControlledFrame 在接口中 Http2LocalFlowController
    
    参数:
    
    stream - the subject stream for the received frame. The connection stream object must not be used. If stream is null or closed, flow control should only be applied to the connection window and the bytes are immediately consumed.
    
    data - payload buffer for the frame.
    
    padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
    
    endOfStream - Indicates whether this is the last frame to be sent from the remote endpoint for this stream.
    
    抛出:
    
    Http2Exception - if any flow control errors are encountered.

类 DefaultHttp2LocalFlowController

字段概要

构造器概要

方法概要

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

字段详细资料

DEFAULT_WINDOW_UPDATE_RATIO

构造器详细资料

DefaultHttp2LocalFlowController

DefaultHttp2LocalFlowController

方法详细资料

frameWriter

channelHandlerContext

initialWindowSize

initialWindowSize

windowSize

initialWindowSize

incrementWindowSize

consumeBytes

unconsumedBytes

windowUpdateRatio

windowUpdateRatio

windowUpdateRatio

windowUpdateRatio

receiveFlowControlledFrame