Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing docs for notify_settings_changed in http2_opts() #337

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add missing docs for notify_settings_changed in http2_opts() #337

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/src/manual/gun.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,7 @@ http2_opts() :: #{
flow => pos_integer(),
keepalive => timeout(),
keepalive_tolerance => non_neg_integer(),
notify_settings_changed => boolean(),

%% HTTP/2 state machine configuration.
connection_window_margin_size => 0..16#7fffffff,
Expand Down Expand Up @@ -266,6 +267,13 @@ tolerated before the connection is closed. By default
this mechanism is disabled even if `keepalive` is
enabled.

notify_settings_changed (false)::

Whether Gun should send the notification message
`{gun_notify, ConnPid, settings_changed, AllSettings}`
to the user when settings are initiated or changed
by the server.

=== opts()

[source,erlang]
Expand Down
Loading