'\" t
.\"     Title: nng_tls_config_alloc
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.23
.\"      Date: 2025-02-02
.\"    Manual: NNG Reference Manual
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "NNG_TLS_CONFIG_ALLOC" "3tls" "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_tls_config_alloc \- allocate TLS configuration object
.SH "SYNOPSIS"
.sp
.if n .RS 4
.nf
.fam C
#include <nng/nng.h>
#include <nng/supplemental/tls/tls.h>

typedef enum nng_tls_mode {
    NNG_TLS_MODE_CLIENT,
    NNG_TLS_MODE_SERVER
} nng_tls_mode;

int nng_tls_config_alloc(nng_tls_config **cfgp, nng_tls_mode mode);
.fam
.fi
.if n .RE
.SH "DESCRIPTION"
.sp
The \f(CRnng_tls_config_alloc()\fP function creates a newly initialized
.URL "https://tools.ietf.org/html/rfc5246" "Transport Layer Security" ")"
configuration object, and stores a pointer to it in the value pointed
to by \fIcfgp\fP.
.sp
This object is initialized for use when acting as either a
client (\f(CRNNG_TLS_MODE_CLIENT\fP) or as a server (\f(CRNNG_TLS_MODE_SERVER\fP),
depending on the value of \fImode\fP.
.sp
A TLS object can be further modified by functions that set the security
keys used, peer certificates, protocol policies, and so forth.
.sp
A single TLS configuration object can be used with multiple TLS streams
or services.
The underlying system uses reference counting to ensure
that object is not inadvertently freed while in use.
.sp
A configuration object created with \f(CRnng_tls_config_alloc()\fP starts
with a reference count of one.
The reference count may be incremented using
\f(CRnng_tls_config_hold()\fP and may be
decremented with
\f(CRnng_tls_config_free()\fP.
.sp
Also note that a TLS configuration object becomes read\-only after it
is first used with a service.
After this points, attempts to apply
further changes to the configuration will result in \f(CRNNG_EBUSY\fP.
.SH "RETURN VALUES"
.sp
This function returns 0 on success, and non\-zero otherwise.
.SH "ERRORS"
.sp
\f(CRNNG_ENOMEM\fP
.RS 4
Insufficient memory is available.
.RE
.sp
\f(CRNNG_EINVAL\fP
.RS 4
An invalid \fImode\fP was specified.
.RE
.SH "SEE ALSO"
.sp
nng_strerror(3),
nng_tls_config_auth_mode(3tls),
nng_tls_config_ca_chain(3tls),
nng_tls_config_own_cert(3tls),
nng_tls_config_free(3tls),
nng_tls_config_hold(3tls),
nng_tls_config_server_name(3tls),
nng_tls_config(5),
nng(7)