[thirdparty/openssl.git] / doc / man3 / SSL_SESSION_is_resumable.pod

=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

SSL_SESSION_is_resumable() was first added to 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
Commit	Line	Data
6ff71494 MC	1	=pod
	2
	3	=head1 NAME
	4
	5	SSL_SESSION_is_resumable
	6	- determine whether an SSL_SESSION object can be used for resumption
	7
	8	=head1 SYNOPSIS
	9
	10	#include <openssl/ssl.h>
	11
6b9c46ff	12	int SSL_SESSION_is_resumable(const SSL_SESSION *s);
6ff71494 MC	13
	14	=head1 DESCRIPTION
	15
	16	SSL_SESSION_is_resumable() determines whether an SSL_SESSION object can be used
	17	to resume a session or not. Returns 1 if it can or 0 if not. Note that
5b3e5f00 MC	18	attempting to resume with a non-resumable session will result in a full
5b3e5f00 MC	19	handshake.
6ff71494	20
1f13ad31 PY	21	=head1 RETURN VALUES
	22
	23	SSL_SESSION_is_resumable() returns 1 if the session is resumable or 0 otherwise.
	24
6ff71494 MC	25	=head1 SEE ALSO
	26
	27	L<ssl(7)>,
	28	L<SSL_get_session(3)>,
	29	L<SSL_CTX_sess_set_new_cb(3)>
	30
	31	=head1 HISTORY
	32
	33	SSL_SESSION_is_resumable() was first added to OpenSSL 1.1.1
	34
	35	=head1 COPYRIGHT
	36
61f805c1	37	Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
6ff71494	38
4746f25a	39	Licensed under the Apache License 2.0 (the "License"). You may not use
6ff71494 MC	40	this file except in compliance with the License. You can obtain a copy
	41	in the file LICENSE in the source distribution or at
	42	L<https://www.openssl.org/source/license.html>.
	43
	44	=cut