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/MultiSocketMonitor.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/MultiSocketMonitor.hxx')
| -rw-r--r-- | src/event/MultiSocketMonitor.hxx | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/src/event/MultiSocketMonitor.hxx b/src/event/MultiSocketMonitor.hxx index e2197fc90..7ca666246 100644 --- a/src/event/MultiSocketMonitor.hxx +++ b/src/event/MultiSocketMonitor.hxx @@ -47,7 +47,10 @@ class EventLoop; /** - * Monitor multiple sockets. + * Similar to #SocketMonitor, but monitors multiple sockets. To use + * it, implement the methods PrepareSockets() and DispatchSockets(). + * In PrepareSockets(), use UpdateSocketList() and AddSocket(). + * DispatchSockets() will be called if at least one socket is ready. */ class MultiSocketMonitor #ifdef USE_EPOLL |