From 09f35c0f1743e23f514cb41444504a7faeacf89e Mon Sep 17 00:00:00 2001 From: Thierry Lelegard Date: Tue, 29 Aug 2023 09:44:24 +0200 Subject: [PATCH] [docs] Fixed API doc: SRT_INVALID_SOCK instead of SRT_ERROR in str_accept (#2785). The functions srt_accept() and srt_accept_bond() return a SRTSOCKET. In case of error, the returned value is SRT_INVALID_SOCK, not SRT_ERROR. In practice, the two values are identical (-1) but they do not have the same semantics. --- docs/API/API-functions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/API/API-functions.md b/docs/API/API-functions.md index f897ffcc2..1ba578691 100644 --- a/docs/API/API-functions.md +++ b/docs/API/API-functions.md @@ -666,7 +666,7 @@ internal use only. | Returns | | |:----------------------------- |:----------------------------------------------------------------------- | | socket/group ID | On success, a valid SRT socket or group ID to be used for transmission. | -| `SRT_ERROR` | (-1) on failure | +| `SRT_INVALID_SOCK` | (-1) on failure | | | | | Errors | | @@ -722,7 +722,7 @@ calling this function. | Returns | | |:----------------------------- |:---------------------------------------------------------------------- | | SRT socket
group ID | On success, a valid SRT socket or group ID to be used for transmission | -| `SRT_ERROR` | (-1) on failure | +| `SRT_INVALID_SOCK` | (-1) on failure | | | | | Errors | |