summaryrefslogtreecommitdiff
path: root/docs/man/nng_ipc_register.3.adoc
blob: 64da4b00e18db846a022326a9d09f240da9f02c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
= nng_ipc_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_ipc_register - register ipc transport

== SYNOPSIS

[source,c]
----
#include <nng/transport/ipc/ipc.h>

int nng_ipc_register(void);
----

== DESCRIPTION

The `nng_ipc_register()` function registers the
((_ipc_ transport))(((transport, _ipc_))) 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_ipc.7.adoc[nng_ipc(5)],
xref:nng.7.adoc[nng(7)]