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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/*
* Copyright (c) 2010-2012, Isode Limited, London, England.
* All rights reserved.
*/
/*
* Copyright (c) 2010 Remko Tronçon
* Licensed under the GNU General Public License v3.
* See Documentation/Licenses/GPLv3.txt for more information.
*/
package com.isode.stroke.eventloop;
import java.util.ArrayList;
import java.util.Vector;
/**
* An event loop is a seemingly infinite loop (runs for the duration of the use
* of the library) that waits for external events
* (e.g. incoming network packets, timers being activated, input happening) to
* happen; when such an event comes in, it notifies interested parties of this
* event, and then continues listening for the next event.
*/
public abstract class EventLoop {
/**
* Create an event loop
*/
public EventLoop() {
}
/**
* Post an event to the loop.
*
* @param callback Callback handler for the event, must not be null. This
* will be called when the event is processed.
*/
public void postEvent(Event.Callback callback) {
postEvent(callback, null);
}
/**
* Post an event to the loop.
*
* @param callback Callback handler for the event, must not be null. This
* will be called when the event is processed.
* @param owner Owner of the event, non-null. This can be used to
* {@link EventLoop#removeEventsFromOwner} later.
*/
public void postEvent(Event.Callback callback, EventOwner owner) {
Event event;
synchronized (eventsMutex_) {
event = new Event(owner, callback, nextEventID_);
nextEventID_++;
events_.add(event);
}
post(event);
}
/**
* Remove all events from the given owner.
* \p
* This does a reference check (==), not calling owner.equals().
*
* @param owner Owner of the event, must not be null
*/
public void removeEventsFromOwner(EventOwner owner) {
synchronized (eventsMutex_) {
ArrayList<Event> matches = new ArrayList<Event>();
for (Event event : events_) {
if (event.owner == owner) {
matches.add(event);
}
}
events_.removeAll(matches);
}
}
/**
* Reimplement this to call handleEvent(event) from the thread in which the
* event loop is residing.
*/
protected abstract void post(Event event);
/**
* When reimplementing, call this from within the {@link EventLoop#post}
* method in the application's event loop (main thread).
*/
protected void handleEvent(Event event) {
if (handlingEvents_) {
// We're being called recursively. Push in the list of events to
// handle in the parent handleEvent()
eventsToHandle_.add(event);
return;
}
boolean doCallback = false;
synchronized (eventsMutex_) {
doCallback = events_.contains(event);
if (doCallback) {
events_.remove(event);
}
}
if (doCallback) {
handlingEvents_ = true;
event.callback.run();
// Process events that were passed to handleEvent during the callback
// (i.e. through recursive calls of handleEvent)
while (!eventsToHandle_.isEmpty()) {
Event nextEvent = eventsToHandle_.firstElement();
eventsToHandle_.remove(0);
nextEvent.callback.run();
}
handlingEvents_ = false;
}
}
// struct HasOwner {
// HasOwner(boost::shared_ptr<EventOwner> owner) : owner(owner) {}
// bool operator()(const Event& event) { return event.owner == owner; }
// boost::shared_ptr<EventOwner> owner;
// };
private final Object eventsMutex_ = new Object();
private int nextEventID_ = 0;
private Vector<Event> events_ = new Vector<Event>();
boolean handlingEvents_ = false;
private Vector<Event> eventsToHandle_ = new Vector<Event>();
}
|