xref: /freebsd/crypto/openssl/doc/man3/SSL_SESSION_get_compress_id.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1e71b7053SJung-uk Kim=pod
2e71b7053SJung-uk Kim
3e71b7053SJung-uk Kim=head1 NAME
4e71b7053SJung-uk Kim
5e71b7053SJung-uk KimSSL_SESSION_get_compress_id
6e71b7053SJung-uk Kim- get details about the compression associated with a session
7e71b7053SJung-uk Kim
8e71b7053SJung-uk Kim=head1 SYNOPSIS
9e71b7053SJung-uk Kim
10e71b7053SJung-uk Kim #include <openssl/ssl.h>
11e71b7053SJung-uk Kim
12e71b7053SJung-uk Kim unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s);
13e71b7053SJung-uk Kim
14e71b7053SJung-uk Kim=head1 DESCRIPTION
15e71b7053SJung-uk Kim
16e71b7053SJung-uk KimIf compression has been negotiated for an ssl session then
17e71b7053SJung-uk KimSSL_SESSION_get_compress_id() will return the id for the compression method or
18e71b7053SJung-uk Kim0 otherwise. The only built-in supported compression method is zlib which has an
19e71b7053SJung-uk Kimid of 1.
20e71b7053SJung-uk Kim
21e71b7053SJung-uk Kim=head1 RETURN VALUES
22e71b7053SJung-uk Kim
23e71b7053SJung-uk KimSSL_SESSION_get_compress_id() returns the id of the compression method or 0 if
24e71b7053SJung-uk Kimnone.
25e71b7053SJung-uk Kim
26e71b7053SJung-uk Kim=head1 SEE ALSO
27e71b7053SJung-uk Kim
28e71b7053SJung-uk KimL<ssl(7)>
29e71b7053SJung-uk Kim
30e71b7053SJung-uk Kim=head1 COPYRIGHT
31e71b7053SJung-uk Kim
32e71b7053SJung-uk KimCopyright 2017 The OpenSSL Project Authors. All Rights Reserved.
33e71b7053SJung-uk Kim
34*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
35e71b7053SJung-uk Kimthis file except in compliance with the License.  You can obtain a copy
36e71b7053SJung-uk Kimin the file LICENSE in the source distribution or at
37e71b7053SJung-uk KimL<https://www.openssl.org/source/license.html>.
38e71b7053SJung-uk Kim
39e71b7053SJung-uk Kim=cut
40