diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_CTX_sess_number.3')
| -rw-r--r-- | src/lib/libssl/doc/SSL_CTX_sess_number.3 | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_CTX_sess_number.3 b/src/lib/libssl/doc/SSL_CTX_sess_number.3 new file mode 100644 index 0000000000..862576ca50 --- /dev/null +++ b/src/lib/libssl/doc/SSL_CTX_sess_number.3 | |||
| @@ -0,0 +1,101 @@ | |||
| 1 | .Dd $Mdocdate: October 12 2014 $ | ||
| 2 | .Dt SSL_CTX_SESS_NUMBER 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm SSL_CTX_sess_number , | ||
| 6 | .Nm SSL_CTX_sess_connect , | ||
| 7 | .Nm SSL_CTX_sess_connect_good , | ||
| 8 | .Nm SSL_CTX_sess_connect_renegotiate , | ||
| 9 | .Nm SSL_CTX_sess_accept , | ||
| 10 | .Nm SSL_CTX_sess_accept_good , | ||
| 11 | .Nm SSL_CTX_sess_accept_renegotiate , | ||
| 12 | .Nm SSL_CTX_sess_hits , | ||
| 13 | .Nm SSL_CTX_sess_cb_hits , | ||
| 14 | .Nm SSL_CTX_sess_misses , | ||
| 15 | .Nm SSL_CTX_sess_timeouts , | ||
| 16 | .Nm SSL_CTX_sess_cache_full | ||
| 17 | .Nd obtain session cache statistics | ||
| 18 | .Sh SYNOPSIS | ||
| 19 | .In openssl/ssl.h | ||
| 20 | .Ft long | ||
| 21 | .Fn SSL_CTX_sess_number "SSL_CTX *ctx" | ||
| 22 | .Ft long | ||
| 23 | .Fn SSL_CTX_sess_connect "SSL_CTX *ctx" | ||
| 24 | .Ft long | ||
| 25 | .Fn SSL_CTX_sess_connect_good "SSL_CTX *ctx" | ||
| 26 | .Ft long | ||
| 27 | .Fn SSL_CTX_sess_connect_renegotiate "SSL_CTX *ctx" | ||
| 28 | .Ft long | ||
| 29 | .Fn SSL_CTX_sess_accept "SSL_CTX *ctx" | ||
| 30 | .Ft long | ||
| 31 | .Fn SSL_CTX_sess_accept_good "SSL_CTX *ctx" | ||
| 32 | .Ft long | ||
| 33 | .Fn SSL_CTX_sess_accept_renegotiate "SSL_CTX *ctx" | ||
| 34 | .Ft long | ||
| 35 | .Fn SSL_CTX_sess_hits "SSL_CTX *ctx" | ||
| 36 | .Ft long | ||
| 37 | .Fn SSL_CTX_sess_cb_hits "SSL_CTX *ctx" | ||
| 38 | .Ft long | ||
| 39 | .Fn SSL_CTX_sess_misses "SSL_CTX *ctx" | ||
| 40 | .Ft long | ||
| 41 | .Fn SSL_CTX_sess_timeouts "SSL_CTX *ctx" | ||
| 42 | .Ft long | ||
| 43 | .Fn SSL_CTX_sess_cache_full "SSL_CTX *ctx" | ||
| 44 | .Sh DESCRIPTION | ||
| 45 | .Fn SSL_CTX_sess_number | ||
| 46 | returns the current number of sessions in the internal session cache. | ||
| 47 | .Pp | ||
| 48 | .Fn SSL_CTX_sess_connect | ||
| 49 | returns the number of started SSL/TLS handshakes in client mode. | ||
| 50 | .Pp | ||
| 51 | .Fn SSL_CTX_sess_connect_good | ||
| 52 | returns the number of successfully established SSL/TLS sessions in client mode. | ||
| 53 | .Pp | ||
| 54 | .Fn SSL_CTX_sess_connect_renegotiate | ||
| 55 | returns the number of start renegotiations in client mode. | ||
| 56 | .Pp | ||
| 57 | .Fn SSL_CTX_sess_accept | ||
| 58 | returns the number of started SSL/TLS handshakes in server mode. | ||
| 59 | .Pp | ||
| 60 | .Fn SSL_CTX_sess_accept_good | ||
| 61 | returns the number of successfully established SSL/TLS sessions in server mode. | ||
| 62 | .Pp | ||
| 63 | .Fn SSL_CTX_sess_accept_renegotiate | ||
| 64 | returns the number of start renegotiations in server mode. | ||
| 65 | .Pp | ||
| 66 | .Fn SSL_CTX_sess_hits | ||
| 67 | returns the number of successfully reused sessions. | ||
| 68 | In client mode a session set with | ||
| 69 | .Xr SSL_set_session 3 | ||
| 70 | successfully reused is counted as a hit. | ||
| 71 | In server mode a session successfully retrieved from internal or external cache | ||
| 72 | is counted as a hit. | ||
| 73 | .Pp | ||
| 74 | .Fn SSL_CTX_sess_cb_hits | ||
| 75 | returns the number of successfully retrieved sessions from the external session | ||
| 76 | cache in server mode. | ||
| 77 | .Pp | ||
| 78 | .Fn SSL_CTX_sess_misses | ||
| 79 | returns the number of sessions proposed by clients that were not found in the | ||
| 80 | internal session cache in server mode. | ||
| 81 | .Pp | ||
| 82 | .Fn SSL_CTX_sess_timeouts | ||
| 83 | returns the number of sessions proposed by clients and either found in the | ||
| 84 | internal or external session cache in server mode, | ||
| 85 | but that were invalid due to timeout. | ||
| 86 | These sessions are not included in the | ||
| 87 | .Fn SSL_CTX_sess_hits | ||
| 88 | count. | ||
| 89 | .Pp | ||
| 90 | .Fn SSL_CTX_sess_cache_full | ||
| 91 | returns the number of sessions that were removed because the maximum session | ||
| 92 | cache size was exceeded. | ||
| 93 | .Sh RETURN VALUES | ||
| 94 | The functions return the values indicated in the | ||
| 95 | .Sx DESCRIPTION | ||
| 96 | section. | ||
| 97 | .Sh SEE ALSO | ||
| 98 | .Xr ssl 3 , | ||
| 99 | .Xr SSL_CTX_sess_set_cache_size 3 , | ||
| 100 | .Xr SSL_CTX_set_session_cache_mode 3 , | ||
| 101 | .Xr SSL_set_session 3 | ||