Improve Streams IO docs

[alexvaluyskiy]

Fixed: #3109

[Horusiath]

While this is missing pictures, I think, that in general original doc is missing few things (i.e. BindAndHandle method is very useful IMO, but totally ignored here, similarly JsonFraming).

Also regarding example tests - have you actually tried to connect to a TCP server? I think that those scenarios should be verifiable using i.e. telnet command. This was the reason, why I haven't published this doc earlier.

[Horusiath]

This is ugly API (it should be hidden IMHO). Sys.TcpStream() looks a lot better.

[alexvaluyskiy]

Ok :)

[alexvaluyskiy]

@Horusiath We also missed .NET Streams (MemoryStream, FileStream, etc)

[alexvaluyskiy]

@Horusiath I've added images added an example with BindAndHandle. And have tested the first example with netcat on Linux Subsystem for Windows.

Still working on the rest two examples

[alexvaluyskiy]

I've made it internal

[Horusiath]

netcat is not available on Windows by default (or by Git bash). Have you tried to use it?

[alexvaluyskiy]

yes

[alexvaluyskiy]

Have no idea how to convert it to C#

val input = new AtomicReference("Hello world" :: "What a lovely day" :: Nil)
def readLine(prompt: String): String = {
    input.get() match {
    case all @ cmd :: tail if input.compareAndSet(all, tail) => cmd
    case _ => "q"
    }
}

[Horusiath]

This is a very convoluted way of having concurrent queue with 2 elements in it ("Hello world", "What a lovely day") and dequeueing those elements in thread safe fashion. Once a readLine hits an empty queue a "q" string is returned instead of normal content.

More or less the code would be:

var input = new ConcurrentQueue<string>(new[] { "Hello world", "What a lovely day" });
string ReadLine(string prompt) => input.TryDequeue(out var cmd) ? cmd : "q";

[alexvaluyskiy]

Thanks, It works now

[Horusiath]

Approvals API needs to be updated.

[Aaronontheweb]

still missing API approval