cowboy_http2(3)

NAME

cowboy_http2 - HTTP/2

DESCRIPTION

The module cowboy_http2 implements HTTP/2 as a Ranch protocol.

OPTIONS
    opts() :: #{
        active_n                       => pos_integer(),
        alpn_default_protocol          => http | http2,
        connection_type                => worker | supervisor,
        connection_window_margin_size  => 0..16#7fffffff,
        connection_window_update_threshold => 0..16#7fffffff,
        dynamic_buffer                 => false | {pos_integer(), pos_integer()},
        enable_connect_protocol        => boolean(),
        goaway_initial_timeout         => timeout(),
        goaway_complete_timeout        => timeout(),
        hibernate                      => boolean(),
        idle_timeout                   => timeout(),
        inactivity_timeout             => timeout(),
        initial_connection_window_size => 65535..16#7fffffff,
        initial_stream_window_size     => 0..16#7fffffff,
        linger_timeout                 => timeout(),
        logger                         => module(),
        max_cancel_stream_rate         => {pos_integer(), timeout()},
        max_concurrent_streams         => non_neg_integer() | infinity,
        max_connection_buffer_size     => non_neg_integer(),
        max_connection_window_size     => 0..16#7fffffff,
        max_decode_table_size          => non_neg_integer(),
        max_encode_table_size          => non_neg_integer(),
        max_fragmented_header_block_size => 16384..16#7fffffff,
        max_frame_size_received        => 16384..16777215,
        max_frame_size_sent            => 16384..16777215 | infinity,
        max_headers                    => non_neg_integer(),
        max_received_frame_rate        => {pos_integer(), timeout()},
        max_reset_stream_rate          => {pos_integer(), timeout()},
        max_stream_buffer_size         => non_neg_integer(),
        max_stream_window_size         => 0..16#7fffffff,
        preface_timeout                => timeout(),
        protocols                      => [http | http2],
        proxy_header                   => boolean(),
        reset_idle_timeout_on_send     => boolean(),
        sendfile                       => boolean(),
        settings_timeout               => timeout(),
        stream_handlers                => [module()],
        stream_window_data_threshold   => 0..16#7fffffff,
        stream_window_margin_size      => 0..16#7fffffff,
        stream_window_update_threshold => 0..16#7fffffff
    }

Configuration for the HTTP/2 protocol.

This configuration is passed to Cowboy when starting listeners using cowboy:start_clear/3 or cowboy:start_tls/3 functions.

It can be updated without restarting listeners using the Ranch functions ranch:get_protocol_options/1 and ranch:set_protocol_options/2.

The default value is given next to the option name:

active_n (1)
    The number of packets Cowboy will request from the socket at once. This can be used to tweak the performance of the server. Higher values reduce the number of times Cowboy need to request more packets from the port driver at the expense of potentially higher memory being used.

alpn_default_protocol (http)
    Default protocol to use when the client connects over TLS without ALPN. Can be set to http2 to disable HTTP/1.1 entirely.

connection_type (supervisor)
    Whether the connection process also acts as a supervisor.

connection_window_margin_size (65535)
    Extra amount in bytes to be added to the window size when updating the connection window. This is used to ensure that there is always some space available in the window.

connection_window_update_threshold (163840)
    The connection window will only get updated when its size becomes lower than this threshold, in bytes. This is to avoid sending too many WINDOW_UPDATE frames.

dynamic_buffer ({1024, 131072})
    Cowboy will dynamically change the socket's buffer size depending on the size of the data it receives from the socket. This lets Cowboy use the optimal buffer size for the current workload.

    The dynamic buffer size functionality can be disabled by setting this option to false. Cowboy will also disable it by default when the buffer transport option is configured.

enable_connect_protocol (false)
    Whether to enable the extended CONNECT method to allow protocols like Websocket to be used over an HTTP/2 stream.

    For backward compatibility reasons, this option is disabled by default. It must be enabled to use Websocket over HTTP/2. It will be enabled by default in a future release.

goaway_initial_timeout (1000)
    Time in ms to wait for any in-flight stream creations before stopping to accept new streams on an existing connection during a graceful shutdown.

goaway_complete_timeout (3000)
    Time in ms to wait for ongoing streams to complete before closing the connection during a graceful shutdown.

hibernate (false)
    Whether the connection process will hibernate automatically.

idle_timeout (60000)
    Time in ms with no data received before Cowboy closes the connection.

inactivity_timeout (300000)
    DEPRECATED** Time in ms with nothing received at all before Cowboy closes the connection.

initial_connection_window_size (65535)
    Initial window size in bytes for the connection. This is the total amount of data (from request bodies for example) that may be buffered by the connection across all streams before the user code explicitly requests it.

    Note that this value cannot be lower than the default.

initial_stream_window_size (65535)
    Initial window size in bytes for new streams. This is the total amount of data (from request bodies for example) that may be buffered by a single stream before the user code explicitly requests it.

linger_timeout (1000)
    Time in ms that Cowboy will wait when closing the connection. This is necessary to avoid the TCP reset problem as described in the section 6.6 of RFC7230 (https://tools.ietf.org/html/rfc7230#section-6.6). In HTTP/2's case the GOAWAY message might also be lost when closing the connection immediately.

logger (error_logger)
    The module that will be used to write log messages.

max_cancel_stream_rate ({500, 10000})
    Maximum cancel stream rate per connection. This can be used to protect against misbehaving or malicious peers, by limiting the number of streams that the peer can reset over a certain time period. The rate is expressed as a tuple {NumCancels, TimeMs}. This is similar to a supervisor restart intensity/period.

max_concurrent_streams (infinity)
    Maximum number of concurrent streams allowed on the connection.

max_connection_buffer_size (16000000)
    Maximum size of all stream buffers for this connection, in bytes. This is a soft limit used to apply backpressure to handlers that send data faster than the HTTP/2 connection allows.

max_connection_window_size (16#7fffffff)
    Maximum connection window size in bytes. This is used as an upper bound when calculating the window size, either when reading the request body or receiving said body.

max_decode_table_size (4096)
    Maximum header table size in bytes used by the decoder. This is the value advertised to the client. The client can then choose a header table size equal or lower to the advertised value.

max_encode_table_size (4096)
    Maximum header table size in bytes used by the encoder. The server will compare this value to what the client advertises and choose the smallest one as the encoder's header table size.

max_fragmented_header_block_size (32768)
    Maximum header block size when headers are split over multiple HEADERS and CONTINUATION frames. Clients that attempt to send header blocks larger than this value will receive an ENHANCE_YOUR_CALM connection error. Note that this value is not advertised and should be large enough for legitimate requests.

max_frame_size_received (16384)
    Maximum size in bytes of the frames received by the server. This value is advertised to the remote endpoint which can then decide to use any value lower or equal for its frame sizes.

    It is highly recommended to increase this value for performance reasons. In a future Cowboy version the default will be increased to 1MB (1048576). Too low values may result in very large file uploads failing because Cowboy will detect the large number of frames as flood and close the connection.

max_frame_size_sent (infinity)
    Maximum size in bytes of the frames sent by the server. This option allows setting an upper limit to the frame sizes instead of blindly following the client's advertised maximum.

    Note that actual frame sizes may be lower than the limit when there is not enough space left in the flow control window.

max_headers (100)
    Maximum number of header fields allowed per request field blocks. This option is applied independently to header and trailer field blocks.

max_received_frame_rate ({10000, 10000})
    Maximum frame rate allowed per connection. The rate is expressed as a tuple {NumFrames, TimeMs} indicating how many frames are allowed over the given time period. This is similar to a supervisor restart intensity/period.

max_reset_stream_rate ({10, 10000})
    Maximum reset stream rate per connection. This can be used to protect against misbehaving or malicious peers that do not follow the protocol, leading to the server resetting streams, by limiting the number of streams that can be reset over a certain time period. The rate is expressed as a tuple {NumResets, TimeMs}. This is similar to a supervisor restart intensity/period.

max_stream_buffer_size (8000000)
    Maximum stream buffer size in bytes. This is a soft limit used to apply backpressure to handlers that send data faster than the HTTP/2 connection allows.

max_stream_window_size (16#7fffffff)
    Maximum stream window size in bytes. This is used as an upper bound when calculating the window size, either when reading the request body or receiving said body.

preface_timeout (5000)
    Time in ms Cowboy is willing to wait for the connection preface.

protocols ([http2, http])
    Protocols that may be used when the client connects over cleartext TCP. The default is to allow both HTTP/1.1 and HTTP/2. HTTP/1.1 and HTTP/2 can be disabled entirely by omitting them from the list.

proxy_header (false)
    Whether incoming connections have a PROXY protocol header. The proxy information will be passed forward via the proxy_header key of the Req object.

reset_idle_timeout_on_send (false)
    Whether the idle_timeout gets reset when sending data to the socket.

sendfile (true)
    Whether the sendfile syscall may be used. It can be useful to disable it on systems where the syscall has a buggy implementation, for example under VirtualBox when using shared folders.

settings_timeout (5000)
    Time in ms Cowboy is willing to wait for a SETTINGS ack.

stream_handlers ([cowboy_stream_h])
    Ordered list of stream handlers that will handle all stream events.

stream_window_data_threshold (16384)
    Window threshold in bytes below which Cowboy will not attempt to send data, with one exception. When Cowboy has data to send and the window is high enough, Cowboy will always send the data, regardless of this option.

stream_window_margin_size (65535)
    Extra amount in bytes to be added to the window size when updating a stream's window. This is used to ensure that there is always some space available in the window.

stream_window_update_threshold (163840)
    A stream's window will only get updated when its size becomes lower than this threshold, in bytes. This is to avoid sending too many WINDOW_UPDATE frames.

CHANGELOG
    • 2.16: The max_headers option was added.
    • 2.13: The inactivity_timeout option was deprecated.
    • 2.13: The active_n default value was changed to 1.
    • 2.13: The dynamic_buffer and hibernate options were added.
    • 2.11: Websocket over HTTP/2 is now considered stable.
    • 2.11: The reset_idle_timeout_on_send option was added.
    • 2.11: Add the option max_cancel_stream_rate to protect against another flood scenario.
    • 2.9: The goaway_initial_timeout and goaway_complete_timeout options were added.
    • 2.8: The active_n option was added.
    • 2.8: The linger_timeout option was added.
    • 2.8: The max_received_frame_rate default value has been multiplied by 10 as the default was too low.
    • 2.7: Add the options connection_window_margin_size, connection_window_update_threshold, max_connection_window_size, max_stream_window_size, stream_window_margin_size and stream_window_update_threshold to configure behavior on sending WINDOW_UPDATE frames; max_connection_buffer_size and max_stream_buffer_size to apply backpressure when sending data too fast; max_received_frame_rate and max_reset_stream_rate to protect against various flood scenarios; and stream_window_data_threshold to control how small the DATA frames that Cowboy sends can get.
    • 2.7: The logger option was added.
    • 2.6: The proxy_header and sendfile options were added.
    • 2.4: Add the options initial_connection_window_size, initial_stream_window_size, max_concurrent_streams, max_decode_table_size, max_encode_table_size, max_frame_size_received, max_frame_size_sent and settings_timeout to configure HTTP/2 SETTINGS and related behavior.
    • 2.4: Add the option enable_connect_protocol.
    • 2.0: Protocol introduced.

SEE ALSO

cowboy(7), cowboy_http(3), cowboy_websocket(3)