From c66ef25c7dfd0c2a3c4a8aa8eea223fa186c2311 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Sat, 14 Apr 2018 11:50:43 -0700
Subject: fixes #303 Flesh out compatible API docs

---
 docs/man/nn_connect.3compat.adoc | 65 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 docs/man/nn_connect.3compat.adoc

(limited to 'docs/man/nn_connect.3compat.adoc')

diff --git a/docs/man/nn_connect.3compat.adoc b/docs/man/nn_connect.3compat.adoc
new file mode 100644
index 00000000..add14060
--- /dev/null
+++ b/docs/man/nn_connect.3compat.adoc
@@ -0,0 +1,65 @@
+= nn_connect(3compat)
+//
+// 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
+
+nn_connect - connect to remote peer (compatible API)
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nanomsg/nn.h>
+
+int nn_connect(int sock, const char *url)
+----
+
+== DESCRIPTION
+
+The `nn_connect()` function arranges for the socket _sock_ to
+inititate connection to a peer at the address specified by _url_.
+An "`endpoint identifier`" for this socket's association with the _url_ is
+returned to the caller on success.
+This ID can be used with `<<nn_shutdown.3compat#,nn_shutdown()>>`` to
+"`unbind`" the socket from the address at _url_.
+
+NOTE: This function is provided for API
+<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
+Consider using the relevant <<libnng.3#,modern API>> instead.
+
+NOTE: The connect operation is performed asynchronously, and may not have
+completed before this function returns control to the caller.
+
+IMPORTANT: Only transports supported by legacy _libnanomsg_ may be
+used with this function.
+In particular, only the schemes `tcp://`, `ipc://`, `inproc://`, and `ws://` are
+supported with this function.
+(Use the <<libnng.3#,modern API>> to use other schemes.)
+
+== RETURN VALUES
+
+This function returns a positive identifier success, and -1 on error.
+
+== ERRORS
+
+[horizontal]
+`ECONNREFUSED`:: The connection attempt was refused.
+`EBADF`:: The socket _sock_ is not open.
+`EINVAL`:: An invalid _url_ was supplied.
+
+== SEE ALSO
+
+<<nn_bind.3compat#,nn_bind(3compat)>>,
+<<nn_errno.3compat#,nn_errno(3compat)>>,
+<<nn_shutdown.3compat#,nn_shutdown(3compat)>>,
+<<nn_socket.3compat#,nn_socket(3compat)>>,
+<<nng_compat.3compat#,nn_compat(3compat)>>,
+<<nng.7#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2

