openssl/doc/man3/SSL_SESSION_is_resumable.pod
Dr. Matthias St. Pierre fc5ecaddd0 man: harmonize the various formulations in the HISTORY sections
While stereotyped repetitions are frowned upon in literature, they
serve a useful purpose in manual pages, because it is easier for
the user to find certain information if it is always presented in
the same way. For that reason, this commit harmonizes the varying
formulations in the HISTORY section about which functions, flags,
etc. were added in which OpenSSL version.

It also attempts to make the pod files more grep friendly by
avoiding to insert line breaks between the symbol names and the
corresponding version number in which they were introduced
(wherever possible). Some punctuation and typographical errors
were fixed on the way.

Reviewed-by: Tim Hudson <tjh@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/7854)
2018-12-15 22:27:26 +01:00

45 lines
1.1 KiB
Plaintext

=pod
=head1 NAME
SSL_SESSION_is_resumable
- determine whether an SSL_SESSION object can be used for resumption
=head1 SYNOPSIS
#include <openssl/ssl.h>
int SSL_SESSION_is_resumable(const SSL_SESSION *s);
=head1 DESCRIPTION
SSL_SESSION_is_resumable() determines whether an SSL_SESSION object can be used
to resume a session or not. Returns 1 if it can or 0 if not. Note that
attempting to resume with a non-resumable session will result in a full
handshake.
=head1 RETURN VALUES
SSL_SESSION_is_resumable() returns 1 if the session is resumable or 0 otherwise.
=head1 SEE ALSO
L<ssl(7)>,
L<SSL_get_session(3)>,
L<SSL_CTX_sess_set_new_cb(3)>
=head1 HISTORY
The SSL_SESSION_is_resumable() function was added in OpenSSL 1.1.1.
=head1 COPYRIGHT
Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut