Mint.HTTP2.put_settings
put_settings
, go back to Mint.HTTP2 module for more information.
Specs
put_settings(t(), settings()) :: {:ok, t()} | {:error, t(), Mint.Types.error()}
Communicates the given client settings to the server.
This function is HTTP/2-specific.
This function takes a connection and a keyword list of HTTP/2 settings and sends
the values of those settings to the server. The settings won't be effective until
the server acknowledges them, which will be handled transparently by stream/2
.
This function returns {:ok, conn}
when sending the settings to the server is
successful, with conn
being the updated connection. If there's an error, this
function returns {:error, conn, reason}
with conn
being the updated connection
and reason
being the reason of the error.
Supported settings
See setting/0
for the supported settings. You can see the meaning
of these settings in the corresponding section in the HTTP/2
RFC.
See the "HTTP/2 settings" section in the module documentation for more information.
Examples
{:ok, conn} = Mint.HTTP2.put_settings(conn, max_frame_size: 100)