<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libmpdclient: mpd/idle.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>mpd/idle.h File Reference</h1>
<p>MPD client library.
<a href="#_details">More...</a></p>
<p><a href="idle_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> { <br/>
<a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1caa7d7f15e077af7ba22ec549a6b5edf6d">MPD_IDLE_DATABASE</a> = 0x1,
<a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1ca960fab23b7d0909ff288eb74470d4147">MPD_IDLE_STORED_PLAYLIST</a> = 0x2,
<a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1ca3bb95093938b6b86e7156eaea57cbefd">MPD_IDLE_QUEUE</a> = 0x4,
<a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1caf72abefb5eca09550dd425570140b946">MPD_IDLE_PLAYLIST</a> = MPD_IDLE_QUEUE,
<br/>
<a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1ca5fdf5277e748c23bd8a6794599e6d44e">MPD_IDLE_PLAYER</a> = 0x8,
<a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1ca4e1200616802338dd1c8a65f9b4e1227">MPD_IDLE_MIXER</a> = 0x10,
<a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1ca1f79fa728a38f4d7b1ad3528b4e433be">MPD_IDLE_OUTPUT</a> = 0x20,
<a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1cac23f2d8ac5f403f4593ab115ccd47117">MPD_IDLE_OPTIONS</a> = 0x40,
<br/>
<a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1ca66baaed6b7f01a427771bd157baa4c7b">MPD_IDLE_UPDATE</a> = 0x80
<br/>
}</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_const const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="idle_8h.html#a2553463c392d89d77fbb7cc10ea1d03f">mpd_idle_name</a> (enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> idle)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="idle_8h.html#abc769b7729f141bb6345dac5c5b5d01f">mpd_idle_name_parse</a> (const char *name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="idle_8h.html#af4e4b0653c574964c627c77c71fdfd1d">mpd_send_idle</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="idle_8h.html#a07c634434af423c8111d524d262d7714">mpd_send_idle_mask</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> mask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="idle_8h.html#a453f947af7940ed84e5e60bb08152083">mpd_send_noidle</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="idle_8h.html#ad9f34dde8402a559b29cb142930fb152">mpd_idle_parse_pair</a> (const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> *pair)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="idle_8h.html#aba78bc0e0c15eeebde8390afb047ccf1">mpd_recv_idle</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, bool disable_timeout)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="idle_8h.html#a6395267b1ce6186a7cd02055fe3076d9">mpd_run_idle</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="idle_8h.html#a7284fb29f833fcce46e9fed88931d2aa">mpd_run_idle_mask</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> mask)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="idle_8h.html#a9f0aeb723428589e461171e127fb32a3">mpd_run_noidle</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>MPD client library. </p>
<p>Do not include this header directly. Use <a class="el" href="client_8h.html" title="MPD client library.">mpd/client.h</a> instead. </p>
<p>Definition in file <a class="el" href="idle_8h_source.html">idle.h</a>.</p>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a3378f7a24c714d7cb1058232330d7a1c"></a><!-- doxytag: member="idle.h::mpd_idle" ref="a3378f7a24c714d7cb1058232330d7a1c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This enum contains bit masks for all idle events. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a3378f7a24c714d7cb1058232330d7a1caa7d7f15e077af7ba22ec549a6b5edf6d"></a><!-- doxytag: member="MPD_IDLE_DATABASE" ref="a3378f7a24c714d7cb1058232330d7a1caa7d7f15e077af7ba22ec549a6b5edf6d" args="" -->MPD_IDLE_DATABASE</em> </td><td>
<p>song database has been updated </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3378f7a24c714d7cb1058232330d7a1ca960fab23b7d0909ff288eb74470d4147"></a><!-- doxytag: member="MPD_IDLE_STORED_PLAYLIST" ref="a3378f7a24c714d7cb1058232330d7a1ca960fab23b7d0909ff288eb74470d4147" args="" -->MPD_IDLE_STORED_PLAYLIST</em> </td><td>
<p>a stored playlist has been modified, created, deleted or renamed </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3378f7a24c714d7cb1058232330d7a1ca3bb95093938b6b86e7156eaea57cbefd"></a><!-- doxytag: member="MPD_IDLE_QUEUE" ref="a3378f7a24c714d7cb1058232330d7a1ca3bb95093938b6b86e7156eaea57cbefd" args="" -->MPD_IDLE_QUEUE</em> </td><td>
<p>the queue has been modified </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3378f7a24c714d7cb1058232330d7a1caf72abefb5eca09550dd425570140b946"></a><!-- doxytag: member="MPD_IDLE_PLAYLIST" ref="a3378f7a24c714d7cb1058232330d7a1caf72abefb5eca09550dd425570140b946" args="" -->MPD_IDLE_PLAYLIST</em> </td><td>
<p>deprecated, don't use </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3378f7a24c714d7cb1058232330d7a1ca5fdf5277e748c23bd8a6794599e6d44e"></a><!-- doxytag: member="MPD_IDLE_PLAYER" ref="a3378f7a24c714d7cb1058232330d7a1ca5fdf5277e748c23bd8a6794599e6d44e" args="" -->MPD_IDLE_PLAYER</em> </td><td>
<p>the player state has changed: play, stop, pause, seek, ... </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3378f7a24c714d7cb1058232330d7a1ca4e1200616802338dd1c8a65f9b4e1227"></a><!-- doxytag: member="MPD_IDLE_MIXER" ref="a3378f7a24c714d7cb1058232330d7a1ca4e1200616802338dd1c8a65f9b4e1227" args="" -->MPD_IDLE_MIXER</em> </td><td>
<p>the volume has been modified </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3378f7a24c714d7cb1058232330d7a1ca1f79fa728a38f4d7b1ad3528b4e433be"></a><!-- doxytag: member="MPD_IDLE_OUTPUT" ref="a3378f7a24c714d7cb1058232330d7a1ca1f79fa728a38f4d7b1ad3528b4e433be" args="" -->MPD_IDLE_OUTPUT</em> </td><td>
<p>an audio output device has been enabled or disabled </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3378f7a24c714d7cb1058232330d7a1cac23f2d8ac5f403f4593ab115ccd47117"></a><!-- doxytag: member="MPD_IDLE_OPTIONS" ref="a3378f7a24c714d7cb1058232330d7a1cac23f2d8ac5f403f4593ab115ccd47117" args="" -->MPD_IDLE_OPTIONS</em> </td><td>
<p>options have changed: crossfade, random, repeat, ... </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3378f7a24c714d7cb1058232330d7a1ca66baaed6b7f01a427771bd157baa4c7b"></a><!-- doxytag: member="MPD_IDLE_UPDATE" ref="a3378f7a24c714d7cb1058232330d7a1ca66baaed6b7f01a427771bd157baa4c7b" args="" -->MPD_IDLE_UPDATE</em> </td><td>
<p>a database update has started or finished. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="idle_8h_source.html#l00052">52</a> of file <a class="el" href="idle_8h_source.html">idle.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a2553463c392d89d77fbb7cc10ea1d03f"></a><!-- doxytag: member="idle.h::mpd_idle_name" ref="a2553463c392d89d77fbb7cc10ea1d03f" args="(enum mpd_idle idle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_const const char* mpd_idle_name </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> </td>
<td class="paramname"> <em>idle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the name of the specified idle event.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>idle</em> </td><td>an idle event id </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the name, or NULL if that event is not known </dd></dl>
</div>
</div>
<a class="anchor" id="abc769b7729f141bb6345dac5c5b5d01f"></a><!-- doxytag: member="idle.h::mpd_idle_name_parse" ref="abc769b7729f141bb6345dac5c5b5d01f" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> mpd_idle_name_parse </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses the name of an idle event.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>an idle event name </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the id, or 0 if that event is not known </dd></dl>
</div>
</div>
<a class="anchor" id="ad9f34dde8402a559b29cb142930fb152"></a><!-- doxytag: member="idle.h::mpd_idle_parse_pair" ref="ad9f34dde8402a559b29cb142930fb152" args="(const struct mpd_pair *pair)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> mpd_idle_parse_pair </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> * </td>
<td class="paramname"> <em>pair</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses a "changed" pair, which is part of MPD's response to the "idle" command.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>an idle code, or 0 if the pair was not understood </dd></dl>
</div>
</div>
<a class="anchor" id="aba78bc0e0c15eeebde8390afb047ccf1"></a><!-- doxytag: member="idle.h::mpd_recv_idle" ref="aba78bc0e0c15eeebde8390afb047ccf1" args="(struct mpd_connection *connection, bool disable_timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> mpd_recv_idle </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>disable_timeout</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Waits until MPD sends the list of idle events and returns it in a bit mask.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
<tr><td valign="top"></td><td valign="top"><em>disable_timeout</em> </td><td>if true, then libmpdclients temporarily disables the configured timeout (see <a class="el" href="connection_8h.html#aba4d70da6e9fb8508008281c725e275f">mpd_connection_set_timeout()</a>): this function blocks forever, until either MPD sends a response, or an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the event bit mask, or 0 on error or if there were no events </dd></dl>
</div>
</div>
<a class="anchor" id="a6395267b1ce6186a7cd02055fe3076d9"></a><!-- doxytag: member="idle.h::mpd_run_idle" ref="a6395267b1ce6186a7cd02055fe3076d9" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> mpd_run_idle </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shortcut for <a class="el" href="idle_8h.html#af4e4b0653c574964c627c77c71fdfd1d">mpd_send_idle()</a> and <a class="el" href="idle_8h.html#aba78bc0e0c15eeebde8390afb047ccf1">mpd_recv_idle()</a>. During <a class="el" href="idle_8h.html#aba78bc0e0c15eeebde8390afb047ccf1">mpd_recv_idle()</a>, the configured timeout is disabled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the event bit mask, or 0 on error </dd></dl>
</div>
</div>
<a class="anchor" id="a7284fb29f833fcce46e9fed88931d2aa"></a><!-- doxytag: member="idle.h::mpd_run_idle_mask" ref="a7284fb29f833fcce46e9fed88931d2aa" args="(struct mpd_connection *connection, enum mpd_idle mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> mpd_run_idle_mask </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> </td>
<td class="paramname"> <em>mask</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shortcut for <a class="el" href="idle_8h.html#a07c634434af423c8111d524d262d7714">mpd_send_idle_mask()</a> and <a class="el" href="idle_8h.html#aba78bc0e0c15eeebde8390afb047ccf1">mpd_recv_idle()</a>. During <a class="el" href="idle_8h.html#aba78bc0e0c15eeebde8390afb047ccf1">mpd_recv_idle()</a>, the configured timeout is disabled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mask</em> </td><td>a bit mask of idle events; must not be 0 </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the event bit mask, or 0 on error </dd></dl>
</div>
</div>
<a class="anchor" id="a9f0aeb723428589e461171e127fb32a3"></a><!-- doxytag: member="idle.h::mpd_run_noidle" ref="a9f0aeb723428589e461171e127fb32a3" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> mpd_run_noidle </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shortcut for <a class="el" href="idle_8h.html#a453f947af7940ed84e5e60bb08152083">mpd_send_noidle()</a> and <a class="el" href="idle_8h.html#aba78bc0e0c15eeebde8390afb047ccf1">mpd_recv_idle()</a>. During <a class="el" href="idle_8h.html#aba78bc0e0c15eeebde8390afb047ccf1">mpd_recv_idle()</a>, the configured timeout is not disabled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the event bit mask, or 0 on error or if there were no events </dd></dl>
</div>
</div>
<a class="anchor" id="af4e4b0653c574964c627c77c71fdfd1d"></a><!-- doxytag: member="idle.h::mpd_send_idle" ref="af4e4b0653c574964c627c77c71fdfd1d" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_idle </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enters "idle" mode: MPD will stall the response until an event has occurred. Call <a class="el" href="idle_8h.html#a453f947af7940ed84e5e60bb08152083">mpd_send_noidle()</a> to abort the idle mode, or <a class="el" href="idle_8h.html#aba78bc0e0c15eeebde8390afb047ccf1">mpd_recv_idle()</a> to read the event mask (or synchronously wait for events). </p>
</div>
</div>
<a class="anchor" id="a07c634434af423c8111d524d262d7714"></a><!-- doxytag: member="idle.h::mpd_send_idle_mask" ref="a07c634434af423c8111d524d262d7714" args="(struct mpd_connection *connection, enum mpd_idle mask)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_idle_mask </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="idle_8h.html#a3378f7a24c714d7cb1058232330d7a1c">mpd_idle</a> </td>
<td class="paramname"> <em>mask</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Same as <a class="el" href="idle_8h.html#af4e4b0653c574964c627c77c71fdfd1d">mpd_send_idle()</a>, but listen only on specific events.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mask</em> </td><td>a bit mask of idle events; must not be 0 </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a positive job id on success, 0 on error </dd></dl>
</div>
</div>
<a class="anchor" id="a453f947af7940ed84e5e60bb08152083"></a><!-- doxytag: member="idle.h::mpd_send_noidle" ref="a453f947af7940ed84e5e60bb08152083" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_noidle </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tells MPD to leave the "idle" mode. MPD will then respond with a list of events which have occurred (which may be empty). Call <a class="el" href="idle_8h.html#aba78bc0e0c15eeebde8390afb047ccf1">mpd_recv_idle()</a> after that. </p>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sun Aug 8 15:52:35 2010 for libmpdclient by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
