diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-29 17:03:51 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-29 18:14:55 -0700 |
| commit | 0ddaee41ec753805fa12eeabd679870802528dac (patch) | |
| tree | 3418859f4f22e9857b5ae979b3bc4eb53fd70035 /docs/man/nng_dial.3.adoc | |
| parent | 33dc5d611f578ace9833a80dc006a34b09da18af (diff) | |
| download | nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.gz nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.bz2 nng-0ddaee41ec753805fa12eeabd679870802528dac.zip | |
fixes #495 SEE ALSO should use [align=left]
fixes #494 ERRORS section should use [horizontal]
These changes address some basic formatting consistency things,
and ultimately (when combined with other tooling changes that are
not part of this repo) lead to vastly improved layout in the
printed documentation.
While here we removed trailing whitespace, and did certain other
minor markup tweaks.
Diffstat (limited to 'docs/man/nng_dial.3.adoc')
| -rw-r--r-- | docs/man/nng_dial.3.adoc | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/man/nng_dial.3.adoc b/docs/man/nng_dial.3.adoc index d2eb7605..50fa229c 100644 --- a/docs/man/nng_dial.3.adoc +++ b/docs/man/nng_dial.3.adoc @@ -49,7 +49,7 @@ It may even have some of each at the same time! Normally, the first attempt to connect to the address indicated by _url_ is done synchronously, including any necessary name resolution. As a result, a failure, such as if the connection is refused, will be returned -immediately, and no further action will be taken. +immediately, and no further action will be taken. However, if the special value `NNG_FLAG_NONBLOCK` is supplied in _flags_, then the connection attempt is made asynchronously. @@ -62,7 +62,7 @@ it also generally makes diagnosing failures somewhat more difficult. Because the dialer is started immediately, it is generally not possible to apply extra configuration; if that is needed applications should consider -using `<<nng_dialer_create.3#,nng_dialer_create()>>` and +using `<<nng_dialer_create.3#,nng_dialer_create()>>` and `<<nng_dialer_start.3#,nng_dialer_start()>>` instead. == RETURN VALUES @@ -71,6 +71,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EADDRINVAL`:: An invalid _url_ was specified. `NNG_ECLOSED`:: The socket _s_ is not open. `NNG_ECONNREFUSED`:: The remote peer refused the connection. @@ -83,6 +84,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_dialer_close.3#,nng_dialer_close(3)>>, <<nng_dialer_create.3#,nng_dialer_create(3)>> <<nng_dialer_start.3#,nng_dialer_start(3)>>, |