summaryrefslogtreecommitdiff
path: root/include/mbgl/actor/scheduler.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'include/mbgl/actor/scheduler.hpp')
-rw-r--r--include/mbgl/actor/scheduler.hpp5
1 files changed, 5 insertions, 0 deletions
diff --git a/include/mbgl/actor/scheduler.hpp b/include/mbgl/actor/scheduler.hpp
index d8a26ebeab..75ead29f0a 100644
--- a/include/mbgl/actor/scheduler.hpp
+++ b/include/mbgl/actor/scheduler.hpp
@@ -31,6 +31,11 @@ class Mailbox;
class Scheduler {
public:
virtual ~Scheduler() = default;
+
+ // Used by a Mailbox when it has a message in its queue to request that it
+ // be scheduled. Specifically, the scheduler is expected to asynchronously
+ // call `receive() on the given mailbox, provided it still exists at that
+ // time.
virtual void schedule(std::weak_ptr<Mailbox>) = 0;
// Set/Get the current Scheduler for this thread