From f5d62f2b434300070048d4f07630afde4a1d760d Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Fri, 16 Feb 2018 20:03:11 -0800 Subject: Add dialer documentation. --- docs/nng_dialer_close.adoc | 56 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 docs/nng_dialer_close.adoc (limited to 'docs/nng_dialer_close.adoc') diff --git a/docs/nng_dialer_close.adoc b/docs/nng_dialer_close.adoc new file mode 100644 index 00000000..f4f5d76b --- /dev/null +++ b/docs/nng_dialer_close.adoc @@ -0,0 +1,56 @@ += nng_dialer_close(3) +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + +nng_listener_close - close listener + +== SYNOPSIS + +[source, c] +----------- +#include + +int nng_dialer_close(nng_dialer d); +----------- + +== DESCRIPTION + +The `nng_dialer_close()` function closes the listener _d_. +This also closes any pipe that has been created by the dialer. + +Once this function returns, the dialer _d_ and any of its resources +are deallocated. Therefore it is an error to attempt to access _d_ +after this function has returned. (Attempts to do so will result in +`NNG_ECLOSED` errors.) + +Dialers are implicitly closed when the socket they are associated with +is closed. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +`NNG_ECLOSED`:: Parameter _d_ does not refer to an open listener. + +== SEE ALSO + +<>, +<>, +<> +<>, +<> + +== COPYRIGHT + +{copyright} \ No newline at end of file -- cgit v1.2.3-70-g09d2