summaryrefslogtreecommitdiff
path: root/docs/reference/src/api/socket
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-03-25 21:48:58 -0700
committerGarrett D'Amore <garrett@damore.org>2024-03-25 21:48:58 -0700
commit87e5fc287fedb14656f964254f9b5c738c72b72a (patch)
tree4bbd8ce889381d7b2de21b3c888a38c87acf7e31 /docs/reference/src/api/socket
parent9d71bbc9f67478ccc28bf6ea9cb1617e8293be94 (diff)
downloadnng-87e5fc287fedb14656f964254f9b5c738c72b72a.tar.gz
nng-87e5fc287fedb14656f964254f9b5c738c72b72a.tar.bz2
nng-87e5fc287fedb14656f964254f9b5c738c72b72a.zip
More content changes.
Diffstat (limited to 'docs/reference/src/api/socket')
-rw-r--r--docs/reference/src/api/socket/index.md6
-rw-r--r--docs/reference/src/api/socket/nng_bus_open.md11
-rw-r--r--docs/reference/src/api/socket/nng_pub_open.md50
3 files changed, 29 insertions, 38 deletions
diff --git a/docs/reference/src/api/socket/index.md b/docs/reference/src/api/socket/index.md
index 990b7cbb..8bd82b7d 100644
--- a/docs/reference/src/api/socket/index.md
+++ b/docs/reference/src/api/socket/index.md
@@ -1 +1,7 @@
# Protocol Sockets
+
+## See Also
+
+[nng_bus_open()](nng_bus_open.md)
+[nng_close()](nng_close.md)
+[nng_pub_open()](nng_pub_open.md)
diff --git a/docs/reference/src/api/socket/nng_bus_open.md b/docs/reference/src/api/socket/nng_bus_open.md
index a579acfb..fd56455b 100644
--- a/docs/reference/src/api/socket/nng_bus_open.md
+++ b/docs/reference/src/api/socket/nng_bus_open.md
@@ -2,7 +2,7 @@
## NAME
-nng_bus_open --- create bus socket
+nng_bus_open --- create _BUS_ socket
## SYNOPSIS
@@ -17,10 +17,10 @@ int nng_bus0_open_raw(nng_socket *s);
## DESCRIPTION
-The `nng_bus0_open()` function creates a [_BUS_](../protocols/bus.md) version 0
+The `nng_bus0_open()` function creates a [_BUS_](../../protocols/bus.md) version 0
[socket](nng_socket.md) and returns it at the location pointed to by _s_.
-The `nng_bus0_open_raw()` function creates a [_BUS_](../protocols/bus.md) version 0
+The `nng_bus0_open_raw()` function creates a [_BUS_](../../protocols/bus.md) version 0
[socket](nng_socket.md) in
[raw](../overview/raw.md) mode, and returns it at the location pointed to by _s_.
@@ -35,6 +35,5 @@ These functions return 0 on success, and non-zero otherwise.
## SEE ALSO
-[nng_socket()](nng_socket.md),
-[BUS protocol](../protocols/bus.md),
-[RAW mode](../overview/raw.md)
+[BUS protocol](../../protocols/bus.md),
+[RAW mode](../../overview/raw.md)
diff --git a/docs/reference/src/api/socket/nng_pub_open.md b/docs/reference/src/api/socket/nng_pub_open.md
index c9f3b5b5..987718f4 100644
--- a/docs/reference/src/api/socket/nng_pub_open.md
+++ b/docs/reference/src/api/socket/nng_pub_open.md
@@ -1,53 +1,39 @@
-= nng_pub_open(3)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// This document 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.
-//
+# nng_pub_open()
-== NAME
+## NAME
-nng_pub_open - create pub socket
+nng_pub_open --- create _PUB_ socket
-== SYNOPSIS
+## SYNOPSIS
-[source,c]
-----
+```c
#include <nng/nng.h>
#include <nng/protocol/pubsub0/pub.h>
int nng_pub0_open(nng_socket *s);
int nng_pub0_open_raw(nng_socket *s);
-----
+```
== DESCRIPTION
-The `nng_pub0_open()` function creates a xref:nng_pub.7.adoc[_pub_] version 0
-xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_.
+The `nng_pub0_open()` function creates a [_PUB_](../../protocols/pub.md) version 0
+[socket](nng_socket.md) and returns it at the location pointed to by _s_.
-The `nng_pub0_open_raw()` function creates a xref:nng_pub.7.adoc[_pub_] version 0
-xref:nng_socket.5.adoc[socket] in
-xref:nng.7.adoc#raw_mode[raw] mode and returns it at the location pointed to by _s_.
+The `nng_pub0_open_raw()` function creates a [_PUB_](../../protocols/pub.md) version 0
+[socket](nng_socket.md) in
+[raw](../../overview/raw.md) mode and returns it at the location pointed to by _s_.
-== RETURN VALUES
+## RETURN VALUES
These functions return 0 on success, and non-zero otherwise.
-== ERRORS
+## ERRORS
-[horizontal]
-`NNG_ENOMEM`:: Insufficient memory is available.
-`NNG_ENOTSUP`:: The protocol is not supported.
+- `NNG_ENOMEM`: Insufficient memory is available.
+- `NNG_ENOTSUP`: The protocol is not supported.
-== SEE ALSO
+## SEE ALSO
-[.text-left]
-xref:nng_socket.5.adoc[nng_socket(5)],
-xref:nng_pub.7.adoc[nng_pub(7)],
-xref:nng_sub.7.adoc[nng_sub(7)],
-xref:nng.7.adoc[nng(7)]
+[PUB Protocol](../../protocols/pub.md),
+[SUB Protocol](../../protocols/sub.md)