aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_ws.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-02 15:43:43 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-02 17:02:40 -0800
commitc2deb4a479be750b054372e83154f4b3b051c95a (patch)
treea6909733d8d56fcfa192b16c0c05b07e15e1ad7f /docs/nng_ws.adoc
parent4f1029f8f4c582d1f04632b0c50f4c374284fa16 (diff)
downloadnng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.gz
nng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.bz2
nng-c2deb4a479be750b054372e83154f4b3b051c95a.zip
Update markup with simpler copyright and new-style asciidoctor.
Diffstat (limited to 'docs/nng_ws.adoc')
-rw-r--r--docs/nng_ws.adoc56
1 files changed, 20 insertions, 36 deletions
diff --git a/docs/nng_ws.adoc b/docs/nng_ws.adoc
index ebab433c..ba01c9fd 100644
--- a/docs/nng_ws.adoc
+++ b/docs/nng_ws.adoc
@@ -1,23 +1,18 @@
-nng_ws(7)
-=========
+= nng_ws(7)
:doctype: manpage
:manmanual: nng
:mansource: nng
-:icons: font
-:source-highlighter: pygments
-:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \
- Copyright 2018 Capitar IT Group BV <info@capitar.com> \
- This software is supplied under the terms of the MIT License, a \
- copy of which should be located in the distribution where this \
- file was obtained (LICENSE.txt). A copy of the license may also \
- be found online at https://opensource.org/licenses/MIT.
-
-NAME
-----
+:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
+ Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
+ {blank} + \
+ This document is supplied under the terms of the \
+ https://opensource.org/licenses/MIT[MIT License].
+
+== NAME
+
nng_ws - WebSocket transport for nng
-SYNOPSIS
---------
+== SYNOPSIS
[source,c]
----------
@@ -27,8 +22,7 @@ int nng_ws_register(void);
int nng_wss_register(void);
----------
-DESCRIPTION
------------
+== DESCRIPTION
The _nng_ws_ transport provides communication support between
_nng_ sockets across a TCP/IP network using
@@ -38,8 +32,7 @@ are supported when the underlying platform also supports it.
The protocol details are documented in
http://nanomsg.org/rfcs/sp-websocket-v1.html[WebSocket Mapping for Scalability Protocols].
-Registration
-~~~~~~~~~~~~
+=== Registration
Depending upon how the library was built, it may be necessary to
register the transport by calling `nng_ws_register`. This function
@@ -51,8 +44,7 @@ can be used as well, but the secure transport may have to be registered using
the `nng_wss_register` function. (Note that this function will not be
present if TLS support was not enabled in the library.)
-URI Format
-~~~~~~~~~~
+=== URI Format
This transport uses URIs using the scheme `ws://`, followed by
an IP address or hostname, optionally followed by a colon and an
@@ -88,8 +80,7 @@ the underlying system supports. (On most modern systems it will map to the
special IPv6 address `::`, and both IPv4 and IPv6 connections will be
permitted, with IPv4 addresses mapped to IPv6 addresses.)
-Socket Address
-~~~~~~~~~~~~~~
+=== 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).
@@ -126,8 +117,7 @@ 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).
-Server Instances
-~~~~~~~~~~~~~~~~
+=== Server Instances
This transport makes use of shared HTTP server instances, permitting multiple
sockets or listeners to be configured with the same hostname and port. When
@@ -147,8 +137,7 @@ process.
The server may also be used by other things (for example to serve static
content), in the same process.
-Transport Options
-~~~~~~~~~~~~~~~~~
+=== Transport Options
The following transport options are available. Note that
setting these must be done before the transport is started.
@@ -213,16 +202,11 @@ results if peer authentication is disabled with `NNG_TLS_AUTH_MODE_NONE`.
// and NNG_OPT_LISTEN_HOOK_ARG that passes the void * passed in as first arg.
// Alternatively we can uplevel the HTTP API and pass the actual HTTP objects.
-SEE ALSO
---------
+== SEE ALSO
+
<<nng#,nng(7)>>,
<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>
-COPYRIGHT
----------
-
-Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] +
-Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV]
+== COPYRIGHT
-This document is supplied under the terms of the
-https://opensource.org/licenses/MIT[MIT License].
+{copyright} \ No newline at end of file