Skip to content

Commit

Permalink
[docs] Revised accumulated statistics, added summary table
Browse files Browse the repository at this point in the history
  • Loading branch information
mbakholdina committed Mar 26, 2020
1 parent 6598a13 commit ba6a33d
Show file tree
Hide file tree
Showing 2 changed files with 245 additions and 167 deletions.
10 changes: 5 additions & 5 deletions docs/API-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ be called from the C++ global destructor, if not called by the application, alth
relying on this behavior is stronly discouraged.

- Returns:

* 0 (A possibility to return other values is reserved for future use)

**IMPORTANT**: Note that the startup/cleanup calls have an instance counter.
Expand Down Expand Up @@ -837,7 +837,7 @@ are then derived by the member sockets.
* `SRT_EINVSOCK`: Socket `u` indicates no valid socket ID
* `SRT_EINVOP`: Option `opt` indicates no valid option
* Various other errors that may result from problems when setting a specific
option (see option description for details).
option (see option description for details).

### srt_getversion

Expand Down Expand Up @@ -1311,7 +1311,7 @@ would be 0x7FFFFFE0, the "distance" is 0x20.
// perfmon with Byte counters for better bitrate estimation.
int srt_bstats(SRTSOCKET u, SRT_TRACEBSTATS * perf, int clear);
// permon with Byte counters and instantaneous stats instead of moving averages for Snd/Rcvbuffer sizes.
// perfmon with Byte counters and instantaneous stats instead of moving averages for Snd/Rcvbuffer sizes.
int srt_bistats(SRTSOCKET u, SRT_TRACEBSTATS * perf, int clear, int instantaneous);
```

Expand Down Expand Up @@ -1436,7 +1436,7 @@ level-triggered, you can do two separate subscriptions for the same socket.


- Returns:

* 0 if successful, otherwise -1

- Errors:
Expand All @@ -1461,7 +1461,7 @@ The `_usock` suffix refers to a user socket (SRT socket).
The `_ssock` suffix refers to a system socket.

- Returns:

* 0 if successful, otherwise -1

- Errors:
Expand Down
Loading

0 comments on commit ba6a33d

Please sign in to comment.