aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_ws.7.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-10-08 08:36:47 -0700
committerGarrett D'Amore <garrett@damore.org>2025-10-08 14:15:18 -0700
commitaf596b6ccf14b4d2fc2f5c6ef04870186d99d828 (patch)
tree5009ab730e644e2b858fe6c8758df30f4a7718c6 /docs/man/nng_ws.7.adoc
parent57ce9f1035a7d265d0f8b0d907dc893d4fcbcaeb (diff)
downloadnng-af596b6ccf14b4d2fc2f5c6ef04870186d99d828.tar.gz
nng-af596b6ccf14b4d2fc2f5c6ef04870186d99d828.tar.bz2
nng-af596b6ccf14b4d2fc2f5c6ef04870186d99d828.zip
docs: Document new HTTP header iteration options.
Diffstat (limited to 'docs/man/nng_ws.7.adoc')
-rw-r--r--docs/man/nng_ws.7.adoc24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/man/nng_ws.7.adoc b/docs/man/nng_ws.7.adoc
index f7034987..bdd6989a 100644
--- a/docs/man/nng_ws.7.adoc
+++ b/docs/man/nng_ws.7.adoc
@@ -114,6 +114,30 @@ macro `NNG_OPT_WS_HEADER`, followed by the name of header field.
Such options can be set on dialers and listener, and retrieved from pipes.
+((`NNG_OPT_WS_HEADER_NEXT`))::
+
+(bool) Reading this option advances the header iteration so that the values
+supplied by by `NNG_OPT_WS_HEADER_KEY` and `NNG_OPT_WS_HEADER_VALUE` represnt the
+next HTTP header. This option is `true` if advancing succeeded, `false`
+if there are no more headers. This option is only valid on connected streams or pipes.
+
+((`NNG_OPT_WS_HEADER_RESET`)):
+
+(bool) Reset the HTTP header iteration so the next call to `NNG_OPT_WS_HEADER_NEXT`
+will start at the first HTTP header.
+
+((`NNG_OPT_WS_HEADER_KEY`)):
+
+(string) This option provides the HTTP header key or name for the currently
+selected HTTP header. It is invalid to read this until `NNG_OPT_WS_HEADER_NEXT` has
+been read with a `true` result.
+
+((`NNG_OPT_WS_HEADER_VALUE`)):
+
+(string) This option provides the HTTP header value of the currently selected
+HTTP header. It is invalid to read this until `NNG_OPT_WS_HEADER_NEXT` has
+been read with a `true` result.
+
((`NNG_OPT_WS_RECV_TEXT`))::
(bool) Enable receiving of TEXT frames at the WebSocket layer.