summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2016-07-07 23:55:34 +0200
committerRichard Levitte <levitte@openssl.org>2016-07-25 17:33:41 +0200
commit3067095e8a2cca3d33fa0af77788bc45da68b76b (patch)
treed51b3bec5c0b3e2073946a92cb2f87a30bb474ec /doc
parentc1b4fa6ded697235a48ffb78c8145d08df8a8513 (diff)
Add X509_STORE lock and unlock functions
Since there are a number of function pointers in X509_STORE that might lead to user code, it makes sense for them to be able to lock the store while they do their work. Reviewed-by: Rich Salz <rsalz@openssl.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/crypto/X509_STORE_new.pod14
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/crypto/X509_STORE_new.pod b/doc/crypto/X509_STORE_new.pod
index 0d0656f2de..f7a5c81416 100644
--- a/doc/crypto/X509_STORE_new.pod
+++ b/doc/crypto/X509_STORE_new.pod
@@ -2,7 +2,8 @@
=head1 NAME
-X509_STORE_new, X509_STORE_up_ref, X509_STORE_free - X509_STORE allocation and freeing functions
+X509_STORE_new, X509_STORE_up_ref, X509_STORE_free, X509_STORE_lock,
+X509_STORE_unlock - X509_STORE allocation, freeing and locking functions
=head1 SYNOPSIS
@@ -10,6 +11,8 @@ X509_STORE_new, X509_STORE_up_ref, X509_STORE_free - X509_STORE allocation and f
X509_STORE *X509_STORE_new(void);
void X509_STORE_free(X509_STORE *v);
+ int X509_STORE_lock(X509_STORE *v);
+ int X509_STORE_unlock(X509_STORE *v);
int X509_STORE_up_ref(X509_STORE *v);
=head1 DESCRIPTION
@@ -19,13 +22,17 @@ The X509_STORE_new() function returns a new X509_STORE.
X509_STORE_up_ref() increments the reference count associated with the
X509_STORE object.
+X509_STORE_lock() locks the store from modification by other threads,
+X509_STORE_unlock() locks it.
+
X509_STORE_free() frees up a single X509_STORE object.
=head1 RETURN VALUES
X509_STORE_new() returns a newly created X509_STORE or NULL if the call fails.
-X509_STORE_up_ref() returns 1 for success and 0 for failure.
+X509_STORE_up_ref(), X509_STORE_lock() and X509_STORE_unlock() return
+1 for success and 0 for failure.
X509_STORE_free() does not return values.
@@ -36,7 +43,8 @@ L<X509_STORE_get0_param(3)>
=head1 HISTORY
-The B<X509_STORE_up_ref> function was added in OpenSSL 1.1.0
+The X509_STORE_up_ref(), X509_STORE_lock() and X509_STORE_unlock()
+functions were added in OpenSSL 1.1.0
=head1 COPYRIGHT