Lines Matching +full:write +full:- +full:to +full:- +full:write
18 .\" Set up some character translations and predefined strings. \*(-- will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
24 .tr \(*W-
27 . ds -- \(*W-
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
37 . ds -- \|\(em\|
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
71 .\" Fear. Run. Save yourself. No user-serviceable parts.
81 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
97 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
98 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
99 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
100 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
101 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
102 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104 . \" troff and (daisy-wheel) nroff accents
123 . ds d- d\h'-1'\(ga
124 . ds D- D\h'-1'\(hy
134 .TH SSL_WRITE 3ossl "2023-09-19" "3.0.11" "OpenSSL"
140 SSL_write_ex, SSL_write, SSL_sendfile \- write bytes to a TLS/SSL connection
152 \&\fBSSL_write_ex()\fR and \fBSSL_write()\fR write \fBnum\fR bytes from the buffer \fBbuf\fR into
157 descriptor \fBfd\fR to the specified \s-1SSL\s0 connection \fBs\fR. This function provides
158 efficient zero-copy semantics. \fBSSL_sendfile()\fR is available only when
159 Kernel \s-1TLS\s0 is enabled, which can be checked by calling \fBBIO_get_ktls_send()\fR.
160 It is provided here to allow users to maintain the same interface.
165 In the paragraphs below a \*(L"write function\*(R" is defined as one of either
168 If necessary, a write function will negotiate a \s-1TLS/SSL\s0 session, if not already
170 requests a re-negotiation, it will be performed transparently during
171 the write function operation. The behaviour of the write functions depends on the
172 underlying \s-1BIO.\s0
174 For the transparent negotiation to succeed, the \fBssl\fR must have been
175 initialized to client or server mode. This is being done by calling
177 before the first call to a write function.
179 If the underlying \s-1BIO\s0 is \fBblocking\fR, the write functions will only return, once
180 the write operation has been finished or an error occurred.
182 If the underlying \s-1BIO\s0 is \fBnonblocking\fR the write functions will also return
183 when the underlying \s-1BIO\s0 could not satisfy the needs of the function to continue
184 the operation. In this case a call to \fBSSL_get_error\fR\|(3) with the
185 return value of the write function will yield \fB\s-1SSL_ERROR_WANT_READ\s0\fR
186 or \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR. As at any time a re-negotiation is possible, a
187 call to a write function can also cause read operations! The calling process
188 then must repeat the call after taking appropriate action to satisfy the needs
189 of the write function. The action depends on the underlying \s-1BIO.\s0 When using a
190 nonblocking socket, nothing is to be done, but \fBselect()\fR can be used to check
191 for the required condition. When using a buffering \s-1BIO,\s0 like a \s-1BIO\s0 pair, data
192 must be written into or retrieved out of the \s-1BIO\s0 before being able to continue.
194 The write functions will only return with success when the complete contents of
196 with the \s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 option of \fBSSL_CTX_set_mode\fR\|(3). When
197 this flag is set the write functions will also return with success when a
198 partial write has been successfully completed. In this case the write function
199 operation is considered completed. The bytes are sent and a new write call with
201 write is performed with the size of a message block, which is 16kB.
204 When a write function call has to be repeated because \fBSSL_get_error\fR\|(3)
205 returned \fB\s-1SSL_ERROR_WANT_READ\s0\fR or \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR, it must be repeated
208 When \fB\s-1SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER\s0\fR was set using \fBSSL_CTX_set_mode\fR\|(3)
212 \&\fBSSL_write_ex()\fR can be called with num=0, but will not send application data to
217 all requested application data bytes have been written to the \s-1SSL\s0 connection or,
218 if \s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 is in use, at least 1 application data byte has
219 been written to the \s-1SSL\s0 connection. Failure means that not all the requested
220 bytes have been written yet (if \s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 is not in use) or
221 no bytes could be written to the \s-1SSL\s0 connection (if
222 \&\s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 is in use). Failures can be retryable (e.g. the
223 network write buffer has temporarily filled up) or non-retryable (e.g. a fatal
224 network error). In the event of a failure call \fBSSL_get_error\fR\|(3) to find out
230 The write operation was successful, the return value is the number of
231 bytes actually written to the \s-1TLS/SSL\s0 connection.
234 The write operation was not successful, because either the connection was
236 Call \fBSSL_get_error()\fR with the return value \fBret\fR to find out the reason.
238 Old documentation indicated a difference between 0 and \-1, and that \-1 was
240 You should instead call \fBSSL_get_error()\fR to find out if it's retryable.
245 The write operation was successful, the return value is the number
246 of bytes of the file written to the \s-1TLS/SSL\s0 connection. The return
247 value can be less than \fBsize\fR for a partial write.
250 The write operation was not successful, because either the connection was
252 Call \fBSSL_get_error()\fR with the return value to find out the reason.
266 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
270 in the file \s-1LICENSE\s0 in the source distribution or at