edaa002c3c
- Adds a way to set the current scheduler on the thread to be used whenever a mailbox is created that needs to reply on this thread
42 lines
1.4 KiB
C++
42 lines
1.4 KiB
C++
#pragma once
|
|
|
|
#include <memory>
|
|
|
|
namespace mbgl {
|
|
|
|
class Mailbox;
|
|
|
|
/*
|
|
A `Scheduler` is responsible for coordinating the processing of messages by
|
|
one or more actors via their mailboxes. It's an abstract interface. Currently,
|
|
the following concrete implementations exist:
|
|
|
|
* `ThreadPool` can coordinate an unlimited number of actors over any number of
|
|
threads via a pool, preserving the following behaviors:
|
|
|
|
- Messages from each individual mailbox are processed in order
|
|
- Only a single message from a mailbox is processed at a time; there is no
|
|
concurrency within a mailbox
|
|
|
|
Subject to these constraints, processing can happen on whatever thread in the
|
|
pool is available.
|
|
|
|
* `Scheduler::GetCurrent()` is typically used to create a mailbox and `ActorRef`
|
|
for an object that lives on the main thread and is not itself wrapped an
|
|
`Actor`. The underlying implementation of this Scheduler should usually be
|
|
a `RunLoop`
|
|
auto mailbox = std::make_shared<Mailbox>(*Scheduler::Get());
|
|
Actor<Worker> worker(threadPool, ActorRef<Foo>(*this, mailbox));
|
|
*/
|
|
class Scheduler {
|
|
public:
|
|
virtual ~Scheduler() = default;
|
|
virtual void schedule(std::weak_ptr<Mailbox>) = 0;
|
|
|
|
// Set/Get the current Scheduler for this thread
|
|
static Scheduler* GetCurrent();
|
|
static void SetCurrent(Scheduler*);
|
|
};
|
|
|
|
} // namespace mbgl
|