diff options
| author | Garrett D'Amore <garrett@damore.org> | 2019-01-06 12:02:48 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2019-01-06 12:12:27 -0800 |
| commit | ff06de11cf5a953f47d22bd896f3860697c520c8 (patch) | |
| tree | d8c808c879648cc29dee3e65bded91932be4093a /docs/man/nng_tcp_peername.3tcp.adoc | |
| parent | 6d0027fae75e4810d66eb4c5817255ffa517e158 (diff) | |
| download | nng-ff06de11cf5a953f47d22bd896f3860697c520c8.tar.gz nng-ff06de11cf5a953f47d22bd896f3860697c520c8.tar.bz2 nng-ff06de11cf5a953f47d22bd896f3860697c520c8.zip | |
fixes #845 TCP public API doc updates
Diffstat (limited to 'docs/man/nng_tcp_peername.3tcp.adoc')
| -rw-r--r-- | docs/man/nng_tcp_peername.3tcp.adoc | 45 |
1 files changed, 0 insertions, 45 deletions
diff --git a/docs/man/nng_tcp_peername.3tcp.adoc b/docs/man/nng_tcp_peername.3tcp.adoc deleted file mode 100644 index c5f5ece6..00000000 --- a/docs/man/nng_tcp_peername.3tcp.adoc +++ /dev/null @@ -1,45 +0,0 @@ -= nng_tcp_peername(3tcp) -// -// 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_tcp_peername - get TCP peer socket address - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> -#include <nng/supplemental/tcp/tcp.h> - -int nng_tcp_peername(nng_tcp *conn, nng_sockaddr *sa); ----- - -== DESCRIPTION - -The `nng_tcp_peername()` is retrieves the TCP address of the remote -peer on the connection _conn_, and stores it in _sa_. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ECLOSED`:: The connection _conn_ is closed. - -== SEE ALSO - -[.text-left] -<<nng_tcp_sockname.3tcp#,nng_tcp_sockname(3tcp)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_tcp.5#,nng_tcp(5)>> |