diff options
| author | Jan Uhlig <[email protected]> | 2024-11-21 10:43:22 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2025-01-23 12:36:43 +0100 |
| commit | 38100182914ca3ec84afbdf32ca84b8b78c40973 (patch) | |
| tree | 424e2087b5df44f8080fdf1504eb00a4af51d354 /doc/src/guide | |
| parent | 2a2ff882d128bc58ac99912f86ccf8e57d47ed1f (diff) | |
| download | ranch-38100182914ca3ec84afbdf32ca84b8b78c40973.tar.gz ranch-38100182914ca3ec84afbdf32ca84b8b78c40973.tar.bz2 ranch-38100182914ca3ec84afbdf32ca84b8b78c40973.zip | |
Add optional callback ranch_transport:format_error/1
Diffstat (limited to 'doc/src/guide')
| -rw-r--r-- | doc/src/guide/transports.asciidoc | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/src/guide/transports.asciidoc b/doc/src/guide/transports.asciidoc index 73747fd..bdccfc9 100644 --- a/doc/src/guide/transports.asciidoc +++ b/doc/src/guide/transports.asciidoc @@ -175,3 +175,8 @@ implement the `{active, once}` and the `{active, true}` options. If the transport handler doesn't have a native implementation of `sendfile/5` a fallback is available, `ranch_transport:sendfile/6`. The extra first argument is the transport's module. See `ranch_ssl` for an example. + +It is highly recommended for a custom transport handler to implement the +optional `format_error/1` callback, in order to provide a human-readable +diagnostic string. Implementing this callback will become mandatory in +Ranch 3.0. |