threads.pod 1.8 KB
Newer Older
U
Ulf Möller 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
=pod

=head1 NAME

CRYPTO_set_locking_callback, CRYPTO_set_id_callback - OpenSSL thread support

=head1 SYNOPSIS

 #include <openssl/crypto.h>

 void CRYPTO_set_locking_callback(void (*locking_function)(int mode,
        int n, const char *file, int line));

 void CRYPTO_set_id_callback(unsigned long (*id_function)(void));

U
Ulf Möller 已提交
16 17
 int CRYPTO_num_locks(void);

U
Ulf Möller 已提交
18 19 20 21 22
=head1 DESCRIPTION

OpenSSL can safely be used in multi-threaded applications provided
that two callback functions are set.

U
Ulf Möller 已提交
23
locking_function(int mode, int n, const char *file, int line) is
U
Ulf Möller 已提交
24 25 26
needed to perform locking on shared data stuctures. Multi-threaded
applications will crash at random if it is not set.

U
Ulf Möller 已提交
27
locking_function() must be able to handle up to CRYPTO_num_locks()
U
Ulf Möller 已提交
28
different mutex locks. It sets the B<n>-th lock if B<mode> &
U
Ulf Möller 已提交
29 30 31 32 33 34 35
B<CRYPTO_LOCK>, and releases it otherwise.

B<file> and B<line> are the file number of the function setting the
lock. They can be useful for debugging.

id_function(void) is a function that returns a thread ID. It is not
needed on Windows nor on platforms where getpid() returns a different
36
ID for each thread (most notably Linux).
U
Ulf Möller 已提交
37

38
=head1 RETURN VALUES
U
Ulf Möller 已提交
39 40 41 42

CRYPTO_num_locks() returns the required number of locks.
The other functions return no values.

43
=head1 NOTE
U
Ulf Möller 已提交
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

You can find out if OpenSSL was configured with thread support:

 #define OPENSSL_THREAD_DEFINES
 #include <openssl/opensslconf.h>
 #if defined(THREADS)
   // thread support enabled
 #else
   // no thread support
 #endif

=head1 EXAMPLES

B<crypto/threads/mttest.c> shows examples of the callback functions on
Solaris, Irix and Win32.

=head1 HISTORY

CRYPTO_set_locking_callback() and CRYPTO_set_id_callback() are
available in all versions of SSLeay and OpenSSL.
U
Ulf Möller 已提交
64
CRYPTO_num_locks() was added in OpenSSL 0.9.4.
U
Ulf Möller 已提交
65 66 67 68 69 70

=head1 SEE ALSO

L<crypto(3)|crypto(3)>

=cut