diff options
Diffstat (limited to 'doc/src/manual')
| -rw-r--r-- | doc/src/manual/ranch.asciidoc | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/src/manual/ranch.asciidoc b/doc/src/manual/ranch.asciidoc index 2f62b81..b5dd615 100644 --- a/doc/src/manual/ranch.asciidoc +++ b/doc/src/manual/ranch.asciidoc @@ -91,7 +91,7 @@ transport_opts(SocketOpts) = #{ alarms => #{ term() => #{ type := num_connections, - treshold := non_neg_integer(), + threshold := non_neg_integer(), callback := fun((ref(), term(), pid(), [pid()]) -> any()), cooldown => non_neg_integer() } @@ -118,7 +118,7 @@ None of the options are required. alarms (#{}):: Alarms to call a function when the number of connections tracked -by one connection supervisor reaches or exceeds a defined treshold. +by one connection supervisor reaches or exceeds a defined threshold. + The map keys are the alarm names, which can be any `term`. The associated values are the respective alarm options, again in a map @@ -128,9 +128,9 @@ type::: Must be set to `num_connections`. -treshold::: +threshold::: -Treshold value, which must be a `non_neg_integer`. When the +Threshold value, which must be a `non_neg_integer`. When the number of connections tracked by a single connection supervisor reaches or exceeds this value, The alarm will trigger and call the function defined in the `callback` key (see below). |