summaryrefslogtreecommitdiffstats
path: root/doc/ssl/SSL_get_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_get_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_get_session.pod')
-rw-r--r--doc/ssl/SSL_get_session.pod48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/ssl/SSL_get_session.pod b/doc/ssl/SSL_get_session.pod
new file mode 100644
index 0000000000..0b3f50af42
--- /dev/null
+++ b/doc/ssl/SSL_get_session.pod
@@ -0,0 +1,48 @@
+=pod
+
+=head1 NAME
+
+SSL_get_session - Retrieve SSL session data
+
+=head1 SYNOPSIS
+
+ #include <openssl/ssl.h>
+
+ SSL_SESSION *SSL_get_session(SSL *ssl);
+ SSL_SESSION *SSL_get0_session(SSL *ssl);
+ SSL_SESSION *SSL_get1_session(SSL *ssl);
+
+=head1 DESCRIPTION
+
+SSL_get_session() returns a pointer to the SSL session actually used in
+B<ssl>. The reference count of the SSL session is not incremented, so
+that the pointer can become invalid when the B<ssl> is freed and
+SSL_SESSION_free() is implicitly called.
+
+SSL_get0_session() is the same as SSL_get_session().
+
+SSL_get1_session() is the same as SSL_get_session(), but the reference
+count of the SSL session is incremented by one.
+
+=head1 RETURN VALUES
+
+The following return values can occur:
+
+=over 4
+
+=item NULL
+
+There is no session available in B<ssl>.
+
+=item Pointer to an SSL
+
+The return value points to the data of an SSL session.
+
+=back
+
+=head1 SEE ALSO
+
+L<ssl(3)|ssl(3)>, L<SSL_free(3)|SSL_free(3)>,
+L<SSL_SESSION_free(3)|SSL_SESSION_free(3)>
+
+=cut