nng_ws(7)

From 9f32089aae86bd2e94e550e3aef821271f208762 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Wed, 27 Dec 2017 18:14:53 -0800 Subject: man page updates for 0.0.0 --- man/v0.0.0/README.html | 2 +- man/v0.0.0/libnng.html | 4 +- man/v0.0.0/nng_bus.html | 2 +- man/v0.0.0/nng_close.html | 2 +- man/v0.0.0/nng_inproc.html | 2 +- man/v0.0.0/nng_ipc.html | 2 +- man/v0.0.0/nng_pair.html | 2 +- man/v0.0.0/nng_pub.html | 2 +- man/v0.0.0/nng_pull.html | 2 +- man/v0.0.0/nng_push.html | 2 +- man/v0.0.0/nng_rep.html | 2 +- man/v0.0.0/nng_req.html | 2 +- man/v0.0.0/nng_respondent.html | 2 +- man/v0.0.0/nng_strerror.html | 2 +- man/v0.0.0/nng_sub.html | 2 +- man/v0.0.0/nng_surveyor.html | 2 +- man/v0.0.0/nng_tcp.html | 2 +- man/v0.0.0/nng_tls.html | 19 +- man/v0.0.0/nng_ws.html | 730 +++++++++++++++++++++++++++++++++++++++++ man/v0.0.0/nng_zerotier.html | 2 +- 20 files changed, 759 insertions(+), 28 deletions(-) create mode 100644 man/v0.0.0/nng_ws.html (limited to 'man') diff --git a/man/v0.0.0/README.html b/man/v0.0.0/README.html index c27c9fc4..de5de36c 100644 --- a/man/v0.0.0/README.html +++ b/man/v0.0.0/README.html @@ -449,7 +449,7 @@ so there are still more options available.

diff --git a/man/v0.0.0/libnng.html b/man/v0.0.0/libnng.html index 7a005b32..46278f6a 100644 --- a/man/v0.0.0/libnng.html +++ b/man/v0.0.0/libnng.html @@ -577,7 +577,7 @@ Most applications will only interact with the body.

return the message body length

nng_msg_free(3)

nng_msg_realloc(3)

reallocate a message

diff --git a/man/v0.0.0/nng_bus.html b/man/v0.0.0/nng_bus.html index 7d43cb8e..e9ca42c5 100644 --- a/man/v0.0.0/nng_bus.html +++ b/man/v0.0.0/nng_bus.html @@ -625,7 +625,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_close.html b/man/v0.0.0/nng_close.html index 5ba141e5..b709359e 100644 --- a/man/v0.0.0/nng_close.html +++ b/man/v0.0.0/nng_close.html @@ -587,7 +587,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_inproc.html b/man/v0.0.0/nng_inproc.html index 67291738..291256f3 100644 --- a/man/v0.0.0/nng_inproc.html +++ b/man/v0.0.0/nng_inproc.html @@ -631,7 +631,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_ipc.html b/man/v0.0.0/nng_ipc.html index 63c81a0b..8441ddf4 100644 --- a/man/v0.0.0/nng_ipc.html +++ b/man/v0.0.0/nng_ipc.html @@ -647,7 +647,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_pair.html b/man/v0.0.0/nng_pair.html index e5b9f90b..1a7dae81 100644 --- a/man/v0.0.0/nng_pair.html +++ b/man/v0.0.0/nng_pair.html @@ -718,7 +718,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_pub.html b/man/v0.0.0/nng_pub.html index 02dc7d25..f1a357ba 100644 --- a/man/v0.0.0/nng_pub.html +++ b/man/v0.0.0/nng_pub.html @@ -611,7 +611,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_pull.html b/man/v0.0.0/nng_pull.html index dce09305..95bcabf2 100644 --- a/man/v0.0.0/nng_pull.html +++ b/man/v0.0.0/nng_pull.html @@ -598,7 +598,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_push.html b/man/v0.0.0/nng_push.html index d1e76678..a81ad276 100644 --- a/man/v0.0.0/nng_push.html +++ b/man/v0.0.0/nng_push.html @@ -616,7 +616,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_rep.html b/man/v0.0.0/nng_rep.html index cdb9ddf2..9956b96b 100644 --- a/man/v0.0.0/nng_rep.html +++ b/man/v0.0.0/nng_rep.html @@ -636,7 +636,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_req.html b/man/v0.0.0/nng_req.html index 489632ea..7612cca8 100644 --- a/man/v0.0.0/nng_req.html +++ b/man/v0.0.0/nng_req.html @@ -686,7 +686,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_respondent.html b/man/v0.0.0/nng_respondent.html index 0e846b82..e1c81b9f 100644 --- a/man/v0.0.0/nng_respondent.html +++ b/man/v0.0.0/nng_respondent.html @@ -638,7 +638,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_strerror.html b/man/v0.0.0/nng_strerror.html index ca09a0a1..6ff3fdb0 100644 --- a/man/v0.0.0/nng_strerror.html +++ b/man/v0.0.0/nng_strerror.html @@ -595,7 +595,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_sub.html b/man/v0.0.0/nng_sub.html index 89343d75..5167f060 100644 --- a/man/v0.0.0/nng_sub.html +++ b/man/v0.0.0/nng_sub.html @@ -642,7 +642,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_surveyor.html b/man/v0.0.0/nng_surveyor.html index 947029fe..13b2db96 100644 --- a/man/v0.0.0/nng_surveyor.html +++ b/man/v0.0.0/nng_surveyor.html @@ -656,7 +656,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_tcp.html b/man/v0.0.0/nng_tcp.html index 26c17488..a4ee7005 100644 --- a/man/v0.0.0/nng_tcp.html +++ b/man/v0.0.0/nng_tcp.html @@ -689,7 +689,7 @@ Copyright 2017 Capitar IT Group BV

diff --git a/man/v0.0.0/nng_tls.html b/man/v0.0.0/nng_tls.html index 767d07d9..652da594 100644 --- a/man/v0.0.0/nng_tls.html +++ b/man/v0.0.0/nng_tls.html @@ -550,7 +550,8 @@ cannot be initialized for any reason.

Availability

The tls transport depends on the use of an external library. -As of this writing, mbed TLS is required.

+As of this writing, mbed TLS version 2.0 +or later is required.

@@ -587,11 +588,11 @@ license terms of any libraries you make use of.

URI Format

This transport uses URIs using the scheme tls://, followed by +

This transport uses URIs using the scheme tls+tcp://, followed by an IP address or hostname, followed by a colon and finally a TCP port number. For example, to contact port 4433 on the localhost -either of the following URIs could be used: tls://127.0.0.1:4433 or -tcp://localhost:4433.

+either of the following URIs could be used: tls+tcp://127.0.0.1:4433 or +tls+tcp://localhost:4433.

When specifying IPv6 addresses, the address must be enclosed in @@ -600,7 +601,7 @@ separating the port.

For example, the same port 4433 on the IPv6 loopback address (::1) would -be specified as tcp://[::1]:4433.

+be specified as tls+tcp://[::1]:4433.

@@ -643,13 +644,13 @@ on the host:

-
tls://0.0.0.0:9999
+
tls+tcp://0.0.0.0:9999
-
tls://*:9999
+
tls+tcp://*:9999
-
tls://:9999
+
tls+tcp://:9999

diff --git a/man/v0.0.0/nng_ws.html b/man/v0.0.0/nng_ws.html new file mode 100644 index 00000000..8610a877 --- /dev/null +++ b/man/v0.0.0/nng_ws.html @@ -0,0 +1,730 @@ +--- +version: 0.0.0 +layout: default +--- + + + + + + + + +nng_ws(7) + + + + + + + +

SYNOPSIS

#include <nng/transport/websocket/ws.h>
+
+int nng_ws_register(void);

DESCRIPTION

The nng_ws transport provides communication support between +nng sockets across a TCP/IP network using +WebSockets. Both IPv4 and IPv6 +are supported when the underlying platform also supports it.

The protocol details are documented in +WebSocket Mapping for Scalability Protocols.

Registration

Depending upon how the library was built, it may be necessary to +register the transport by calling nng_ws_register. This function +returns zero on success, or an nng error value if the transport +cannot be initialized for any reason.

URI Format

This transport uses URIs using the scheme ws://, followed by +an IP address or hostname, optionally followed by a colon and an +TCP port number, optionally followed by a path. (If no port number +is specified then port 80 is assumed. If no path is specified then +a path of / is assumed.) +For example, the URI ws://localhost/app/pubsub would use +port 80 on localhost, with the path /app/pubsub.

When specifying IPv6 addresses, the address must be enclosed in +square brackets ([]) to avoid confusion with the final colon +separating the port.

For example, the same path and port on the IPv6 loopback address (::1) +would be specified as ws://[::1]/app/pubsub.

+ + + + +

+ +	+When using symbolic names, the name is resolved when the +name is first used. nng won’t become aware of changes in the +name resolution until restart, +usually.^[1] +

+ + + + + +

+ +	+The value specified as the host, if any, will also be used +in the `Host:` HTTP header during HTTP negotiation. +

The special value of 0 (INADDR_ANY) can be used for a listener +to indicate that it should listen on all interfaces on the host. +A short-hand for this form is to either omit the address, or specify +the asterisk (*) character. For example, the following three +URIs are all equivalent, and could be used to listen to port 9999 +on the host:

+
ws://0.0.0.0:9999
+
+
ws://*:9999
+
+
ws://:9999
+

+ +

Socket Address

When using an nng_sockaddr structure, the actual structure is either +of type nng_sockaddr_in (for IPv4) or nng_sockaddr_in6 (for IPv6). +These are struct types with the following definitions:

#define NNG_AF_INET    3 (1)
+#define NNG_AF_INET6   4
+#define NNG_MAXADDRLEN 128
+
+typedef struct {
+    // ... (2)
+    uint16_t sa_family;                 // must be NNG_AF_INET
+    uint16_t sa_port;                   // TCP port number
+    uint32_t sa_addr;
+    // ...
+} nng_sockaddr_in;
+
+typedef struct {
+    // ... (2)
+    uint16_t sa_family;                 // must be NNG_AF_INET6
+    uint16_t sa_port;                   // TCP port number
+    uint8_t  sa_addr[16];
+    // ...
+} nng_sockaddr_in6;

+ + + + + + + + + +

1	The values of these macros may change, so applications +should avoid depending upon their values and instead use them symbolically.
2	Other members may be present, but only those listed here +are suitable for application use.

The sa_family member will have the value NNG_AF_INET or NNG_AF_INET6. +The sa_port and sa_addr are the TCP port number and address, both in +network byte order (most significant byte is first).

Transport Options

The following transport options are available. Note that +setting these must be done before the transport is started.

NNG_OPT_WS_REQUEST_HEADERS: +
This value is a string, consisting 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.
+
NNG_OPT_WS_RESPONSE_HEADERS: +
This value is a string, consisting of multiple lines terminated +by CRLF sequences, that can be used to add furthe headers to the +HTTP response sent when connecting. This option can be set on listeners, +and retrieved from pipes.
+

+ + +

COPYRIGHT

This document is supplied under the terms of the +MIT License.

+ +

+1. This is a bug and will likely be fixed in the future. +

+ + + diff --git a/man/v0.0.0/nng_zerotier.html b/man/v0.0.0/nng_zerotier.html index 45ac74bd..2b5c70fc 100644 --- a/man/v0.0.0/nng_zerotier.html +++ b/man/v0.0.0/nng_zerotier.html @@ -802,7 +802,7 @@ Copyright 2017 Capitar IT Group BV

-- cgit v1.2.3-70-g09d2

Availability

URI Format

nng_ws(7) Manual Page

NAME

SYNOPSIS

DESCRIPTION

Registration

URI Format

Socket Address

Transport Options

SEE ALSO

COPYRIGHT