1
0
mirror of https://github.com/mfontanini/libtins synced 2026-01-30 13:34:27 +01:00

Add more documentation on partial stream following

Fixes #227
This commit is contained in:
Matias Fontanini
2017-08-05 19:21:21 -07:00
parent f89e922d72
commit eb0d82ce89
2 changed files with 36 additions and 2 deletions

View File

@@ -55,6 +55,9 @@ namespace TCPIP {
* being open, it starts tracking it. This will follow all data sent by
* each peer and make it available to the user in a simple way.
*
* It is also possible to allow following already open connections by
* calling StreamFollower::follow_partial_streams.
*
* In order to use this class, just create an instance and set the
* new stream callback to some function that you want:
*
@@ -199,6 +202,7 @@ public:
* Stream::is_partial_stream is true).
*
* \param value Whether following partial stream is allowed.
* \sa Stream::enable_recovery_mode
*/
void follow_partial_streams(bool value);
private: