aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_server_hold.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-25 17:56:55 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-25 17:56:55 -0800
commit87795b46f2bc732bd11067805709161bdc00d6b6 (patch)
tree892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_http_server_hold.adoc
parent545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff)
downloadnng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz
nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2
nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip
More man page reorganization.
Man pages need special handling, and we can have other kinds of documentation like initial starting guides, etc., which would have different processing applied. So lets move them off into their own directory.
Diffstat (limited to 'docs/nng_http_server_hold.adoc')
-rw-r--r--docs/nng_http_server_hold.adoc62
1 files changed, 0 insertions, 62 deletions
diff --git a/docs/nng_http_server_hold.adoc b/docs/nng_http_server_hold.adoc
deleted file mode 100644
index 61e5b068..00000000
--- a/docs/nng_http_server_hold.adoc
+++ /dev/null
@@ -1,62 +0,0 @@
-= nng_http_server_hold(3)
-//
-// 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_http_server_hold - get and hold HTTP server instance
-
-== SYNOPSIS
-
-[source, c]
------------
-#include <nng/nng.h>
-#include <nng/supplemental/http/http.h>
-
-int nng_http_server_hold(nng_http_server **serverp, const nng_url *url);
------------
-
-== DESCRIPTION
-
-The `nng_http_server_hold()` acquires an instance of an HTTP server suitable
-for use in serving the URL identified by _url_, and stores a pointer to it
-at the location pointed to by _serverp_.
-
-This function first looks to see if an existing HTTP server instance exists,
-that is suitable for this. If so, it increments the reference count on it
-and uses that. Otherwise, it will attempt to create a new server instance
-with an initial reference count of one (1).
-
-The server instance is not started, and can have additional configuration
-applied to it before it is later started with
-<<nng_http_server_start#,nng_http_server_start(3)>>.
-
-NOTE: The URL matching logic in determining servers is unable to distinguish
-between different aliases for the same local IP address. This may create
-problems when using URLs for virtual hosting. It is recommended to use
-canonical IP addresses or names in the _url_ to avoid confusion.
-
-== RETURN VALUES
-
-This function returns 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-`NNG_ENOMEM`:: Insufficient free memory exists.
-`NNG_ENOTSUP`:: HTTP not supported.
-
-== SEE ALSO
-
-<<nng_http_server_add_handler#,nng_http_server_add_handler(3)>>,
-<<nng_http_server_release#,nng_http_server_release(3)>>,
-<<nng_http_server_stop#,nng_http_server_stop(3)>>,
-<<nng_url_parse#,nng_url_parse(3)>>
-<<nng_strerror#,nng_strerror(3)>>,
-<<nng#,nng(7)>>