aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_dialer_create.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-03-15 08:40:17 -0700
committerGarrett D'Amore <garrett@damore.org>2018-03-17 08:49:12 -0700
commit98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 (patch)
treee3cc06524b26fd0773d1742de82a00862f95c5f6 /docs/man/nng_dialer_create.adoc
parent91866ed9365ab89069c12da41c873c23d0ba1d19 (diff)
downloadnng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.gz
nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.bz2
nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.zip
fixes #286 nng_pair0_open (and all others) need man page
fixes #279 consider restructuring man sections This represents a rather significant rework, and major editing effort, for the entire set of manual pages. All of the pages now have a section number in their filename; this assists in some other tooling, particularly ebook generation as every link needs to be programmatically modified when combined into an ebook. Section 5 is introduced, and populated with pages for the main types, and all options are now documented. Numerous errors have been corrected, including rewriting certain portions such as the header section of the surveyor protocol. Much work has been done to facilitate index generation, although certainly more work remains here. Every internal link within these pages now resolves; there are no more dead links. (This is required to generate Kindle format books.)
Diffstat (limited to 'docs/man/nng_dialer_create.adoc')
-rw-r--r--docs/man/nng_dialer_create.adoc74
1 files changed, 0 insertions, 74 deletions
diff --git a/docs/man/nng_dialer_create.adoc b/docs/man/nng_dialer_create.adoc
deleted file mode 100644
index 02b7796b..00000000
--- a/docs/man/nng_dialer_create.adoc
+++ /dev/null
@@ -1,74 +0,0 @@
-= nng_dialer_create(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_dialer_create - create dialer
-
-== SYNOPSIS
-
-[source, c]
------------
-#include <nng/nng.h>
-
-int nng_dialer_create(nng_dialer *dialerp, nng_socket s, const char *url);
------------
-
-== DESCRIPTION
-
-The `nng_dialer_create()` function creates a newly initialized
-dialer, associated with socket _s_, and configured to connect to the
-address specified by _url_, and stores a pointer to at the location
-referenced by _dialerp_.
-
-Dialers initiate a remote connection to a listener. Upon a successful
-connection being established, they create a pipe, add it to the socket,
-and then wait for that pipe to be closed. When the pipe is closed,
-they will re-initiate the connection. Dialer's will also periodically
-retry a connection automatically if an attempt to connect asynchronously
-fails.
-
-TIP: While it is convenient to think of dialers as "clients", the relationship
-between the listener or dialer is orthogonal to any server or client status
-that might be associated with a given protocol. For example, a <<nng_req#,REQ>>
-socket might have associated dialers, but might also have associated listeners.
-It may even have some of each at the same time!
-
-The dialer is not started, but may be further configured with
-the <<nng_dialer_setopt#,nng_dialer_setopt(3)>> family of
-functions.
-
-Once it is fully configured, the dialer may be started using the
-<<nng_dialer_start#,nng_dialer_start(3)>> function.
-
-TIP: If no specific configuration is required, consider using the
-simpler <<nng_dial#,nng_dial(3)>> function instead.
-
-== RETURN VALUES
-
-This function returns 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-`NNG_EADDRINVAL`:: An invalid _url_ was specified.
-`NNG_ECLOSED`:: The socket _s_ is not open.
-`NNG_ENOMEM`:: Insufficient memory is available.
-
-== SEE ALSO
-
-<<nng_dial#,nng_dial(3)>>,
-<<nng_dialer_close#,nng_dialer_close(3)>>,
-<<nng_dialer_getopt#,nng_dialer_getopt(3)>>,
-<<nng_dialer_setopt#,nng_dialer_setopt(3)>>,
-<<nng_dialer_start#,nng_dialer_start(3)>>,
-<<nng_listener_create#,nng_listener_create(3)>>
-<<nng_strerror#,nng_strerror(3)>>,
-<<nng#,nng(7)>>