'\" t
.\"     Title: nng_ctx_set
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.23
.\"      Date: 2025-02-02
.\"    Manual: NNG Reference Manual
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "NNG_CTX_SET" "3" "2025-02-02" "\ \&" "NNG Reference Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
nng_ctx_set \- set context option
.SH "SYNOPSIS"
.sp
.if n .RS 4
.nf
.fam C
#include <nng/nng.h>

int nng_ctx_set(nng_ctx ctx, const char *opt, const void *val, size_t valsz);

int nng_ctx_set_bool(nng_ctx ctx, const char *opt, int bval);

int nng_ctx_set_int(nng_ctx ctx, const char *opt, int ival);

int nng_ctx_set_ms(nng_ctx ctx, const char *opt, nng_duration dur);

int nng_ctx_set_size(nng_ctx ctx, const char *opt, size_t z);

int nng_ctx_set_string(nng_ctx ctx, const char *opt, const char *str);

int nng_ctx_set_uint64(nng_ctx ctx, const char *opt, uint64_t u64);
.fam
.fi
.if n .RE
.SH "DESCRIPTION"
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
These functions are deprecated.  Please see nng_ctx_set.
.sp .5v
.RE
.sp

The \f(CRnng_ctx_set()\fP functions are used to configure options for
the context \fIctx\fP.
The actual options that may be configured in this way vary, and are
specified by \fIopt\fP.
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
Context options are protocol specific.
The details will be documented with the protocol.
.sp .5v
.RE
.SS "Forms"
.sp
The details of the type, size, and semantics of the option will depend
on the actual option, and will be documented with the option itself.
.sp
\f(CRnng_ctx_set()\fP
.RS 4
This function is untyped, and can be used to configure any arbitrary data.
The \fIval\fP pointer addresses the data to copy, and \fIvalsz\fP is the
size of the objected located at \fIval\fP.
.RE
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Tip
.ps -1
.br
.sp
It may be easier to use one of the typed forms of this function.
.sp .5v
.RE
.sp
\f(CRnng_ctx_set_bool()\fP
.RS 4
This function is for options which take a Boolean (\f(CRbool\fP).
The \fIbval\fP is passed to the option.
.RE
.sp
\f(CRnng_ctx_set_int()\fP
.RS 4
This function is for options which take an integer (\f(CRint\fP).
The \fIival\fP is passed to the option.
.RE
.sp
\f(CRnng_ctx_set_ms()\fP
.RS 4
This function is used to configure time durations (such as timeouts) using
type \f(CRnng_duration\fP.
The duration \fIdur\fP is an integer number of milliseconds.
.RE
.sp
\f(CRnng_ctx_set_size()\fP
.RS 4
This function is used to configure a size, \fIz\fP, typically for buffer sizes,
message maximum sizes, and similar options.
.RE
.sp
\f(CRnng_ctx_set_string()\fP
.RS 4
This function is used to pass configure a string, \fIstr\fP.
Strings passed this way must be legal UTF\-8 or ASCII strings, terminated
with a \f(CRNUL\fP (\f(CR\(rs0\fP) byte.
(Other constraints may apply as well, see the documentation for each option
for details.)
.RE
.sp
\f(CRnng_ctx_set_uint64()\fP
.RS 4
This function is used to configure a 64\-bit unsigned value, \fIu64\fP.
This is typically used for options related to identifiers, network numbers,
and similar.
.RE
.SH "RETURN VALUES"
.sp
These functions return 0 on success, and non\-zero otherwise.
.SH "ERRORS"
.sp
\f(CRNNG_ECLOSED\fP
.RS 4
Parameter \fIs\fP does not refer to an open socket.
.RE
.sp
\f(CRNNG_EINVAL\fP
.RS 4
The value being passed is invalid.
.RE
.sp
\f(CRNNG_ENOTSUP\fP
.RS 4
The option \fIopt\fP is not supported.
.RE
.sp
\f(CRNNG_EREADONLY\fP
.RS 4
The option \fIopt\fP is read\-only.
.RE
.sp
\f(CRNNG_ESTATE\fP
.RS 4
The socket is in an inappropriate state for setting this option.
.RE
.SH "SEE ALSO"
.sp
nng_ctx_get(3),
nng_socket_set(3),
nng_strerror(3),
nng_ctx(5),
nng_options(5),
nng_socket(5),
nng(7)