← Back to branch summary

~bibledit/bibledit/client

« back to all changes in this revision

Viewing changes to mbedtls/net_sockets.h

  • Committer: teusjannette at gmail
  • Date: 2021-10-15 18:20:48 UTC
  • Revision ID: teusjannette@gmail.com-20211015182048-jxzor4v0vphq2avn
new upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
mbedtls/net_sockets.h
151
151
 *
152
152
 * \return         0 if successful, or one of:
153
153
 *                      MBEDTLS_ERR_NET_SOCKET_FAILED,
 
154
 *                      MBEDTLS_ERR_NET_UNKNOWN_HOST,
154
155
 *                      MBEDTLS_ERR_NET_BIND_FAILED,
155
156
 *                      MBEDTLS_ERR_NET_LISTEN_FAILED
156
157
 *
170
171
 *                  can be NULL if client_ip is null
171
172
 *
172
173
 * \return          0 if successful, or
 
174
 *                  MBEDTLS_ERR_NET_SOCKET_FAILED,
 
175
 *                  MBEDTLS_ERR_NET_BIND_FAILED,
173
176
 *                  MBEDTLS_ERR_NET_ACCEPT_FAILED, or
174
177
 *                  MBEDTLS_ERR_NET_BUFFER_TOO_SMALL if buf_size is too small,
175
178
 *                  MBEDTLS_ERR_SSL_WANT_READ if bind_fd was set to
182
185
/**
183
186
 * \brief          Check and wait for the context to be ready for read/write
184
187
 *
 
188
 * \note           The current implementation of this function uses
 
189
 *                 select() and returns an error if the file descriptor
 
190
 *                 is \c FD_SETSIZE or greater.
 
191
 *
185
192
 * \param ctx      Socket to check
186
193
 * \param rw       Bitflag composed of MBEDTLS_NET_POLL_READ and
187
194
 *                 MBEDTLS_NET_POLL_WRITE specifying the events
263
270
 *                 'timeout' seconds. If no error occurs, the actual amount
264
271
 *                 read is returned.
265
272
 *
 
273
 * \note           The current implementation of this function uses
 
274
 *                 select() and returns an error if the file descriptor
 
275
 *                 is \c FD_SETSIZE or greater.
 
276
 *
266
277
 * \param ctx      Socket
267
278
 * \param buf      The buffer to write to
268
279
 * \param len      Maximum length of the buffer
269
280
 * \param timeout  Maximum number of milliseconds to wait for data
270
281
 *                 0 means no timeout (wait forever)
271
282
 *
272
 
 * \return         the number of bytes received,
273
 
 *                 or a non-zero error code:
274
 
 *                 MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
 
283
 * \return         The number of bytes received if successful.
 
284
 *                 MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out.
275
285
 *                 MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
 
286
 *                 Another negative error code (MBEDTLS_ERR_NET_xxx)
 
287
 *                 for other failures.
276
288
 *
277
289
 * \note           This function will block (until data becomes available or
278
290
 *                 timeout is reached) even if the socket is set to