aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_ws.7.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-01-06 15:20:09 -0800
committerGarrett D'Amore <garrett@damore.org>2025-01-09 23:22:56 -0800
commit73f50e2679525e7df8734c875a3c12732565f953 (patch)
tree23bd167dfcd95305b58a29c142b51879011f63b2 /docs/man/nng_ws.7.adoc
parenta381af4f5ca79576a4a9b461529a0f22fcf1e088 (diff)
downloadnng-http-client-trans.tar.gz
nng-http-client-trans.tar.bz2
nng-http-client-trans.zip
http: The big HTTP API refactoring of January 2025.v2.0.0-alpha.3http-client-trans
This represents a major change in the HTTP code base, consisting of a complete revamp of the HTTP API. The changes here are too numerous to mention, but the end result should be a vastly simpler API for both server and client applications. Many needless allocations were removed by providing fixed buffers for various parameters and headers when possible. A few bugs were fixed. Most especially we have fixed some bugs around very large URIs and headers, and we have also addressed conformance bugs to more closely conform to RFCs 9110 and 9112. As part of this work, the APIs for WebSockets changed slightly as well. In particular the properties available for accessing headers have changed. There is still documentation conversion work to do, and additional functionality (such as proper support for chunked transfers), but this is a big step in the right direction.
Diffstat (limited to 'docs/man/nng_ws.7.adoc')
-rw-r--r--docs/man/nng_ws.7.adoc15
1 files changed, 4 insertions, 11 deletions
diff --git a/docs/man/nng_ws.7.adoc b/docs/man/nng_ws.7.adoc
index 938b16a9..49783920 100644
--- a/docs/man/nng_ws.7.adoc
+++ b/docs/man/nng_ws.7.adoc
@@ -107,19 +107,12 @@ setting these must be done before the transport is started.
NOTE: The TLS specific options (beginning with `NNG_OPT_TLS_`) are
only available for `wss://` endpoints.
-((`NNG_OPT_WS_REQUEST_HEADERS`))::
+((`NNG_OPT_WS_HEADER`))::
-(string) Concatenation of multiple lines terminated
-by CRLF sequences, that can be used to add further headers to the
-HTTP request sent when connecting.
-This option can be set on dialers, and retrieved from pipes.
+The actual option is a prefix string, beginning with the the contents of the
+macro `NNG_OPT_WS_HEADER`, followed by the name of header field.
-((`NNG_OPT_WS_RESPONSE_HEADERS`))::
-
-(string) Concatenation of multiple lines terminated
-by CRLF sequences, that can be used to add further headers to the
-HTTP response sent when connecting.
-This option can be set on listeners, and retrieved from pipes.
+Such options can be set on dialers and listener, and retrieved from pipes.
((`NNG_OPT_WS_RECV_TEXT`))::