blob: 84a3e9da7b13b664b91c5fac170b28877bd87647 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
/*
* Copyright (c) 2010-2016 Isode Limited.
* All rights reserved.
* See the COPYING file for more information.
*/
#pragma once
#include <list>
#include <boost/function.hpp>
#include <boost/thread.hpp>
#include <Swiften/Base/API.h>
#include <Swiften/EventLoop/Event.h>
namespace Swift {
class EventOwner;
/**
* The \ref EventLoop class provides the abstract interface for implementing event loops to use with Swiften.
*
* Events are added to the event queue using the \ref postEvent method and can be removed from the queue using
* the \ref removeEventsFromOwner method.
*/
class SWIFTEN_API EventLoop {
public:
EventLoop();
virtual ~EventLoop();
/**
* The \ref postEvent method allows events to be added to the event queue of the \ref EventLoop.
* An optional \ref EventOwner can be passed, allowing later removal of events that have not yet been
* executed using the \ref removeEventsFromOwner method.
*/
void postEvent(boost::function<void ()> event, boost::shared_ptr<EventOwner> owner = boost::shared_ptr<EventOwner>());
/**
* The \ref removeEventsFromOwner method removes all events from the specified \ref owner from the
* event queue.
*/
void removeEventsFromOwner(boost::shared_ptr<EventOwner> owner);
protected:
/**
* The \ref handleNextEvents method is called by an implementation of the abstract \ref EventLoop class
* at any point after the virtual \ref eventPosted method has been called.
* This method does not block, except for short-time synchronization.
* It can process multiple events before it reutrns.
* If called recursively, the event queue is not further processed. Instead, \ref eventPosted
* is called to notify the implementing event loop of the non-empty event queue.
* It is recommended to not call \ref handleNextEvents inside an event posted to the event loop
* as this can lead to an infinite loop.
*/
void handleNextEvents();
/**
* The \ref eventPosted virtual method serves as notification for when events are still available in the queue.
* It is called after the first event is posted to an empty queue or after an event has been handled in
* \ref handleNextEvents and there are still remaining events in the queue.
*/
virtual void eventPosted() = 0;
private:
unsigned int nextEventID_;
std::list<Event> events_;
bool handlingEvents_;
boost::recursive_mutex eventsMutex_;
boost::recursive_mutex removeEventsMutex_;
};
}
|
Swift