diff options
| author | Garrett D'Amore <garrett@damore.org> | 2020-06-18 19:19:06 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2020-06-18 19:19:06 -0700 |
| commit | dbc61a5038cacc516a49d00a59a669e2617cff51 (patch) | |
| tree | 2b63b03499af29eff7b9c76e352366223ddee1ce /docs/man/nn_shutdown.3compat.adoc | |
| parent | 2236819226e579058d9f9fd67f3d684630a40634 (diff) | |
| download | nng-dbc61a5038cacc516a49d00a59a669e2617cff51.tar.gz nng-dbc61a5038cacc516a49d00a59a669e2617cff51.tar.bz2 nng-dbc61a5038cacc516a49d00a59a669e2617cff51.zip | |
Language cleanups in the documentation.
Mostly this is removal of the smart quotes, which were
over-used, and misused, and could have been mistaken to
be pejorative. A few other minor nits were fixed while here.
Diffstat (limited to 'docs/man/nn_shutdown.3compat.adoc')
| -rw-r--r-- | docs/man/nn_shutdown.3compat.adoc | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/man/nn_shutdown.3compat.adoc b/docs/man/nn_shutdown.3compat.adoc index eb9efd24..06a5cd5a 100644 --- a/docs/man/nn_shutdown.3compat.adoc +++ b/docs/man/nn_shutdown.3compat.adoc @@ -1,6 +1,6 @@ = nn_shutdown(3compat) // -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2020 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 @@ -24,11 +24,11 @@ int nn_shutdown(int sock, int ep) == DESCRIPTION -The `nn_shutdown()` shuts down the "`endpoint`" _ep_ on the socket _sock_. +The `nn_shutdown()` shuts down the endpoint _ep_, which is either a listener or +a dialer) on the socket _sock_. This will stop the socket from either accepting new connections, or establishing old ones. -Additionally, any established connections associated with _ep_ will be -closed. +Additionally, any established connections associated with _ep_ will be closed. NOTE: This function is provided for API xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_. |
