#include <dispatchable.h>
◆ Dispatchable() [1/2]
mir::dispatch::Dispatchable::Dispatchable |
( |
| ) |
|
|
default |
◆ ~Dispatchable()
virtual mir::dispatch::Dispatchable::~Dispatchable |
( |
| ) |
|
|
virtualdefault |
◆ Dispatchable() [2/2]
mir::dispatch::Dispatchable::Dispatchable |
( |
Dispatchable const & |
| ) |
|
|
delete |
◆ dispatch()
virtual bool mir::dispatch::Dispatchable::dispatch |
( |
FdEvents |
events | ) |
|
|
pure virtual |
Dispatch one pending event.
- Parameters
-
[in] | events | The set of events current on the file-descriptor |
- Returns
- False iff no more events will be produced by this Dispatchable. Dispatch should no longer be called.
- Note
- This will dispatch at most one event. If there are multiple events specified in
events
(eg: readable | remote_closed) then dispatch will process only one.
-
It is harmless to call dispatch() with an event that does not contain any of the events from relevant_events(). The function will do nothing in such a case.
-
An implementation of dispatch() MUST handle FdEvent::error, if only to return false and terminate further event dispatch.
Implemented in mir::dispatch::MultiplexingDispatchable, mir::dispatch::ActionQueue, and mir::dispatch::ReadableFd.
◆ operator=()
◆ relevant_events()
virtual FdEvents mir::dispatch::Dispatchable::relevant_events |
( |
| ) |
const |
|
pure virtual |
◆ watch_fd()
virtual Fd mir::dispatch::Dispatchable::watch_fd |
( |
| ) |
const |
|
pure virtual |
The documentation for this class was generated from the following file:
Copyright © 2012-2018
Canonical Ltd.
Generated on Sat Mar 31 14:22:42 UTC 2018