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_socket.3compat.adoc | 77 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 docs/man/nn_socket.3compat.adoc

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

diff --git a/docs/man/nn_socket.3compat.adoc b/docs/man/nn_socket.3compat.adoc
new file mode 100644
index 00000000..33bb1626
--- /dev/null
+++ b/docs/man/nn_socket.3compat.adoc
@@ -0,0 +1,77 @@
+= nn_socket(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_socket - create socket (compatible API)
+
+== SYNOPSIS
+
+[source,c]
+----
+#include <nanomsg/nn.h>
+
+int nn_socket(int af, int proto);
+----
+
+== DESCRIPTION
+
+The `nn_socket()` function creates socket using the address family _af_ and
+protocol _proto_ and returns it.
+
+NOTE: This function is provided for API
+<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
+Consider using the relevant <<libnng.3#,modern API>> instead.
+
+IMPORTANT: Mixing the compatibility API and the modern API is not supported
+on a given socket.
+
+NOTE: Some protocols, transports, and features are only available in the modern API.
+
+The address family _af_ can be one of two values:
+
+[horizontal]
+`AF_SP`:: Normal socket.
+`AF_SP_RAW`:: <<nng.7#raw_mode,"`Raw mode`">> socket.
+
+The protocol indicates the protocol to be used when creating the socket.
+The following protocols are defined:
+
+[horizontal]
+`NN_PAIR`:: <<nng_pair.7#,Pair>> protocol.
+`NN_PUB`:: <<nng_pub.7#,Publisher>> protocol.
+`NN_SUB`:: <<nng_sub.7#,Subscriber>> protocol.
+`NN_REQ`:: <<nng_req.7#,Requestor>> protocol.
+`NN_REP`:: <<nng_rep.7#,Replier>> protocol.
+`NN_PUSH`:: <<nng_push.7#,Push>> protocol.
+`NN_PULL`:: <<nng_pull.7#,Pull>> protocol.
+`NN_SURVEYOR`:: <<nng_surveyor.7#,Surveyor>> protocol.
+`NN_RESPONDENT`:: <<nng_respondent.7#,Respondent>> protocol.
+`NN_BUS`:: <<nng_bus.7#,Bus>> protocol.
+
+== RETURN VALUES
+
+This function returns a valid socket number on success, and -1 on failure.
+
+== ERRORS
+
+[horizontal]
+`ENOMEM`:: Insufficient memory is available.
+`ENOTSUP`:: The protocol is not supported.
+`ETERM`:: The library is shutting down.
+
+== SEE ALSO
+
+<<nng_socket.5#,nng_socket(5)>>,
+<<nn_close.3compat#,nn_close(3compat)>>,
+<<nn_errno.3compat#,nn_errno(3compat)>>,
+<<nng_compat.3compat#,nng_compat(3compat)>>,
+<<nng.7#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2

