<!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/stats.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/stats.h File Reference</h1>
<p>MPD client library.
<a href="#_details">More...</a></p>
<p><a href="stats_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>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#ac29b9f0df5b202b0569101f129209aa3">mpd_send_stats</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_malloc struct <a class="el" href="structmpd__stats.html">mpd_stats</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#a32e012809fbcfb4d43b52fb0c552c912">mpd_stats_begin</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#a5c1226900cbb8ee349b360c2fe355988">mpd_stats_feed</a> (struct <a class="el" href="structmpd__stats.html">mpd_stats</a> *status, const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> *pair)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_malloc struct <a class="el" href="structmpd__stats.html">mpd_stats</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#a48958901ebbff8f309e0bb3b0ef0382f">mpd_recv_stats</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_malloc struct <a class="el" href="structmpd__stats.html">mpd_stats</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#aebc0d2b141425512584509d8133a1a3e">mpd_run_stats</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#aca8ad8a155a53a0b6ac8fc077e02a08f">mpd_stats_free</a> (struct <a class="el" href="structmpd__stats.html">mpd_stats</a> *stats)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#ad7408bbd88b1c0f38b5407fb11495441">mpd_stats_get_number_of_artists</a> (const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> *stats)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#a8857002df071b517b1d14cd8b8676a16">mpd_stats_get_number_of_albums</a> (const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> *stats)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#a7214dc6feff671b7dc663009452448ee">mpd_stats_get_number_of_songs</a> (const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> *stats)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#a3ce7b6cabc63f06d617c9bff856c6ccd">mpd_stats_get_uptime</a> (const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> *stats)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#a05a524757e5331d81990fb8bb4bca168">mpd_stats_get_db_update_time</a> (const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> *stats)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#acc493ddf85d6b75d58d9e5aeb33e9a38">mpd_stats_get_play_time</a> (const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> *stats)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="stats_8h.html#aa9748e5af3efd2e10b30d18932a28f39">mpd_stats_get_db_play_time</a> (const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> *stats)</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="stats_8h_source.html">stats.h</a>.</p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a48958901ebbff8f309e0bb3b0ef0382f"></a><!-- doxytag: member="stats.h::mpd_recv_stats" ref="a48958901ebbff8f309e0bb3b0ef0382f" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_malloc struct <a class="el" href="structmpd__stats.html">mpd_stats</a>* mpd_recv_stats </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><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads the "stats" response from MPD.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="structmpd__stats.html">mpd_stats</a> object, or NULL on error </dd></dl>
</div>
</div>
<a class="anchor" id="aebc0d2b141425512584509d8133a1a3e"></a><!-- doxytag: member="stats.h::mpd_run_stats" ref="aebc0d2b141425512584509d8133a1a3e" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_malloc struct <a class="el" href="structmpd__stats.html">mpd_stats</a>* mpd_run_stats </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><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shortcut for <a class="el" href="stats_8h.html#ac29b9f0df5b202b0569101f129209aa3">mpd_send_stats()</a> and <a class="el" href="stats_8h.html#a48958901ebbff8f309e0bb3b0ef0382f">mpd_recv_stats()</a>. </p>
</div>
</div>
<a class="anchor" id="ac29b9f0df5b202b0569101f129209aa3"></a><!-- doxytag: member="stats.h::mpd_send_stats" ref="ac29b9f0df5b202b0569101f129209aa3" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_stats </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>Send the "stats" command to MPD.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success </dd></dl>
</div>
</div>
<a class="anchor" id="a32e012809fbcfb4d43b52fb0c552c912"></a><!-- doxytag: member="stats.h::mpd_stats_begin" ref="a32e012809fbcfb4d43b52fb0c552c912" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_malloc struct <a class="el" href="structmpd__stats.html">mpd_stats</a>* mpd_stats_begin </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Begins parsing server stats: creates a new empty <a class="el" href="structmpd__stats.html">mpd_stats</a> object. Free it with <a class="el" href="stats_8h.html#aca8ad8a155a53a0b6ac8fc077e02a08f">mpd_stats_free()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the newly allocated <a class="el" href="structmpd__stats.html">mpd_stats</a> object, or NULL if out of memory </dd></dl>
</div>
</div>
<a class="anchor" id="a5c1226900cbb8ee349b360c2fe355988"></a><!-- doxytag: member="stats.h::mpd_stats_feed" ref="a5c1226900cbb8ee349b360c2fe355988" args="(struct mpd_stats *status, const struct mpd_pair *pair)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mpd_stats_feed </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__stats.html">mpd_stats</a> * </td>
<td class="paramname"> <em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses the pair, adding its information to the specified <a class="el" href="structmpd__stats.html">mpd_stats</a> object. </p>
</div>
</div>
<a class="anchor" id="aca8ad8a155a53a0b6ac8fc077e02a08f"></a><!-- doxytag: member="stats.h::mpd_stats_free" ref="aca8ad8a155a53a0b6ac8fc077e02a08f" args="(struct mpd_stats *stats)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mpd_stats_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__stats.html">mpd_stats</a> * </td>
<td class="paramname"> <em>stats</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Frees a <a class="el" href="structmpd__stats.html">mpd_stats</a> object. </p>
</div>
</div>
<a class="anchor" id="aa9748e5af3efd2e10b30d18932a28f39"></a><!-- doxytag: member="stats.h::mpd_stats_get_db_play_time" ref="aa9748e5af3efd2e10b30d18932a28f39" args="(const struct mpd_stats *stats)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure unsigned long mpd_stats_get_db_play_time </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> * </td>
<td class="paramname"> <em>stats</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the accumulated duration of all songs in the database, or 0 if unknown </dd></dl>
</div>
</div>
<a class="anchor" id="a05a524757e5331d81990fb8bb4bca168"></a><!-- doxytag: member="stats.h::mpd_stats_get_db_update_time" ref="a05a524757e5331d81990fb8bb4bca168" args="(const struct mpd_stats *stats)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure unsigned long mpd_stats_get_db_update_time </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> * </td>
<td class="paramname"> <em>stats</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the UNIX time stamp of the last database update, or 0 if unknown </dd></dl>
</div>
</div>
<a class="anchor" id="a8857002df071b517b1d14cd8b8676a16"></a><!-- doxytag: member="stats.h::mpd_stats_get_number_of_albums" ref="a8857002df071b517b1d14cd8b8676a16" args="(const struct mpd_stats *stats)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure unsigned mpd_stats_get_number_of_albums </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> * </td>
<td class="paramname"> <em>stats</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of distinct album names in MPD's database, or 0 if unknown </dd></dl>
</div>
</div>
<a class="anchor" id="ad7408bbd88b1c0f38b5407fb11495441"></a><!-- doxytag: member="stats.h::mpd_stats_get_number_of_artists" ref="ad7408bbd88b1c0f38b5407fb11495441" args="(const struct mpd_stats *stats)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure unsigned mpd_stats_get_number_of_artists </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> * </td>
<td class="paramname"> <em>stats</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of distinct artists in MPD's database, or 0 if unknown </dd></dl>
</div>
</div>
<a class="anchor" id="a7214dc6feff671b7dc663009452448ee"></a><!-- doxytag: member="stats.h::mpd_stats_get_number_of_songs" ref="a7214dc6feff671b7dc663009452448ee" args="(const struct mpd_stats *stats)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure unsigned mpd_stats_get_number_of_songs </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> * </td>
<td class="paramname"> <em>stats</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the total number of song files in MPD's database, or 0 if unknown </dd></dl>
</div>
</div>
<a class="anchor" id="acc493ddf85d6b75d58d9e5aeb33e9a38"></a><!-- doxytag: member="stats.h::mpd_stats_get_play_time" ref="acc493ddf85d6b75d58d9e5aeb33e9a38" args="(const struct mpd_stats *stats)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure unsigned long mpd_stats_get_play_time </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> * </td>
<td class="paramname"> <em>stats</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the accumulated time MPD was playing music since the process was started, or 0 if unknown </dd></dl>
</div>
</div>
<a class="anchor" id="a3ce7b6cabc63f06d617c9bff856c6ccd"></a><!-- doxytag: member="stats.h::mpd_stats_get_uptime" ref="a3ce7b6cabc63f06d617c9bff856c6ccd" args="(const struct mpd_stats *stats)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure unsigned long mpd_stats_get_uptime </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__stats.html">mpd_stats</a> * </td>
<td class="paramname"> <em>stats</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the uptime of MPD in seconds, or 0 if unknown </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sun Aug 8 15:52:36 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>
