components/cyrus-sasl/Solaris/usr/share/man/man3/sasl_set_mutex.3
author saurabh.vyas@oracle.com
Wed, 27 Jan 2016 09:13:52 -0800
changeset 5350 0bd2e97a57c6
parent 5055 9daf220c1a9a
child 5769 6303cfed086b
permissions -rw-r--r--
22599480 move mcollective to Ruby 2.1 22599526 move stomp to Ruby 2.1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5055
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     1
'\" te
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     2
.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     3
.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     4
.TH sasl_set_mutex 3SASL "22 Oct 2003" "SunOS 5.12" "Simple Authentication Security Layer Library Functions"
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     5
.SH NAME
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     6
sasl_set_mutex \- set the mutex lock functions used by the SASL library
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     7
.SH SYNOPSIS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     8
.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     9
.nf
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    10
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    11
#include <sasl/sasl.h>
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    12
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    13
\fBvoid\fR \fBsasl_set_mutex\fR(\fBsasl_mutex_alloc_t *\fR\fIa\fR, \fBsasl_mutex_lock_t *\fR\fIl\fR,
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    14
     \fBsasl_mutex_unlock_t *\fR\fIu\fR, \fBsasl_mutex_free_t *\fR\fIf\fR);
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    15
.fi
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    16
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    17
.SH DESCRIPTION
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    18
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    19
.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    20
Use the \fBsasl_set_mutex()\fR interface to set the mutex lock routines that the SASL library and plug-ins will use.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    21
.SH PARAMETERS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    22
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    23
.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    24
.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    25
.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    26
\fB\fIa\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    27
.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    28
.RS 5n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    29
.rt  
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    30
A pointer to the mutex lock allocation function
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    31
.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    32
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    33
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    34
.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    35
.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    36
.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    37
\fB\fIf\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    38
.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    39
.RS 5n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    40
.rt  
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    41
A pointer to the mutex free or destroy function
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    42
.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    43
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    44
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    45
.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    46
.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    47
.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    48
\fB\fIl\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    49
.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    50
.RS 5n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    51
.rt  
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    52
A pointer to the mutex lock function
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    53
.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    54
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    55
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    56
.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    57
.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    58
.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    59
\fB\fIu\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    60
.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    61
.RS 5n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    62
.rt  
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    63
A pointer to the mutex unlock function
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    64
.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    65
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    66
.SH RETURN VALUES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    67
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    68
.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    69
\fBsasl_set_mutex()\fR has no return values.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    70
.SH ATTRIBUTES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    71
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    72
.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    73
See \fBattributes\fR(5) for descriptions of the following attributes:
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    74
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    75
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    76
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    77
.TS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    78
tab() box;
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    79
cw(2.75i) |cw(2.75i) 
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    80
lw(2.75i) |lw(2.75i) 
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    81
.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    82
ATTRIBUTE TYPEATTRIBUTE VALUE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    83
_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    84
Availabilitysystem/library/security/libsasl
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    85
_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    86
Interface StabilityObsolete
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    87
_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    88
MT-LevelUnsafe
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    89
.TE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    90
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    91
.SH SEE ALSO
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    92
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    93
.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    94
\fBattributes\fR(5)
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    95
.SH NOTES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    96
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    97
.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    98
While most of \fBlibsasl\fR is MT-Safe, \fBsasl_set_*\fR modifies the global state and should be considered Unsafe.