diff options
author | Hugo Landau <hlandau@openssl.org> | 2023-08-30 14:00:14 +0100 |
---|---|---|
committer | Hugo Landau <hlandau@openssl.org> | 2023-09-01 14:02:50 +0100 |
commit | cf269150630aa2854589b250f9aa61186a6b74ce (patch) | |
tree | fe0ffb658cc88abf5b77c9299192e36dcc4e66f2 /doc | |
parent | 2619d10ace8ee8e56425771bac48aa12769421f2 (diff) |
BIO: Emphasise API contract for BIO_sendmmsg/BIO_recvmmsg
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/21905)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/BIO_sendmmsg.pod | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/man3/BIO_sendmmsg.pod b/doc/man3/BIO_sendmmsg.pod index 9742eda50b..04075dd591 100644 --- a/doc/man3/BIO_sendmmsg.pod +++ b/doc/man3/BIO_sendmmsg.pod @@ -197,6 +197,10 @@ transient error, many of which are system specific. =back +Third parties implementing custom BIOs supporting the BIO_sendmmsg() or +BIO_recvmmsg() methods should note that it is a required part of the API +contract that an error is always raised when either of these functions return 0. + BIO_dgram_set_local_addr_enable() returns 1 if local address support was successfully enabled or disabled and 0 otherwise. |