doc: Remove superfluous comment already described in footnotes.
[mpd-mk.git] / src / event_pipe.h
blob33f92d44011ba21383ded5472b0b0755f0fa5730
1 /*
2 * Copyright (C) 2003-2009 The Music Player Daemon Project
3 * http://www.musicpd.org
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef EVENT_PIPE_H
21 #define EVENT_PIPE_H
23 #include <glib.h>
25 enum pipe_event {
26 /** database update was finished */
27 PIPE_EVENT_UPDATE,
29 /** during database update, a song was deleted */
30 PIPE_EVENT_DELETE,
32 /** an idle event was emitted */
33 PIPE_EVENT_IDLE,
35 /** must call playlist_sync() */
36 PIPE_EVENT_PLAYLIST,
38 /** the current song's tag has changed */
39 PIPE_EVENT_TAG,
41 /** SIGHUP received: reload configuration, roll log file */
42 PIPE_EVENT_RELOAD,
44 PIPE_EVENT_MAX
47 typedef void (*event_pipe_callback_t)(void);
49 void event_pipe_init(void);
51 void event_pipe_deinit(void);
53 void
54 event_pipe_register(enum pipe_event event, event_pipe_callback_t callback);
56 void event_pipe_emit(enum pipe_event event);
58 /**
59 * Similar to event_pipe_emit(), but aimed for use in signal handlers:
60 * it doesn't lock the mutex, and doesn't log on error. That makes it
61 * potentially lossy, but for its intended use, that does not matter.
63 void event_pipe_emit_fast(enum pipe_event event);
65 #endif /* MAIN_NOTIFY_H */