aboutsummaryrefslogtreecommitdiffstats
path: root/common/rfb/CConnection.h
diff options
context:
space:
mode:
Diffstat (limited to 'common/rfb/CConnection.h')
-rw-r--r--common/rfb/CConnection.h16
1 files changed, 5 insertions, 11 deletions
diff --git a/common/rfb/CConnection.h b/common/rfb/CConnection.h
index dca98a92..b30a997b 100644
--- a/common/rfb/CConnection.h
+++ b/common/rfb/CConnection.h
@@ -35,7 +35,6 @@ namespace rfb {
class CMsgReader;
class CMsgWriter;
class CSecurity;
- class IdentityVerifier;
class CConnection : public CMsgHandler {
public:
@@ -75,16 +74,11 @@ namespace rfb {
// there is data to read on the InStream.
void initialiseProtocol();
- // processMsg() should be called whenever there is either:
- // - data available on the underlying network stream
- // In this case, processMsg may return without processing an RFB message,
- // if the available data does not result in an RFB message being ready
- // to handle. e.g. if data is encrypted.
- // NB: This makes it safe to call processMsg() in response to select()
- // - data available on the CConnection's current InStream
- // In this case, processMsg should always process the available RFB
- // message before returning.
- // NB: In either case, 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();
// close() gracefully shuts down the connection to the server and