diff options
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/src/SUMMARY.md | 2 | ||||
| -rw-r--r-- | docs/reference/src/sock/index.md | 9 | ||||
| -rw-r--r-- | docs/reference/src/sock/nng_pair_open.md | 2 | ||||
| -rw-r--r-- | docs/reference/src/sock/nng_pub_open.md | 4 | ||||
| -rw-r--r-- | docs/reference/src/sock/nng_pull_open.3.adoc | 42 | ||||
| -rw-r--r-- | docs/reference/src/sock/nng_pull_open.md | 42 | ||||
| -rw-r--r-- | docs/reference/src/sock/nng_push_open.3.adoc | 42 | ||||
| -rw-r--r-- | docs/reference/src/sock/nng_push_open.md | 41 |
8 files changed, 94 insertions, 90 deletions
diff --git a/docs/reference/src/SUMMARY.md b/docs/reference/src/SUMMARY.md index 06a2a878..498511a4 100644 --- a/docs/reference/src/SUMMARY.md +++ b/docs/reference/src/SUMMARY.md @@ -56,6 +56,8 @@ - [nng_device](sock/nng_device.md) - [nng_pair_open](sock/nng_pair_open.md) - [nng_pub_open](sock/nng_pub_open.md) + - [nng_pull_open](sock/nng_pull_open.md) + - [nng_push_open](sock/nng_push_open.md) - [nng_sub_open](sock/nng_sub_open.md) - [nng_surveyor_open](sock/nng_surveyor_open.md) diff --git a/docs/reference/src/sock/index.md b/docs/reference/src/sock/index.md index d90a4fb9..4dbdab5e 100644 --- a/docs/reference/src/sock/index.md +++ b/docs/reference/src/sock/index.md @@ -2,8 +2,11 @@ ## See Also -[nng_bus_open][nng_bus_open] -[nng_close][nng_close] -[nng_pub_open][nng_pub_open] +[nng_bus_open][nng_bus_open], +[nng_close][nng_close], +[nng_pair_open][nng_pub_open], +[nng_pub_open][nng_pub_open], +[nng_sub_open][nng_pub_open], +[nng_surveyor_open][nng_surveyor_open] {{#include ../refs.md}} diff --git a/docs/reference/src/sock/nng_pair_open.md b/docs/reference/src/sock/nng_pair_open.md index 3fe756b9..df3c8b65 100644 --- a/docs/reference/src/sock/nng_pair_open.md +++ b/docs/reference/src/sock/nng_pair_open.md @@ -55,6 +55,6 @@ These functions returns 0 on success, and non-zero otherwise. ## SEE ALSO [Sockets][socket], -[PAIR Protocol][pair] +[_PAIR_ Protocol][pair] {{#include ../refs.md}}
\ No newline at end of file diff --git a/docs/reference/src/sock/nng_pub_open.md b/docs/reference/src/sock/nng_pub_open.md index e340b933..e8b6bbd0 100644 --- a/docs/reference/src/sock/nng_pub_open.md +++ b/docs/reference/src/sock/nng_pub_open.md @@ -36,7 +36,7 @@ These functions return 0 on success, and non-zero otherwise. ## SEE ALSO [Sockets][socket] -[PUB Protocol][pub], -[SUB Protocol][sub] +[_PUB_ Protocol][pub], +[_SUB_ Protocol][sub] {{#include ../refs.md}} diff --git a/docs/reference/src/sock/nng_pull_open.3.adoc b/docs/reference/src/sock/nng_pull_open.3.adoc deleted file mode 100644 index 2abb8ca8..00000000 --- a/docs/reference/src/sock/nng_pull_open.3.adoc +++ /dev/null @@ -1,42 +0,0 @@ -# nng_pull_open(3) - -## NAME - -nng_pull_open - create pull socket - -## SYNOPSIS - -``` -#include <nng/nng.h> -#include <nng/protocol/pipeline0/pull.h> - -int nng_pull0_open(nng_socket *s); - -int nng_pull0_open_raw(nng_socket *s); -``` - -## DESCRIPTION - -The `nng_pull0_open()` function creates a xref:nng_pull.7.adoc[_pull_] version 0 -xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. - -The `nng_pull0_open_raw()` function creates a xref:nng_pull.7.adoc[_pull_] 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_. - -## RETURN VALUES - -These functions return 0 on success, and non-zero otherwise. - -## ERRORS - -[horizontal] -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_ENOTSUP`:: The protocol is not supported. - -## SEE ALSO - -xref:nng_socket.5.adoc[nng_socket(5)], -xref:nng_pull.7.adoc[nng_pull(7)], -xref:nng_push.7.adoc[nng_push(7)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/reference/src/sock/nng_pull_open.md b/docs/reference/src/sock/nng_pull_open.md new file mode 100644 index 00000000..e10f66c0 --- /dev/null +++ b/docs/reference/src/sock/nng_pull_open.md @@ -0,0 +1,42 @@ +# nng_pull_open + +## NAME + +nng_pull_open --- create _PULL_ socket + +## SYNOPSIS + +```c +#include <nng/nng.h> +#include <nng/protocol/pipeline0/pull.h> + +int nng_pull0_open(nng_socket *s); + +int nng_pull0_open_raw(nng_socket *s); +``` + +## DESCRIPTION + +The `nng_pull0_open()` function creates a [_PULL_][pull] version 0 +[socket][socket] and returns it at the location pointed to by _s_. + +The `nng_pull0_open_raw()` function creates a _PULL_ version 0 +socket in +[raw mode][raw] 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 + +[Sockets][socket], +[_PULL_ Protocol][pull], +[_PUSH_ Protocol][push] + +{{#include ../refs.md}}
\ No newline at end of file diff --git a/docs/reference/src/sock/nng_push_open.3.adoc b/docs/reference/src/sock/nng_push_open.3.adoc deleted file mode 100644 index 80202555..00000000 --- a/docs/reference/src/sock/nng_push_open.3.adoc +++ /dev/null @@ -1,42 +0,0 @@ -# nng_push_open(3) - -## NAME - -nng_push_open - create push socket - -## SYNOPSIS - -``` -#include <nng/nng.h> -#include <nng/protocol/pipeline0/push.h> - -int nng_push0_open(nng_socket *s); - -int nng_push0_open_raw(nng_socket *s); -``` - -## DESCRIPTION - -The `nng_push0_open()` function creates a xref:nng_push.7.adoc[_push_] version 0 -xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. - -The `nng_push0_open_raw()` function creates a xref:nng_push.7.adoc[_push_] 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_. - -## RETURN VALUES - -These functions return 0 on success, and non-zero otherwise. - -## ERRORS - -[horizontal] -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_ENOTSUP`:: The protocol is not supported. - -## SEE ALSO - -xref:nng_socket.5.adoc[nng_socket(5)], -xref:nng_pull.7.adoc[nng_pull(7)], -xref:nng_push.7.adoc[nng_push(7)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/reference/src/sock/nng_push_open.md b/docs/reference/src/sock/nng_push_open.md new file mode 100644 index 00000000..aace8750 --- /dev/null +++ b/docs/reference/src/sock/nng_push_open.md @@ -0,0 +1,41 @@ +# nng_push_open + +## NAME + +nng_push_open --- create push socket + +## SYNOPSIS + +```c +#include <nng/nng.h> +#include <nng/protocol/pipeline0/push.h> + +int nng_push0_open(nng_socket *s); + +int nng_push0_open_raw(nng_socket *s); +``` + +## DESCRIPTION + +The `nng_push0_open()` function creates a [_PUSH_][push] version 0 +[socket][socket] and returns it at the location pointed to by _s_. + +The `nng_push0_open_raw()` function creates a _PUSH_ version 0 socket in +[raw mode][raw] 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 + +[Sockets][socket], +[_PULL_ Protocol][pull], +[_PUSH_ Protocol][push] + +{{#include ../refs.md}} |
