Updated documentation for SRT bonding #1123
Conversation
ethouris
added
[docs]
docs/API-functions.md
Outdated
| Creates an SRT socket: | ||
| Old and deprecated version of `srt_create_socket`. All arguments are ignored. | ||
|
|
||
| **NOTE** changes towards UDT version: |
There was a problem hiding this comment.
NOTE changes with respect to UDT version:
docs/API-functions.md
Outdated
| * `type`, `protocol`: ignored | ||
| * In UDT the `type` parameter was used to specify the file or message mode using | ||
| `SOCK_STREAM` or `SOCK_DGRAM` symbols (with the latter being misleading, as the | ||
| message mode has nothing to do with UDP datagrams and it's rather similar to SCTP |
There was a problem hiding this comment.
message mode has nothing to do with UDP datagrams and it's rather similar to the SCTP
docs/API-functions.md
Outdated
| protocol). In SRT these two modes are available by setting `SRTO_TRANSTYPE` to | ||
| `SRTT_FILE`, and the message mode is set by `SRTO_MESSAGEAPI` option. |
There was a problem hiding this comment.
protocol). In SRT, set SRTO_TRANSTYPE to SRTT_FILE for file mode. Set the
SRTO_MESSAGEAPI option for message mode.
There was a problem hiding this comment.
I changed it a little bit, so please re-check. The situation is: SRTO_TRANSTYPE may be SRTT_LIVE (default) or SRTT_FILE (this is an option that changes various settings and sets some other options to different defaults - this needs no elaborate description here, just mentioning in short). The SRTO_MESSAGEAPI option is then set to default false, which means "stream" mode (TCP-like), and when set to true, it's "message" mode (SCTP-like).
There was a problem hiding this comment.
How about this:
--BEGIN (line 120)--
protocol). In SRT these two modes are available by setting SRTO_TRANSTYPE. The default
is SRTT_LIVE. If, however, you set SRTO_TRANSTYPE to SRTT_FILE for file mode, you
can then leave the SRTO_MESSAGEAPI option as false (default), which corresponds to
"stream" mode (TCP-like), or set it to true, which corresponds to "message" mode
(SCTP-like).
--END--
docs/API-functions.md
Outdated
|
|
||
| Creates an SRT socket. | ||
|
|
||
| Note that socket IDs have always the `SRTGROUP_MASK` bit clear. |
There was a problem hiding this comment.
Note that socket IDs always have the SRTGROUP_MASK bit clear.
docs/API-functions.md
Outdated
| @@ -165,7 +166,9 @@ the communication. It is allowed that multiple SRT sockets share one local | |||
| outgoing port, as long as `SRTO_REUSEADDR` is set to *true* (default). Without | |||
| this call the port will be automatically selected by the system. | |||
|
|
|||
| *See **NOTE** below under* [`srt_create_socket`](#srt_create_socket). | |||
| NOTE: This function cannot be called on socket group. If you have a need to | |||
There was a problem hiding this comment.
NOTE: This function cannot be called on socket group. If you need to
docs/API.md
Outdated
| - Note that this flag set on a group is for group only, as it concerns the | ||
| exact receiving operation being done on a group. |
There was a problem hiding this comment.
- Note that this flag is for a group only, as it concerns a
specific receiving operation being done on a group.
docs/API.md
Outdated
| - **[GET or SET]** - When true, sets blocking mode on writing function, when | ||
| it's not ready to perform the operation. When false ("non-blocking mode"), the |
There was a problem hiding this comment.
- [GET or SET] - When true, sets blocking mode on a writing function when
it's not ready to perform the operation. When false ("non-blocking mode"), the
docs/API.md
Outdated
| `SRT_EPOLL_OUT` flag. | ||
|
|
||
| - On a freshly created socket or group it will have no effect until the socket | ||
| turns into a connected state. |
There was a problem hiding this comment.
enters a connected state.
docs/API.md
Outdated
| - Note that this flag set on a group is for group only, as it concerns the | ||
| exact sending operation being done on a group. |
There was a problem hiding this comment.
- Note that this flag is for a group only, as it concerns a
specific sending operation being done on a group.
docs/API.md
Outdated
| - Note that this flag set on a group is for group only, as it concerns the | ||
| exact sending operation being done on a group. |
There was a problem hiding this comment.
- Note that this flag is for a group only, as it concerns a
specific sending operation being done on a group.
docs/API.md
Outdated
| - Note that this flag set on a group is for group only, as it concerns the | ||
| exact sending operation being done on a group. | ||
| - Note that when this flag is set only on a group, it applies to a | ||
| specific receiving operation being done on that group (i.e. it is not |
There was a problem hiding this comment.
specific sending operation being done on that group (i.e. it is not
There was a problem hiding this comment.
Ah, my bad blind copy pasting.
docs/API.md
Outdated
| - Note that this flag set on a group is for group only, as it concerns the | ||
| exact sending operation being done on a group. | ||
| - Note that when this flag is set only on a group, it applies to a | ||
| specific receiving operation being done on that group (i.e. it is not |
There was a problem hiding this comment.
specific sending operation being done on that group (i.e. it is not
docs/API-functions.md
Outdated
| similar to the SCTP protocol). In SRT these two modes are available by setting | ||
| `SRTO_TRANSTYPE`. The default is `SRTT_LIVE`. If, however, you set | ||
| `SRTO_TRANSTYPE` to `SRTT_FILE` for file mode, you can then leave the | ||
| `SRTO_MESSAGEAPI option as false (default), which corresponds to "stream" mode |
There was a problem hiding this comment.
SRTO_MESSAGEAPI option as false (default), which corresponds to "stream" mode
No description provided.