From ff06de11cf5a953f47d22bd896f3860697c520c8 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 6 Jan 2019 12:02:48 -0800 Subject: fixes #845 TCP public API doc updates --- docs/man/nng_tcp_peername.3tcp.adoc | 45 ------------------------------------- 1 file changed, 45 deletions(-) delete mode 100644 docs/man/nng_tcp_peername.3tcp.adoc (limited to 'docs/man/nng_tcp_peername.3tcp.adoc') 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. -// Copyright 2018 Capitar IT Group BV -// -// 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 -#include - -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] -<>, -<>, -<> -- cgit v1.2.3-70-g09d2