aboutsummaryrefslogtreecommitdiffstats
path: root/common/rfb/SConnection.h
diff options
context:
space:
mode:
Diffstat (limited to 'common/rfb/SConnection.h')
-rw-r--r--common/rfb/SConnection.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/common/rfb/SConnection.h b/common/rfb/SConnection.h
index 2ac53269..46b427ed 100644
--- a/common/rfb/SConnection.h
+++ b/common/rfb/SConnection.h
@@ -61,8 +61,11 @@ namespace rfb {
// there is data to read on the InStream.
void initialiseProtocol();
- // processMsg() should be called whenever there is data to read on the
- // InStream. You must have called initialiseProtocol() first.
+ // processMsg() should be called whenever there is data available on
+ // the CConnection's current InStream. It will process at most one
+ // RFB message before returning. If there was insufficient data,
+ // then it will return false and should be called again once more
+ // data is available.
bool processMsg();
// approveConnection() is called to either accept or reject the connection.