summaryrefslogtreecommitdiff
path: root/docs/ref/old/nng_pipe_getopt.adoc
blob: b413da24966a08626d21e508b24d90e5742655d5 (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_pipe_getopt

Get pipe option (deprecated).

### Synopsis

```c
#include <nng/nng.h>

int nng_pipe_getopt(nng_pipe p, const char *opt, void *val, size_t *valszp);
int nng_pipe_getopt_bool(nng_pipe p, const char *opt, bool *bvalp);
int nng_pipe_getopt_int(nng_pipe p, const char *opt, int *ivalp);
int nng_pipe_getopt_ms(nng_pipe p, const char *opt, nng_duration *durp);
int nng_pipe_getopt_ptr(nng_pipe p, const char *opt, void **ptr);
int nng_pipe_getopt_sockaddr(nng_pipe p, const char *opt, nng_sockaddr *sap);
int nng_pipe_getopt_string(nng_pipe p, const char *opt, char **strp);
int nng_pipe_getopt_size(nng_pipe p, const char *opt, size_t *zp);
int nng_pipe_getopt_uint64(nng_pipe p, const char *opt, uint64_t *u64p);
```

### Description

NOTE: These functions are deprecated.
They may not be present if the library was built with ((`NNG_ELIDE_DEPRECATED`)).

These deprecated functions have one-to-one modern equivalents with the same arguments and semantics, as follows:

[width=50%,]
|===
| Legacy Function | Modern Equivalent

| `nng_pipe_getopt` | `nng_pipe_get`
| `nng_pipe_getopt_bool`| `nng_pipe_get_bool`
| `nng_pipe_getopt_int`| `nng_pipe_get_int`
| `nng_pipe_getopt_ms`| `nng_pipe_get_ms`
| `nng_pipe_getopt_ptr` | `nng_pipe_get_ptr`
| `nng_pipe_getopt_size`| `nng_pipe_get_size`
| `nng_pipe_getopt_sockaddr` | `nng_pipe_get_addr`
| `nng_pipe_getopt_string`| `nng_pipe_get_string`
| `nng_pipe_getopt_uint64`| `nng_pipe_get_uint64`
|===

Please see the documentation for the modern equivalents for more detail.

### See Also

xref:../pipe/nng_pipe_get.adoc[nng_ctx_get]