aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-12-22 12:57:19 -0800
committerGarrett D'Amore <garrett@damore.org>2024-12-22 13:03:35 -0800
commita24b4f11799806e08638162901039fd23efe48be (patch)
tree24f29c8eeb234c1228615478555c3c4d2fcdb761 /docs
parentd60a16af349de45477efc566760130b51ff7cf1e (diff)
downloadnng-a24b4f11799806e08638162901039fd23efe48be.tar.gz
nng-a24b4f11799806e08638162901039fd23efe48be.tar.bz2
nng-a24b4f11799806e08638162901039fd23efe48be.zip
http: limit handler uri to 1K
This is just the part of the tree that will be matched when looking up a handler. Requests may come in with very much longer URIs, and be matched to the handler as a "subdirectory". This approach makes it possible to avoid a dynamic allocation on the handler, at the cost of pre-allocating 1KB with the handler object. This size can be overridden using a NNG_HTTP_MAX_URI at compile time.
Diffstat (limited to 'docs')
-rw-r--r--docs/man/nng_http_handler_alloc.3http.adoc6
-rw-r--r--docs/ref/migrate/nng1.md3
2 files changed, 8 insertions, 1 deletions
diff --git a/docs/man/nng_http_handler_alloc.3http.adoc b/docs/man/nng_http_handler_alloc.3http.adoc
index c7d4699f..7795bbf5 100644
--- a/docs/man/nng_http_handler_alloc.3http.adoc
+++ b/docs/man/nng_http_handler_alloc.3http.adoc
@@ -51,6 +51,12 @@ by the _path_ argument.
Only the path component of the Request URI is
considered when determining whether the handler should be called.
+This implementation limits the _path_ length to 1024 bytes, including the
+zero termination byte. This does not prevent requests with much longer
+URIs from being supported, doing so will require setting the handler
+to matching a parent path in the tree using
+xref:nng_http_handler_set_tree.3http.adoc[`nng_http_handler_set_tree`()].
+
Additionally each handler has a method it is registered to handle
(the default is `GET`, see
xref:nng_http_handler_set_method.3http.adoc[`nng_http_handler_set_method()`]), and
diff --git a/docs/ref/migrate/nng1.md b/docs/ref/migrate/nng1.md
index 4390de24..0d6ae86d 100644
--- a/docs/ref/migrate/nng1.md
+++ b/docs/ref/migrate/nng1.md
@@ -227,7 +227,8 @@ they may be silently truncated to the limit:
- Hostnames are limited per RFC 1035 to 253 characters (not including terminating "." or zero byte.)
- HTTP Method names are limited to 32 bytes (the longest IANA registered method is currently 18 bytes, used for WebDAV.)
-- The fixed part of URI pathnames used with HTTP handlers is limited to 1024 bytes.
+- The fixed part of URI pathnames used with HTTP handlers is limited to 1024 bytes. (Longer URIs may be accepted
+ by using [`nng_http_handler_set_tree`] and matching a parent of the directory component.)
The following API calls have changed so that they are `void` returns, and cannot fail.
They may silently truncate data.