From b2e347f54d7da928655ba0b0383f5c0039fb48f3 Mon Sep 17 00:00:00 2001 From: Amit Bezalel Date: Sat, 15 Jul 2017 08:21:43 +0300 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8e1a153..e343824 100644 --- a/README.md +++ b/README.md @@ -18,14 +18,19 @@ but the code is already working (see server_test, proxy_test & player_test) Communication to vnc-server & vnc-client are done in the RFB binary protocol in the standard ways. Internal communication inside the proxy is done by listeners (a pub-sub system) that provide a stream of bytes, parsed by delimiters which provide information about RFB message start & type / rectangle start / communication closed, etc. -this allows for minimal delays in transfer while retaining the ability to buffer and manipulate any part of the protocol. +This method allows for minimal delays in transfer, while retaining the ability to buffer and manipulate any part of the protocol. For the client messages which are smaller, we send fully parsed messages going trough the same listener system. Currently client messages are used to determine the correct pixel format, since the client can change it by sending a SetPixelFormatMessage. +Tracking the bytes that are read from the actual vnc-server is made simple by using the RfbReadHelper (implements io.Reader) which sends the bytes to the listeners, this helps avoid keeping track of each byte read, in order to write it into the recorder. -This listener system was chosen since it allows the listening side to decide whether or not it wants to run in parallel, in contrast having channels inside the server/client objects which require you to create go routines (this creates problems when using go's native websocket implementation) +Encoding implementations do not decode pixel information, since this is not required for the proxy implementation. + + +This listener system was chosen over direct use of channels, since it allows the listening side to decide whether or not it wants to run in parallel, in contrast having channels inside the server/client objects which require you to create go routines (this creates problems when using go's native websocket implementation) +The Recorder uses channels and runs in parallel to avoid hampering the communication through the proxy. **Player** ![Image of Arch](https://github.com/amitbet/vncproxy/blob/master/architecture/player-arch.png?raw=true) -The code is based on several implementations of go-vnc including the original one by **Mitchell Hashimoto**, and the very active fork which belongs to **Vasiliy Tolstov**. \ No newline at end of file +The code is based on several implementations of go-vnc including the original one by **Mitchell Hashimoto**, and the very active fork which belongs to **Vasiliy Tolstov**.