diff options
| author | Max Kellermann <max@duempel.org> | 2013-11-24 19:28:04 +0100 |
|---|---|---|
| committer | Max Kellermann <max@duempel.org> | 2013-11-24 19:28:04 +0100 |
| commit | e53a25cbaee50fdf6b9a4a118677709b47bac4cd (patch) | |
| tree | 5cfa456cb999bfcbf073ed9e5fd18e30972ee6e7 /src/event/TimeoutMonitor.hxx | |
| parent | 41e714597360072b9c765a8265272158d9821bc4 (diff) | |
| download | mpd-e53a25cbaee50fdf6b9a4a118677709b47bac4cd.tar.gz mpd-e53a25cbaee50fdf6b9a4a118677709b47bac4cd.tar.xz mpd-e53a25cbaee50fdf6b9a4a118677709b47bac4cd.zip | |
event: add API documentation
Diffstat (limited to 'src/event/TimeoutMonitor.hxx')
| -rw-r--r-- | src/event/TimeoutMonitor.hxx | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/event/TimeoutMonitor.hxx b/src/event/TimeoutMonitor.hxx index 98e4e5564..aa2bbea39 100644 --- a/src/event/TimeoutMonitor.hxx +++ b/src/event/TimeoutMonitor.hxx @@ -28,6 +28,10 @@ class EventLoop; +/** + * This class monitors a timeout. Use Schedule() to begin the timeout + * or Cancel() to cancel it. + */ class TimeoutMonitor { #ifdef USE_EPOLL friend class EventLoop; |