doompanning/external/nng/docs/man/nng_mtx_free.3supp.adoc

44 lines
857 B
Text
Raw Normal View History

= nng_mtx_free(3supp)
//
// 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_mtx_free - free mutex
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
#include <nng/supplemental/util/platform.h>
void nng_mtx_free(nng_mtx *mtx);
----
== DESCRIPTION
The `nng_mtx_free()` function frees the mutex _mtx_.
The mutex must not be locked when this function is called.
== RETURN VALUES
None.
== ERRORS
None.
== SEE ALSO
[.text-left]
xref:nng_mtx_alloc.3supp.adoc[nng_mtx_alloc(3supp)],
xref:nng.7.adoc[nng(7)]