X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=doc%2Fssl%2FSSL_set_session.pod;h=5f54714ad86a633c4f0540357ffcb2593c17a174;hb=b764f82c645639ce794f28ef92e749066dd2caa6;hp=b1162ba61a9c91b22aa31726eda07006ec63a8ea;hpb=cc99526db1ee5b948736f6b07958a786fec1240b;p=oweals%2Fopenssl.git diff --git a/doc/ssl/SSL_set_session.pod b/doc/ssl/SSL_set_session.pod index b1162ba61a..5f54714ad8 100644 --- a/doc/ssl/SSL_set_session.pod +++ b/doc/ssl/SSL_set_session.pod @@ -2,25 +2,34 @@ =head1 NAME -SSL_set_session - Set an SSL session to be used during SSL connect +SSL_set_session - set a TLS/SSL session to be used during TLS/SSL connect =head1 SYNOPSIS #include - int *SSL_set_session(SSL *ssl, SSL_SESSION *session); + int SSL_set_session(SSL *ssl, SSL_SESSION *session); =head1 DESCRIPTION -SSL_set_session() sets B to be used, when the SSL connection -is to be established. SSL_set_session() is only useful for SSL clients. +SSL_set_session() sets B to be used when the TLS/SSL connection +is to be established. SSL_set_session() is only useful for TLS/SSL clients. When the session is set, the reference count of B is incremented by 1. If the session is not reused, the reference count is decremented -again during SSL_connect(). +again during SSL_connect(). Whether the session was reused can be queried +with the L call. If there is already a session set inside B (because it was set with SSL_set_session() before or because the same B was already used for -a connection) SSL_SESSION_free() will be called for that session. +a connection), SSL_SESSION_free() will be called for that session. + +=head1 NOTES + +SSL_SESSION objects keep internal link information about the session cache +list, when being inserted into one SSL_CTX object's session cache. +One SSL_SESSION object, regardless of its reference count, must therefore +only be used with one SSL_CTX object (and the SSL objects created +from this SSL_CTX object). =head1 RETURN VALUES @@ -30,7 +39,7 @@ The following return values can occur: =item 0 -The operation failed, check the error stack to find out the reason. +The operation failed; check the error stack to find out the reason. =item 1 @@ -40,6 +49,9 @@ The operation succeeded. =head1 SEE ALSO -L, L +L, L, +L, +L, +L =cut