From 2e87cb315954bb4ed92ebb71c355fddff9e992e3 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 30 Mar 2024 21:33:42 -0700 Subject: nng_pair_open --- docs/man/nng_pair_open.3.adoc | 72 ------------------------------------- docs/man/nng_pull_open.3.adoc | 53 --------------------------- docs/man/nng_push_open.3.adoc | 53 --------------------------- docs/man/nng_rep_open.3.adoc | 53 --------------------------- docs/man/nng_req_open.3.adoc | 55 ---------------------------- docs/man/nng_respondent_open.3.adoc | 56 ----------------------------- docs/man/nng_sub_open.3.adoc | 53 --------------------------- docs/man/nng_surveyor_open.3.adoc | 54 ---------------------------- 8 files changed, 449 deletions(-) delete mode 100644 docs/man/nng_pair_open.3.adoc delete mode 100644 docs/man/nng_pull_open.3.adoc delete mode 100644 docs/man/nng_push_open.3.adoc delete mode 100644 docs/man/nng_rep_open.3.adoc delete mode 100644 docs/man/nng_req_open.3.adoc delete mode 100644 docs/man/nng_respondent_open.3.adoc delete mode 100644 docs/man/nng_sub_open.3.adoc delete mode 100644 docs/man/nng_surveyor_open.3.adoc (limited to 'docs/man') diff --git a/docs/man/nng_pair_open.3.adoc b/docs/man/nng_pair_open.3.adoc deleted file mode 100644 index 20348123..00000000 --- a/docs/man/nng_pair_open.3.adoc +++ /dev/null @@ -1,72 +0,0 @@ -= nng_pair_open(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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_pair_open - create pair socket - -== SYNOPSIS - -.Version 0 -[source,c] ----- -#include - -int nng_pair0_open(nng_socket *s); - -int nng_pair0_open_raw(nng_socket *s); ----- - -.Version 1 -[source,c] ----- -#include - -int nng_pair1_open(nng_socket *s); - -int nng_pair1_open_raw(nng_socket *s); - -int nng_pair1_open_poly(nng_socktet *s); ----- - -== DESCRIPTION - -The `nng_pair0_open()` and `nng_pair1_open()` functions -create a xref:nng_pair.7.adoc[_pair_] version 0 or version 1 -xref:nng_socket.5.adoc[socket] and return it at the location pointed to by _s_. - -The `nng_pair0_open_raw()` and `nng_pair1_open_raw()` functions -create a xref:nng_pair.7.adoc[_pair_] version 0 or version 1 -xref:nng_socket.5.adoc[socket] in -xref:nng.7.adoc#raw_mode[raw] mode and return it at the location pointed to by _s_. - -The `nng_pair1_open_poly()` function opens a pair version 1 socket in -polyamorous mode. - -NOTE: Polyamorous mode is deprecated and should not be used in new applications. -The `nng_pair1_open_poly()` function will likely be removed in a future release. - -== RETURN VALUES - -These functions returns 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_pair.7.adoc[nng_pair(7)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_pull_open.3.adoc b/docs/man/nng_pull_open.3.adoc deleted file mode 100644 index 12f85978..00000000 --- a/docs/man/nng_pull_open.3.adoc +++ /dev/null @@ -1,53 +0,0 @@ -= nng_pull_open(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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_pull_open - create pull socket - -== SYNOPSIS - -[source,c] ----- -#include -#include - -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 - -[.text-left] -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/man/nng_push_open.3.adoc b/docs/man/nng_push_open.3.adoc deleted file mode 100644 index 1b1635ef..00000000 --- a/docs/man/nng_push_open.3.adoc +++ /dev/null @@ -1,53 +0,0 @@ -= nng_push_open(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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_push_open - create push socket - -== SYNOPSIS - -[source,c] ----- -#include -#include - -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 - -[.text-left] -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/man/nng_rep_open.3.adoc b/docs/man/nng_rep_open.3.adoc deleted file mode 100644 index dd62201d..00000000 --- a/docs/man/nng_rep_open.3.adoc +++ /dev/null @@ -1,53 +0,0 @@ -= nng_rep_open(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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_rep_open - create rep socket - -== SYNOPSIS - -[source,c] ----- -#include -#include - -int nng_rep0_open(nng_socket *s); - -int nng_rep0_open_raw(nng_socket *); ----- - -== DESCRIPTION - -The `nng_rep0_open()` function creates a xref:nng_rep.7.adoc[_rep_] version 0 -xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. - -The `nng_rep0_open_raw()` function creates a xref:nng_rep.7.adoc[_rep_] 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_rep.7.adoc[nng_rep(7)], -xref:nng_req.7.adoc[nng_req(7)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_req_open.3.adoc b/docs/man/nng_req_open.3.adoc deleted file mode 100644 index 0fd07944..00000000 --- a/docs/man/nng_req_open.3.adoc +++ /dev/null @@ -1,55 +0,0 @@ -= nng_req_open(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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_req_open - create req socket - -== SYNOPSIS - -[source,c] ----- -#include -#include - -int nng_req0_open(nng_socket *s); - -int nng_req0_open_raw(nng_socket *s); ----- - -== DESCRIPTION - -The `nng_req0_open()` function creates a xref:nng_req.7.adoc[_req_] version 0 -xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. - -The `nng_req0_open_raw()` function creates a xref:nng_req.7.adoc[_req_] 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_options.5.adoc[nng_options(5)], -xref:nng_socket.5.adoc[nng_socket(5)], -xref:nng_rep.7.adoc[nng_rep(7)], -xref:nng_req.7.adoc[nng_req(7)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_respondent_open.3.adoc b/docs/man/nng_respondent_open.3.adoc deleted file mode 100644 index 5a5167d2..00000000 --- a/docs/man/nng_respondent_open.3.adoc +++ /dev/null @@ -1,56 +0,0 @@ -= nng_respondent_open(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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_respondent_open - create respondent socket - -== SYNOPSIS - -[source,c] ----- -#include -#include - -int nng_respondent0_open(nng_socket *s); - -int nng_respondent0_open_raw(nng_socket *s); ----- - -== DESCRIPTION - -The `nng_respondent0_open()` function creates a -xref:nng_respondent.7.adoc[_respondent_] -version 0 xref:nng_socket.5.adoc[socket] and returns it at the location -pointed to by _s_. - -The `nng_respondent0_open_raw()` function creates a -xref:nng_respondent.7.adoc[_respondent_] -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_respondent.7.adoc[nng_respondent(7)], -xref:nng_surveyor.7.adoc[nng_surveyor(7)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_sub_open.3.adoc b/docs/man/nng_sub_open.3.adoc deleted file mode 100644 index ea01673c..00000000 --- a/docs/man/nng_sub_open.3.adoc +++ /dev/null @@ -1,53 +0,0 @@ -= nng_sub_open(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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_sub_open - create sub socket - -== SYNOPSIS - -[source,c] ----- -#include -#include - -int nng_sub0_open(nng_socket *s); - -int nng_sub0_open_raw(nng_socket *s); ----- - -== DESCRIPTION - -The `nng_sub0_open()` function creates a xref:nng_sub.7.adoc[_sub_] version 0 -xref:nng_socket.5.adoc[socket] and returns it at the location pointed to by _s_. - -The `nng_sub0_open_raw()` function creates a xref:nng_sub.7.adoc[_sub_] 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_pub.7.adoc[nng_pub(7)], -xref:nng_sub.7.adoc[nng_sub(7)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/man/nng_surveyor_open.3.adoc b/docs/man/nng_surveyor_open.3.adoc deleted file mode 100644 index cd648f65..00000000 --- a/docs/man/nng_surveyor_open.3.adoc +++ /dev/null @@ -1,54 +0,0 @@ -= nng_surveyor_open(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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_surveyor_open - create surveyor socket - -== SYNOPSIS - -[source,c] ----- -#include -#include - -int nng_surveyor0_open(nng_socket *s); - -int nng_surveyor0_open_raw(nng_socket *s); ----- - -== DESCRIPTION - -The `nng_surveyor0_open()` function creates a xref:nng_surveyor.7.adoc[_surveyor_] -version 0 xref:nng_socket.5.adoc[socket] and returns it at the location -pointed to by _s_. - -The `nng_surveyor0_open_raw()` function creates a xref:nng_surveyor.7.adoc[_surveyor_] -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_respondent.7.adoc[nng_respondent(7)], -xref:nng_surveyor.7.adoc[nng_surveyor(7)], -xref:nng.7.adoc[nng(7)] -- cgit v1.2.3-70-g09d2