diff options
Diffstat (limited to 'docs/man/nng_bus_open.3.adoc')
| -rw-r--r-- | docs/man/nng_bus_open.3.adoc | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/docs/man/nng_bus_open.3.adoc b/docs/man/nng_bus_open.3.adoc deleted file mode 100644 index 3477a903..00000000 --- a/docs/man/nng_bus_open.3.adoc +++ /dev/null @@ -1,52 +0,0 @@ -= nng_bus_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. -// - -== NAME - -nng_bus_open - create bus socket - -== SYNOPSIS - -[source,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 xref:nng_bus.7.adoc[_bus_] version 0 -xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. - -The `nng_bus0_open_raw()` function creates a xref:nng_bus.7.adoc[_bus_] 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 - -[.text-left] -xref:nng_socket.5.adoc[nng_socket(5)], -xref:nng_bus.7.adoc[nng_bus(7)], -xref:nng.7.adoc[nng(7)] |