Skip to content

Commit 09f35c0

Browse files
authored
[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.
1 parent 51e3d0d commit 09f35c0

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/API/API-functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -666,7 +666,7 @@ internal use only.
666666
| Returns | |
667667
|:----------------------------- |:----------------------------------------------------------------------- |
668668
| socket/group ID | On success, a valid SRT socket or group ID to be used for transmission. |
669-
| `SRT_ERROR` | (-1) on failure |
669+
| `SRT_INVALID_SOCK` | (-1) on failure |
670670
| <img width=240px height=1px/> | <img width=710px height=1px/> |
671671

672672
| Errors | |
@@ -722,7 +722,7 @@ calling this function.
722722
| Returns | |
723723
|:----------------------------- |:---------------------------------------------------------------------- |
724724
| SRT socket<br/>group ID | On success, a valid SRT socket or group ID to be used for transmission |
725-
| `SRT_ERROR` | (-1) on failure |
725+
| `SRT_INVALID_SOCK` | (-1) on failure |
726726
| <img width=240px height=1px/> | <img width=710px height=1px/> |
727727

728728
| Errors | |

0 commit comments

Comments
 (0)