summaryrefslogtreecommitdiff
path: root/docs/man/nng_socket_raw.3.adoc
blob: 594843b9f23779f9dcd418fdbd1717b099af7932 (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
= nng_socket_raw(3)
//
// Copyright 2024 Staysail Systems, Inc. <info@staysail.tech>
//
// 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_socket_raw - return whether socket is cooked or raw

== SYNOPSIS

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

int nng_socket_raw(nng_socket s, bool *raw);
----

== DESCRIPTION

The `nng_socket_raw()` function stores `true` in _raw_ if the socket is in raw mode,
otherwise it stores `false`.

TIP: This function should be used in place of the `NNG_OPT_RAW` option in new code.

== RETURN VALUES

This function returns zero on success, or an error if the socket is invalid.

== ERRORS

[horizontal]
`NNG_ECLOSED`:: Parameter _s_ does not refer to an open socket.

== SEE ALSO

[.text-left]
xref:nng_socket.5.adoc[nng_socket(5)],
xref:nng.7.adoc[nng(7)]