/usr/include/mircommon/mir/dispatch/dispatchable.h is in libmircommon-dev 0.26.3+16.04.20170605-0ubuntu1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
* Copyright © 2015 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authored by: Christopher James Halse Rogers <christopher.halse.rogers@canonical.com>
*/
#ifndef MIR_DISPATCH_DISPATCHABLE_H_
#define MIR_DISPATCH_DISPATCHABLE_H_
#include "mir/fd.h"
namespace mir
{
namespace dispatch
{
enum FdEvent : uint32_t {
readable = 1<<0,
writable = 1<<1,
remote_closed = 1<<2,
error = 1<<3
};
using FdEvents = uint32_t;
class Dispatchable
{
public:
Dispatchable() = default;
virtual ~Dispatchable() = default;
Dispatchable& operator=(Dispatchable const&) = delete;
Dispatchable(Dispatchable const&) = delete;
/**
* \brief Get a poll()able file descriptor
* \return A file descriptor usable with poll() or equivalent function calls.
* relevant_events() contains the set of event types to watch for.
*/
virtual Fd watch_fd() const = 0;
/**
* \brief Dispatch one pending event
* \param [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 \p events (eg: readable | remote_closed) then dispatch
* will process only one.
* \note 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.
* \note An implementation of dispatch() MUST handle FdEvent::error,
* if only to return false and terminate further event dispatch.
*/
virtual bool dispatch(FdEvents events) = 0;
/**
* \brief The set of file-descriptor events this Dispatchable handles.
*/
virtual FdEvents relevant_events() const = 0;
};
}
}
#endif // MIR_DISPATCH_DISPATCHABLE_H_
|