Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_global_set_mutex.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_global_set_mutex" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_global_set_mutex \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "void gnutls_global_set_mutex(mutex_init_func " init ", mutex_deinit_func " deinit ", mutex_lock_func " lock ", mutex_unlock_func " unlock ");"
9 .SH ARGUMENTS
10 .IP "mutex_init_func init" 12
11 mutex initialization function
12 .IP "mutex_deinit_func deinit" 12
13 mutex deinitialization function
14 .IP "mutex_lock_func lock" 12
15 mutex locking function
16 .IP "mutex_unlock_func unlock" 12
17 mutex unlocking function
18 .SH "DESCRIPTION"
19 With this function you are allowed to override the default mutex
20 locks used in some parts of gnutls and dependent libraries. This function
21 should be used if you have complete control of your program and libraries.
22 Do not call this function from a library. Instead only initialize gnutls and
23 the default OS mutex locks will be used.
24
25 This function must be called before \fBgnutls_global_init()\fP.
26 .SH "REPORTING BUGS"
27 Report bugs to <bug-gnutls@gnu.org>.
28 GnuTLS home page: http://www.gnu.org/software/gnutls/
29 General help using GNU software: http://www.gnu.org/gethelp/
30 .SH COPYRIGHT
31 Copyright \(co 2008 Free Software Foundation.
32 .br
33 Copying and distribution of this file, with or without modification,
34 are permitted in any medium without royalty provided the copyright
35 notice and this notice are preserved.
36 .SH "SEE ALSO"
37 The full documentation for
38 .B gnutls
39 is maintained as a Texinfo manual.  If the
40 .B info
41 and
42 .B gnutls
43 programs are properly installed at your site, the command
44 .IP
45 .B info gnutls
46 .PP
47 should give you access to the complete manual.