aboutsummaryrefslogtreecommitdiffstats
path: root/common/rfb/SSecurity.h
diff options
context:
space:
mode:
Diffstat (limited to 'common/rfb/SSecurity.h')
-rw-r--r--common/rfb/SSecurity.h17
1 files changed, 9 insertions, 8 deletions
diff --git a/common/rfb/SSecurity.h b/common/rfb/SSecurity.h
index 8e296c5a..0911ecd8 100644
--- a/common/rfb/SSecurity.h
+++ b/common/rfb/SSecurity.h
@@ -20,14 +20,15 @@
// derived class for a particular security type overrides the processMsg()
// method.
-// processMsg() is called first when the security type has been decided on, and
-// will keep being called whenever there is data to read from the client. It
-// should return false when it needs more data, or true when the connection has
-// been successfully authenticated. In the event of authentication failure an
-// AuthFailureException should be thrown - this will result in a "failed"
-// security result being sent to the client with the str() from the exception
-// being sent as the reason. Any other type of failure should be indicated by
-// some other kind of exception which will cause the connection to be aborted.
+// processMsg() is called first when the security type has been decided
+// on, and will keep being called whenever there is data to read from
+// the client. It should return false when it needs more data, or true
+// when the connection has been successfully authenticated. In the
+// event of authentication failure an auth_error should be thrown - this
+// will result in a "failed" security result being sent to the client
+// with the str() from the exception being sent as the reason. Any
+// other type of failure should be indicated by some other kind of
+// exception which will cause the connection to be aborted.
//
// processMsg() must never block (or at least must never block until the client
// has been authenticated) - this is to prevent denial of service attacks.