Swift
summaryrefslogtreecommitdiffstats
path: root/Swiften/EventLoop/EventLoop.h
diff options
context:
space:
mode:
Diffstat (limited to 'Swiften/EventLoop/EventLoop.h')
-rw-r--r--Swiften/EventLoop/EventLoop.h11
1 files changed, 5 insertions, 6 deletions
diff --git a/Swiften/EventLoop/EventLoop.h b/Swiften/EventLoop/EventLoop.h
index 06b9fbb..f61b9bc 100644
--- a/Swiften/EventLoop/EventLoop.h
+++ b/Swiften/EventLoop/EventLoop.h
@@ -1,5 +1,5 @@
1/* 1/*
2 * Copyright (c) 2010-2016 Isode Limited. 2 * Copyright (c) 2010-2019 Isode Limited.
3 * All rights reserved. 3 * All rights reserved.
4 * See the COPYING file for more information. 4 * See the COPYING file for more information.
5 */ 5 */
@@ -43,21 +43,20 @@ namespace Swift {
43 43
44 protected: 44 protected:
45 /** 45 /**
46 * The \ref handleNextEvents method is called by an implementation of the abstract \ref EventLoop class 46 * The \ref handleNextEvent method is called by an implementation of the abstract \ref EventLoop class
47 * at any point after the virtual \ref eventPosted method has been called. 47 * at any point after the virtual \ref eventPosted method has been called.
48 * This method does not block, except for short-time synchronization. 48 * This method does not block, except for short-time synchronization.
49 * It can process multiple events before it reutrns.
50 * If called recursively, the event queue is not further processed. Instead, \ref eventPosted 49 * If called recursively, the event queue is not further processed. Instead, \ref eventPosted
51 * is called to notify the implementing event loop of the non-empty event queue. 50 * is called to notify the implementing event loop of the non-empty event queue.
52 * It is recommended to not call \ref handleNextEvents inside an event posted to the event loop 51 * It is recommended to not call \ref handleNextEvent inside an event posted to the event loop
53 * as this can lead to an infinite loop. 52 * as this can lead to an infinite loop.
54 */ 53 */
55 void handleNextEvents(); 54 void handleNextEvent();
56 55
57 /** 56 /**
58 * The \ref eventPosted virtual method serves as notification for when events are still available in the queue. 57 * The \ref eventPosted virtual method serves as notification for when events are still available in the queue.
59 * It is called after the first event is posted to an empty queue or after an event has been handled in 58 * It is called after the first event is posted to an empty queue or after an event has been handled in
60 * \ref handleNextEvents and there are still remaining events in the queue. 59 * \ref handleNextEvent and there are still remaining events in the queue.
61 */ 60 */
62 virtual void eventPosted() = 0; 61 virtual void eventPosted() = 0;
63 62