Program Listing for File dispatchable.h

↰ Return to documentation for file (/home/docs/checkouts/readthedocs.org/user_builds/canonical-mir-documentation/checkouts/2.30/include/common/mir/dispatch/dispatchable.h)

/*
 * Copyright © 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 2 or 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/>.
 */

#ifndef MIR_DISPATCH_DISPATCHABLE_H_
#define MIR_DISPATCH_DISPATCHABLE_H_

#include <mir/fd.h>
#include <cstdint>

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;

    virtual Fd watch_fd() const = 0;

    virtual bool dispatch(FdEvents events) = 0;

    virtual FdEvents relevant_events() const = 0;
};
}
}

#endif // MIR_DISPATCH_DISPATCHABLE_H_