From c4050ecbf846d138a07bfaf238306fb862b9a3d5 Mon Sep 17 00:00:00 2001 From: "Staysail Systems, Inc" Date: Sun, 2 Aug 2020 12:14:46 -0700 Subject: Manual page updates for v1.3.2 --- man/v1.3.2/nng_socket_id.3.html | 78 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 man/v1.3.2/nng_socket_id.3.html (limited to 'man/v1.3.2/nng_socket_id.3.html') diff --git a/man/v1.3.2/nng_socket_id.3.html b/man/v1.3.2/nng_socket_id.3.html new file mode 100644 index 00000000..4bae4252 --- /dev/null +++ b/man/v1.3.2/nng_socket_id.3.html @@ -0,0 +1,78 @@ +--- +version: v1.3.2 +layout: manpage_v2 +--- +

nng_socket_id(3)

+
+

NAME

+
+
+

nng_socket_id - return numeric socket identifier

+
+
+
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+int nng_socket_id(nng_socket s);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_socket_id() function returns a positive identifier for the socket s, +if it is valid. +Otherwise it returns -1.

+
+
+ + + + + +
+ + +A socket is considered valid if it was ever opened with a protocol +constructor, such as the nng_req0_open() function. +Sockets that are allocated on the stack or statically should be +initialized with the macro +NNG_SOCKET_INITIALIZER +to ensure that they cannot be confused with a valid socket before they are opened. +
+
+
+
+
+

RETURN VALUES

+
+
+

This function returns the positive value for the socket identifier, or +-1 if the socket is invalid.

+
+
+
+
+

ERRORS

+
+
+

None.

+
+
+
+
+

SEE ALSO

+
+
+

nng_socket(5), +nng(7)

+
+
+
-- cgit v1.2.3-70-g09d2