mpd/src/event/IdleEvent.hxx
2021-01-01 19:59:15 +01:00

62 lines
1.6 KiB
C++

/*
* Copyright 2003-2021 The Music Player Daemon Project
* http://www.musicpd.org
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef MPD_SOCKET_IDLE_EVENT_HXX
#define MPD_SOCKET_IDLE_EVENT_HXX
#include "DeferEvent.hxx"
class EventLoop;
/**
* An event that runs when the EventLoop has become idle, before
* waiting for more events.
*
* This class is not thread-safe, all methods must be called from the
* thread that runs the #EventLoop, except where explicitly documented
* as thread-safe.
*/
class IdleEvent final {
DeferEvent event;
using Callback = BoundMethod<void() noexcept>;
public:
IdleEvent(EventLoop &_loop, Callback _callback) noexcept
:event(_loop, _callback) {}
auto &GetEventLoop() const noexcept {
return event.GetEventLoop();
}
bool IsPending() const noexcept {
return event.IsPending();
}
void Schedule() noexcept {
event.ScheduleIdle();
}
void Cancel() noexcept {
event.Cancel();
}
};
#endif