summaryrefslogtreecommitdiff
path: root/include/socketengine.h
diff options
context:
space:
mode:
authorAttila Molnar <attilamolnar@hush.com>2016-08-11 11:23:38 +0200
committerAttila Molnar <attilamolnar@hush.com>2016-08-11 11:23:38 +0200
commit96642de3b2c6bf126ce173e9c49ed64e32e4c48b (patch)
treefaa2f5ad3a73d796d139b77ddd1aa48271e287aa /include/socketengine.h
parentc6ebf05e028afbcbec2b1f1e9fdad5551967ecee (diff)
Update description of class EventHandler
Readable() and Writeable() was removed long ago
Diffstat (limited to 'include/socketengine.h')
-rw-r--r--include/socketengine.h11
1 files changed, 4 insertions, 7 deletions
diff --git a/include/socketengine.h b/include/socketengine.h
index bbbc7fd74..c0026bfc6 100644
--- a/include/socketengine.h
+++ b/include/socketengine.h
@@ -140,13 +140,10 @@ enum EventMask
* must then be added to SocketEngine using the method
* SocketEngine::AddFd(), after which point the derived
* class will receive events to its OnEventHandler*() methods.
- * The derived class should also implement one of Readable()
- * and Writeable(). In the current implementation, only
- * Readable() is used. If this returns true, the socketengine
- * inserts a readable socket. If it is false, the socketengine
- * inserts a writeable socket. The derived class should never
- * change the value this function returns without first
- * deleting the socket from the socket engine. The only
+ * The event mask passed to SocketEngine::AddFd() determines
+ * what events the EventHandler gets notified about and with
+ * what semantics. SocketEngine::ChangeEventMask() can be
+ * called to update the event mask later. The only
* requirement beyond this for an event handler is that it
* must have a file descriptor. What this file descriptor
* is actually attached to is completely up to you.