diff options
Diffstat (limited to 'docs/man/nng_socket.5.adoc')
| -rw-r--r-- | docs/man/nng_socket.5.adoc | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/man/nng_socket.5.adoc b/docs/man/nng_socket.5.adoc new file mode 100644 index 00000000..0dcdfa99 --- /dev/null +++ b/docs/man/nng_socket.5.adoc @@ -0,0 +1,55 @@ += nng_socket(5) +// +// 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_socket - socket handle + +== SYNOPSIS + +[source, c] +---- +#include <nng/nng.h> + +typedef uint32_t nng_socket; +---- + +== DESCRIPTION + +An `nng_socket`(((socket))) is a handle to an underlying "`socket`" object. +All communication between the application and remote Scalability Protocol +peers is done through sockets. +A given socket can have multiple dialers (<<nng_dialer.5#,`nng_dialer`>>) +and/or (<<nng_listener.5#,`nng_listener`>>), and multiple +pipes (<<nng_pipe.5#,`nng_pipe`>>), and +may be connected to multiple transports at the same time. +However, a given socket will have exactly one "`protocol`" associated with it, +and is responsible for any state machines or other protocol-specific logic. + +NOTE: Although `nng_socket` is an integer data type, these objects are not +ordinary file descriptors, and can only be used with the functions that +explicitly indicate that it safe and appropropate to do so. + +Each `nng_socket` is created by a protocol-specific constructor, such as +<<nng_rep_open.3#,`nng_rep_open()`>>. +When the socket is no longer needed, it can be closed with +<<nng_close.3#,`nng_close()`>>. + +== SEE ALSO + +<<libnng.3#,libnng(3)>>, +<<nng_close.3#,nng_close(3)>>, +<<nng_getopt.3#,nng_getopt(3)>>, +<<nng_setopt.3#,nng_setopt(3)>>, +<<nng_dialer.5#,nng_dialer(5)>>, +<<nng_listener.5#,nng_listener(5)>>, +<<nng_options.5#,nng_options(5)>>, +<<nng.7#,nng(7)>> |