Bi-directional streams are undocumented

[edigaryev]

Currently documentation[1] explains in detail how uni-directional streams work, but leaves bi-directional streams largely undocumented.

When reading Frame Streams using non-blocking I/O, fstrm_reader abstraction is of no use (even fstrm_capture utility ignores it), so you have to talk to bi-directional writers on your own, but there's no specification on that, besides reading the fstrm_writer code.

[1] https://farsightsec.github.io/fstrm/group__fstrm__control.html

[edmonds]

Hi, Nikolay:

Yes, you are correct, the bi-directional streams have not been documented. I will try to find some time this week to update the documentation.

Since there are already some fstrm reverse dependencies already, the protocol won't be changing, either. Probably the next release will be 1.0.0 with Semantic Versioning.

Thanks!