1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
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. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, 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 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "SSL_CTX_set_mode 3"
132 .TH SSL_CTX_set_mode 3 "2006-11-19" "0.9.8d" "OpenSSL"
134 SSL_CTX_set_mode, SSL_set_mode, SSL_CTX_get_mode, SSL_get_mode \- manipulate SSL engine mode
136 .IX Header "SYNOPSIS"
138 \& #include <openssl/ssl.h>
142 \& long SSL_CTX_set_mode(SSL_CTX *ctx, long mode);
143 \& long SSL_set_mode(SSL *ssl, long mode);
147 \& long SSL_CTX_get_mode(SSL_CTX *ctx);
148 \& long SSL_get_mode(SSL *ssl);
151 .IX Header "DESCRIPTION"
152 \&\fISSL_CTX_set_mode()\fR adds the mode set via bitmask in \fBmode\fR to \fBctx\fR.
153 Options already set before are not cleared.
155 \&\fISSL_set_mode()\fR adds the mode set via bitmask in \fBmode\fR to \fBssl\fR.
156 Options already set before are not cleared.
158 \&\fISSL_CTX_get_mode()\fR returns the mode set for \fBctx\fR.
160 \&\fISSL_get_mode()\fR returns the mode set for \fBssl\fR.
163 The following mode changes are available:
164 .IP "\s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0" 4
165 .IX Item "SSL_MODE_ENABLE_PARTIAL_WRITE"
166 Allow SSL_write(..., n) to return r with 0 < r < n (i.e. report success
167 when just a single record has been written). When not set (the default),
168 \&\fISSL_write()\fR will only report success once the complete chunk was written.
169 Once \fISSL_write()\fR returns with r, r bytes have been successfully written
170 and the next call to \fISSL_write()\fR must only send the n\-r bytes left,
171 imitating the behaviour of \fIwrite()\fR.
172 .IP "\s-1SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER\s0" 4
173 .IX Item "SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER"
174 Make it possible to retry \fISSL_write()\fR with changed buffer location
175 (the buffer contents must stay the same). This is not the default to avoid
176 the misconception that non-blocking \fISSL_write()\fR behaves like
177 non-blocking \fIwrite()\fR.
178 .IP "\s-1SSL_MODE_AUTO_RETRY\s0" 4
179 .IX Item "SSL_MODE_AUTO_RETRY"
180 Never bother the application with retries if the transport is blocking.
181 If a renegotiation take place during normal operation, a
182 \&\fISSL_read\fR\|(3) or \fISSL_write\fR\|(3) would return
183 with \-1 and indicate the need to retry with \s-1SSL_ERROR_WANT_READ\s0.
184 In a non-blocking environment applications must be prepared to handle
185 incomplete read/write operations.
186 In a blocking environment, applications are not always prepared to
187 deal with read/write operations returning without success report. The
188 flag \s-1SSL_MODE_AUTO_RETRY\s0 will cause read/write operations to only
189 return after the handshake and successful completion.
191 .IX Header "RETURN VALUES"
192 \&\fISSL_CTX_set_mode()\fR and \fISSL_set_mode()\fR return the new mode bitmask
193 after adding \fBmode\fR.
195 \&\fISSL_CTX_get_mode()\fR and \fISSL_get_mode()\fR return the current bitmask.
197 .IX Header "SEE ALSO"
198 \&\fIssl\fR\|(3), \fISSL_read\fR\|(3), \fISSL_write\fR\|(3)
201 \&\s-1SSL_MODE_AUTO_RETRY\s0 as been added in OpenSSL 0.9.6.