Debian Codegraph @

upstream/debian-unstable/man3/SSL_SESSION_get_compress_id.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_SESSION_GET_COMPRESS_ID 3SSL"
58 .TH SSL_SESSION_GET_COMPRESS_ID 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_SESSION_get_compress_id
65 \&\- get details about the compression associated with a session
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/ssl.h>
70 \&
71 \& unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 If compression has been negotiated for an ssl session then
76 \&\fBSSL_SESSION_get_compress_id()\fR will return the id for the compression method or
77 0 otherwise. The only built-in supported compression method is zlib which has an
78 id of 1.
79 .SH "RETURN VALUES"
80 .IX Header "RETURN VALUES"
81 \&\fBSSL_SESSION_get_compress_id()\fR returns the id of the compression method or 0 if
82 none.
83 .SH "SEE ALSO"
84 .IX Header "SEE ALSO"
85 \&\fBssl\fR\|(7)
86 .SH COPYRIGHT
87 .IX Header "COPYRIGHT"
88 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
89 .PP
90 Licensed under the Apache License 2.0 (the "License"). You may not use
91 this file except in compliance with the License. You can obtain a copy
92 in the file LICENSE in the source distribution or at
93 <https://www.openssl.org/source/license.html>.