components/cyrus-sasl/Solaris/usr/share/man/man3/sasl_set_mutex.3
changeset 5055 9daf220c1a9a
child 5769 6303cfed086b
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/components/cyrus-sasl/Solaris/usr/share/man/man3/sasl_set_mutex.3	Tue Nov 03 14:27:41 2015 -0800
@@ -0,0 +1,98 @@
+'\" te
+.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
+.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
+.TH sasl_set_mutex 3SASL "22 Oct 2003" "SunOS 5.12" "Simple Authentication Security Layer Library Functions"
+.SH NAME
+sasl_set_mutex \- set the mutex lock functions used by the SASL library
+.SH SYNOPSIS
+.LP
+.nf
+\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
+#include <sasl/sasl.h>
+
+\fBvoid\fR \fBsasl_set_mutex\fR(\fBsasl_mutex_alloc_t *\fR\fIa\fR, \fBsasl_mutex_lock_t *\fR\fIl\fR,
+     \fBsasl_mutex_unlock_t *\fR\fIu\fR, \fBsasl_mutex_free_t *\fR\fIf\fR);
+.fi
+
+.SH DESCRIPTION
+.sp
+.LP
+Use the \fBsasl_set_mutex()\fR interface to set the mutex lock routines that the SASL library and plug-ins will use.
+.SH PARAMETERS
+.sp
+.ne 2
+.mk
+.na
+\fB\fIa\fR\fR
+.ad
+.RS 5n
+.rt  
+A pointer to the mutex lock allocation function
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIf\fR\fR
+.ad
+.RS 5n
+.rt  
+A pointer to the mutex free or destroy function
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIl\fR\fR
+.ad
+.RS 5n
+.rt  
+A pointer to the mutex lock function
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIu\fR\fR
+.ad
+.RS 5n
+.rt  
+A pointer to the mutex unlock function
+.RE
+
+.SH RETURN VALUES
+.sp
+.LP
+\fBsasl_set_mutex()\fR has no return values.
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i) 
+lw(2.75i) |lw(2.75i) 
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+Availabilitysystem/library/security/libsasl
+_
+Interface StabilityObsolete
+_
+MT-LevelUnsafe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBattributes\fR(5)
+.SH NOTES
+.sp
+.LP
+While most of \fBlibsasl\fR is MT-Safe, \fBsasl_set_*\fR modifies the global state and should be considered Unsafe.