From d6e418b5ed48e2270e75ec1217f88cf56fbf7602 Mon Sep 17 00:00:00 2001 From: Christian Prochaska Date: Tue, 26 Jun 2012 16:29:38 +0200 Subject: [PATCH] README file for 'terminal_crosslink' Fixes #257. --- os/src/server/terminal_crosslink/README | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 os/src/server/terminal_crosslink/README diff --git a/os/src/server/terminal_crosslink/README b/os/src/server/terminal_crosslink/README new file mode 100644 index 0000000000..99940f8468 --- /dev/null +++ b/os/src/server/terminal_crosslink/README @@ -0,0 +1,14 @@ +The 'terminal_crosslink' server allows exactly two clients to communicate with +each other using the 'Terminal' interface. Data sent to the server gets stored +in a buffer of 4096 bytes (one buffer per client). As long as the data to be +written fits into the buffer, the 'write()' call returns immediately. If no +more data fits into the buffer, the 'write()' call blocks until the other +client has consumed some of the data from the buffer via the 'read()' call. The +'read()' call never blocks. A signal receiver can be used to block until new +data is ready for reading. + +Example +------- + +An example run script 'terminal_crosslink.run' can be found in the 'os/run' +directory.