- update OpenSSL to 0.9.8
[dragonfly.git] / secure / lib / libssl / man / SSL_get_session.3
index 1d936f9..020fee2 100644 (file)
@@ -1,8 +1,7 @@
-.\" Automatically generated by Pod::Man version 1.15
-.\" Wed Feb 19 16:47:47 2003
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
 .\"
 .\" Standard preamble:
-.\" ======================================================================
+.\" ========================================================================
 .de Sh \" Subsection heading
 .br
 .if t .Sp
 .if t .sp .5v
 .if n .sp
 ..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
 .de Vb \" Begin verbatim text
 .ft CW
 .nf
 ..
 .de Ve \" End verbatim text
 .ft R
-
 .fi
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 .\" double quote, and \*(R" will give a right double quote.  | will give a
-.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
-.\" to do unbreakable dashes and therefore won't be available.  \*(C` and
-.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
+.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
 .tr \(*W-|\(bv\*(Tr
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds R" ''
 'br\}
 .\"
-.\" If the F register is turned on, we'll generate index entries on stderr
-.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
-.\" index entries marked with X<> in POD.  Of course, you'll have to process
-.\" the output yourself in some meaningful fashion.
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
 .if \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 .    rr F
 .\}
 .\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it
-.\" makes way too many mistakes in technical documents.
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
 .hy 0
 .if n .na
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
-.bd B 3
 .    \" fudge factors for nroff and troff
 .if n \{\
 .    ds #H 0
 .    ds Ae AE
 .\}
 .rm #[ #] #H #V #F C
-.\" ======================================================================
+.\" ========================================================================
 .\"
 .IX Title "SSL_get_session 3"
-.TH SSL_get_session 3 "0.9.7a" "2003-02-19" "OpenSSL"
-.UC
+.TH SSL_get_session 3 "2005-07-06" "0.9.8" "OpenSSL"
 .SH "NAME"
-SSL_get_session \- retrieve \s-1TLS/SSL\s0 session data
+SSL_get_session \- retrieve TLS/SSL session data
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 .Vb 1
 \& #include <openssl/ssl.h>
 .Ve
+.PP
 .Vb 3
-\& SSL_SESSION *SSL_get_session(SSL *ssl);
-\& SSL_SESSION *SSL_get0_session(SSL *ssl);
+\& SSL_SESSION *SSL_get_session(const SSL *ssl);
+\& SSL_SESSION *SSL_get0_session(const SSL *ssl);
 \& SSL_SESSION *SSL_get1_session(SSL *ssl);
 .Ve
 .SH "DESCRIPTION"
@@ -169,16 +160,16 @@ connection without a new handshake.
 .PP
 \&\fISSL_get0_session()\fR returns a pointer to the actual session. As the
 reference counter is not incremented, the pointer is only valid while
-the connection is in use. If SSL_clear(3) or
-SSL_free(3) is called, the session may be removed completely
+the connection is in use. If \fISSL_clear\fR\|(3) or
+\&\fISSL_free\fR\|(3) is called, the session may be removed completely
 (if considered bad), and the pointer obtained will become invalid. Even
 if the session is valid, it can be removed at any time due to timeout
-during SSL_CTX_flush_sessions(3).
+during \fISSL_CTX_flush_sessions\fR\|(3).
 .PP
 If the data is to be kept, \fISSL_get1_session()\fR will increment the reference
 count, so that the session will not be implicitly removed by other operations
 but stays in memory. In order to remove the session
-SSL_SESSION_free(3) must be explicitly called once
+\&\fISSL_SESSION_free\fR\|(3) must be explicitly called once
 to decrement the reference count again.
 .PP
 \&\s-1SSL_SESSION\s0 objects keep internal link information about the session cache
@@ -189,14 +180,14 @@ from this \s-1SSL_CTX\s0 object).
 .SH "RETURN VALUES"
 .IX Header "RETURN VALUES"
 The following return values can occur:
-.Ip "\s-1NULL\s0" 4
+.IP "\s-1NULL\s0" 4
 .IX Item "NULL"
 There is no session available in \fBssl\fR.
-.Ip "Pointer to an \s-1SSL\s0" 4
+.IP "Pointer to an \s-1SSL\s0" 4
 .IX Item "Pointer to an SSL"
 The return value points to the data of an \s-1SSL\s0 session.
 .SH "SEE ALSO"
 .IX Header "SEE ALSO"
-ssl(3), SSL_free(3),
-SSL_clear(3),
-SSL_SESSION_free(3)
+\&\fIssl\fR\|(3), \fISSL_free\fR\|(3),
+\&\fISSL_clear\fR\|(3),
+\&\fISSL_SESSION_free\fR\|(3)