Added comments describing the bridge protocol.

This commit is contained in:
Davis King 2012-04-14 08:47:05 -04:00
parent 6182270e77
commit 4f495f1a16
1 changed files with 13 additions and 0 deletions

View File

@ -111,6 +111,19 @@ namespace dlib
which will log various events taking place inside a bridge.
If you want to see these log messages then enable the logger
named "dlib.bridge".
BRIDGE PROTOCOL DETAILS
The bridge object creates a single TCP connection between
two applications. Whenever it sends an object from a pipe
over a TCP connection it sends a byte with the value 1 followed
immediately by the serialized copy of the object from the pipe.
The serialization is performed by calling the global serialize()
function.
Additionally, a bridge object will periodically send bytes with
a value of 0 to ensure the TCP connection remains alive. These
are just read and ignored.
!*/
public: