summaryrefslogtreecommitdiffstats
path: root/doc/ssl/SSL_set_session.pod
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2000-09-14 13:11:56 +0000
committerRichard Levitte <levitte@openssl.org>2000-09-14 13:11:56 +0000
commitcc99526db1ee5b948736f6b07958a786fec1240b (patch)
tree24c07af7e38f014e2baa02ba5ce454e24d64211f /doc/ssl/SSL_set_session.pod
parent72660f5f15fcd71215193f993dd95da0d130168a (diff)
Add a number of documentation files, mostly for SSL routines, but also
for a few BIO routines. Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
Diffstat (limited to 'doc/ssl/SSL_set_session.pod')
-rw-r--r--doc/ssl/SSL_set_session.pod45
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/ssl/SSL_set_session.pod b/doc/ssl/SSL_set_session.pod
new file mode 100644
index 0000000000..b1162ba61a
--- /dev/null
+++ b/doc/ssl/SSL_set_session.pod
@@ -0,0 +1,45 @@
+=pod
+
+=head1 NAME
+
+SSL_set_session - Set an SSL session to be used during SSL connect
+
+=head1 SYNOPSIS
+
+ #include <openssl/ssl.h>
+
+ int *SSL_set_session(SSL *ssl, SSL_SESSION *session);
+
+=head1 DESCRIPTION
+
+SSL_set_session() sets B<session> to be used, when the SSL connection
+is to be established. SSL_set_session() is only useful for SSL clients.
+When the session is set, the reference count of B<session> is incremented
+by 1. If the session is not reused, the reference count is decremented
+again during SSL_connect().
+
+If there is already a session set inside B<ssl> (because it was set with
+SSL_set_session() before or because the same B<ssl> was already used for
+a connection) SSL_SESSION_free() will be called for that session.
+
+=head1 RETURN VALUES
+
+The following return values can occur:
+
+=over 4
+
+=item 0
+
+The operation failed, check the error stack to find out the reason.
+
+=item 1
+
+The operation succeeded.
+
+=back
+
+=head1 SEE ALSO
+
+L<ssl(3)|ssl(3)>, L<SSL_SESSION_free(3)|SSL_SESSION_free(3)>
+
+=cut