Skip to content

Commit

Permalink
[docs] Fixed API doc: SRT_INVALID_SOCK instead of SRT_ERROR in str_ac…
Browse files Browse the repository at this point in the history 
…cept (#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.
  • Loading branch information
@lelegard
lelegard authored Aug 29, 2023
1 parent 51e3d0d commit 09f35c0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/API/API-functions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| <img width=240px height=1px/> | <img width=710px height=1px/> |

| Errors | |
Expand Down Expand Up @@ -722,7 +722,7 @@ calling this function.
| Returns | |
|:----------------------------- |:---------------------------------------------------------------------- |
| SRT socket<br/>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 |
| <img width=240px height=1px/> | <img width=710px height=1px/> |

| Errors | |
Expand Down

0 comments on commit 09f35c0

Please sign in to comment.