1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD. Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
61 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear. Run. Save yourself. No user-serviceable parts.
73 . \" fudge factors for nroff and troff
82 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
88 . \" simple accents for nroff and troff
98 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 . \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 . \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 . \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
132 .\" ========================================================================
134 .IX Title "SSL_CTX_set_mode 3"
135 .TH SSL_CTX_set_mode 3 "2009-11-06" "0.9.8l" "OpenSSL"
136 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
141 SSL_CTX_set_mode, SSL_set_mode, SSL_CTX_get_mode, SSL_get_mode \- manipulate SSL engine mode
143 .IX Header "SYNOPSIS"
145 \& #include <openssl/ssl.h>
147 \& long SSL_CTX_set_mode(SSL_CTX *ctx, long mode);
148 \& long SSL_set_mode(SSL *ssl, long mode);
150 \& long SSL_CTX_get_mode(SSL_CTX *ctx);
151 \& long SSL_get_mode(SSL *ssl);
154 .IX Header "DESCRIPTION"
155 \&\fISSL_CTX_set_mode()\fR adds the mode set via bitmask in \fBmode\fR to \fBctx\fR.
156 Options already set before are not cleared.
158 \&\fISSL_set_mode()\fR adds the mode set via bitmask in \fBmode\fR to \fBssl\fR.
159 Options already set before are not cleared.
161 \&\fISSL_CTX_get_mode()\fR returns the mode set for \fBctx\fR.
163 \&\fISSL_get_mode()\fR returns the mode set for \fBssl\fR.
166 The following mode changes are available:
167 .IP "\s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0" 4
168 .IX Item "SSL_MODE_ENABLE_PARTIAL_WRITE"
169 Allow SSL_write(..., n) to return r with 0 < r < n (i.e. report success
170 when just a single record has been written). When not set (the default),
171 \&\fISSL_write()\fR will only report success once the complete chunk was written.
172 Once \fISSL_write()\fR returns with r, r bytes have been successfully written
173 and the next call to \fISSL_write()\fR must only send the n\-r bytes left,
174 imitating the behaviour of \fIwrite()\fR.
175 .IP "\s-1SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER\s0" 4
176 .IX Item "SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER"
177 Make it possible to retry \fISSL_write()\fR with changed buffer location
178 (the buffer contents must stay the same). This is not the default to avoid
179 the misconception that non-blocking \fISSL_write()\fR behaves like
180 non-blocking \fIwrite()\fR.
181 .IP "\s-1SSL_MODE_AUTO_RETRY\s0" 4
182 .IX Item "SSL_MODE_AUTO_RETRY"
183 Never bother the application with retries if the transport is blocking.
184 If a renegotiation take place during normal operation, a
185 \&\fISSL_read\fR\|(3) or \fISSL_write\fR\|(3) would return
186 with \-1 and indicate the need to retry with \s-1SSL_ERROR_WANT_READ\s0.
187 In a non-blocking environment applications must be prepared to handle
188 incomplete read/write operations.
189 In a blocking environment, applications are not always prepared to
190 deal with read/write operations returning without success report. The
191 flag \s-1SSL_MODE_AUTO_RETRY\s0 will cause read/write operations to only
192 return after the handshake and successful completion.
194 .IX Header "RETURN VALUES"
195 \&\fISSL_CTX_set_mode()\fR and \fISSL_set_mode()\fR return the new mode bitmask
196 after adding \fBmode\fR.
198 \&\fISSL_CTX_get_mode()\fR and \fISSL_get_mode()\fR return the current bitmask.
200 .IX Header "SEE ALSO"
201 \&\fIssl\fR\|(3), \fISSL_read\fR\|(3), \fISSL_write\fR\|(3)
204 \&\s-1SSL_MODE_AUTO_RETRY\s0 as been added in OpenSSL 0.9.6.