diff options
Diffstat (limited to 'docs/man/nng_ws_register.3.adoc')
| -rw-r--r-- | docs/man/nng_ws_register.3.adoc | 47 |
1 files changed, 0 insertions, 47 deletions
diff --git a/docs/man/nng_ws_register.3.adoc b/docs/man/nng_ws_register.3.adoc deleted file mode 100644 index 7a9cc1f3..00000000 --- a/docs/man/nng_ws_register.3.adoc +++ /dev/null @@ -1,47 +0,0 @@ -= nng_ws_register(3) -// -// Copyright 2021 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_ws_register - register WebSocket transport - -== SYNOPSIS - -[source,c] ----- -#include <nng/transport/websocket/ws.h> - -int nng_ws_register(void); ----- - -== DESCRIPTION - -The `nng_ws_register()` function registers the -((_ws_ transport))(((transport, _ws_))) for use. - -NOTE: This function is deprecated, and may be removed from a future release. -It is no longer necessary to explicitly register transports. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -[horizontal] -`NNG_ENOMEM`:: Insufficient memory is available. -`NNG_ENOTSUP`:: The transport is not supported. - -== SEE ALSO - -[.text-left] -xref:nng_ws.7.adoc[nng_ws(7)], -xref:nng.7.adoc[nng(7)] |