summaryrefslogtreecommitdiff
path: root/docs/man/nng_stat_child.3.adoc
blob: c77e7135e24815bf684c8b53adf4f866b52f3552 (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
48
49
50
51
= nng_version(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_stat_child - get child statistic

== SYNOPSIS

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

typedef struct nng_stat nng_stat;

nng_stat *nng_stat_child(nng_stat *parent);
----

== DESCRIPTION

The `nng_stat_child()` function returns the first child statistic of the
statistic _parent_.
If no children are present, then `NULL` is returned.

TIP: Only statistics with type (see `<<nng_stat_type.3#,nng_stat_type()>>`)
of `NNG_STAT_SCOPE` will have children.

== RETURN VALUES

The first child statistic of _parent_, or NULL if _parent_ has no children.

== ERRORS

None.

== SEE ALSO

[.text-left]
<<libnng.3#,libnng(3)>>,
<<nng_stat_next.3#,nng_stat_next(3)>>,
<<nng_stats_get.3#,nng_stats_get(3)>>,
<<nng_stat.5#,nng_stat(5)>>,
<<nng.7#,nng(7)>>