summaryrefslogtreecommitdiff
path: root/docs/reference/src/api
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/src/api')
-rw-r--r--docs/reference/src/api/socket/index.md7
-rw-r--r--docs/reference/src/api/socket/nng_bus_open.md39
-rw-r--r--docs/reference/src/api/socket/nng_close.md41
-rw-r--r--docs/reference/src/api/socket/nng_pub_open.md39
4 files changed, 0 insertions, 126 deletions
diff --git a/docs/reference/src/api/socket/index.md b/docs/reference/src/api/socket/index.md
deleted file mode 100644
index f9a85b23..00000000
--- a/docs/reference/src/api/socket/index.md
+++ /dev/null
@@ -1,7 +0,0 @@
-# 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
deleted file mode 100644
index 3eb235e3..00000000
--- a/docs/reference/src/api/socket/nng_bus_open.md
+++ /dev/null
@@ -1,39 +0,0 @@
-# nng_bus_open
-
-## NAME
-
-nng_bus_open --- create _BUS_ socket
-
-## SYNOPSIS
-
-```c
-#include <nng/nng.h>
-#include <nng/protocol/bus0/bus.h>
-
-int nng_bus0_open(nng_socket *s);
-
-int nng_bus0_open_raw(nng_socket *s);
-```
-
-## DESCRIPTION
-
-The `nng_bus0_open()` function creates a [_BUS_](../../protocols/bus.md) version 0
-[socket](index.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
-[socket](index.md) in
-[raw](../overview/raw.md) mode, and returns it at the location pointed to by _s_.
-
-## RETURN VALUES
-
-These functions return 0 on success, and non-zero otherwise.
-
-## ERRORS
-
-- `NNG_ENOMEM`: Insufficient memory is available.
-- `NNG_ENOTSUP`: The protocol is not supported.
-
-## SEE ALSO
-
-[BUS protocol](../../protocols/bus.md),
-[RAW mode](../../overview/raw.md)
diff --git a/docs/reference/src/api/socket/nng_close.md b/docs/reference/src/api/socket/nng_close.md
deleted file mode 100644
index fded0357..00000000
--- a/docs/reference/src/api/socket/nng_close.md
+++ /dev/null
@@ -1,41 +0,0 @@
-# nng_close
-
-## NAME
-
-nng_close --- close socket
-
-## SYNOPSIS
-
-```c
-#include <nng/nng.h>
-
-int nng_close(nng_socket s);
-```
-
-## DESCRIPTION
-
-The `nng_close()` function closes the supplied socket, _s_.
-Messages that have been submitted for sending may be flushed or delivered,
-depending upon the transport.
-
-Further attempts to use the socket after this call returns will result
-in `NNG_ECLOSED`.
-Threads waiting for operations on the socket when this
-call is executed may also return with an `NNG_ECLOSED` result.
-
-> [!NOTE]
-> Closing the socket while data is in transmission will likely lead to loss
-> of that data.
-> There is no automatic linger or flush to ensure that the socket send buffers
-> have completely transmitted.
-> It is recommended to wait a brief period after calling
-> [`nng_send()`](nng_send.md) or similar functions, before calling this
-> function.
-
-## RETURN VALUES
-
-This function returns 0 on success, and non-zero otherwise.
-
-## ERRORS
-
-- `NNG_ECLOSED`: The socket _s_ is already closed or was never opened.
diff --git a/docs/reference/src/api/socket/nng_pub_open.md b/docs/reference/src/api/socket/nng_pub_open.md
deleted file mode 100644
index 18321896..00000000
--- a/docs/reference/src/api/socket/nng_pub_open.md
+++ /dev/null
@@ -1,39 +0,0 @@
-# nng_pub_open
-
-## NAME
-
-nng*pub_open --- create \_PUB* socket
-
-## SYNOPSIS
-
-```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 [_PUB_](../../protocols/pub.md) version 0
-[socket](index.md) 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](index.md) in
-[raw](../../overview/raw.md) mode and returns it at the location pointed to by _s_.
-
-## RETURN VALUES
-
-These functions return 0 on success, and non-zero otherwise.
-
-## ERRORS
-
-- `NNG_ENOMEM`: Insufficient memory is available.
-- `NNG_ENOTSUP`: The protocol is not supported.
-
-## SEE ALSO
-
-[PUB Protocol](../../protocols/pub.md),
-[SUB Protocol](../../protocols/sub.md)