add new api docs.
[lms] / www / api / structlms.html
diff --git a/www/api/structlms.html b/www/api/structlms.html
new file mode 100644 (file)
index 0000000..909c5c0
--- /dev/null
@@ -0,0 +1,299 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Light Media Scanner: lms Struct 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.5.8 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+      <li><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
+      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<h1>lms Struct Reference</h1><!-- doxytag: class="lms" --><code>#include &lt;<a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>&gt;</code>
+<p>
+<div class="dynheader">
+Collaboration diagram for lms:</div>
+<div class="dynsection">
+<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structparser.html">parser</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlms.html#52883423c9a1276420ba2bb9b50a138c">parsers</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlms.html#9cdd3a937a0a2bd4515e9e888bb519e3">n_parsers</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__LMS__CHARSET.html#g50e57a19bb3d062fe7eea437a8b8e949">lms_charset_conv_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlms.html#eba2db305bafddedf143ff7b9f2396db">cs_conv</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlms.html#02e767169813808f193c23733ba89b4b">db_path</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlms.html#0f545adf2fc37994b7f55f7ea7aac555">slave_timeout</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap>struct {</td></tr>
+
+<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="lightmediascanner_8h.html#117b4bb24ec8fc48fc4e6f0d7fa9ea3a">lms_progress_callback_t</a>&nbsp;&nbsp;&nbsp;<a class="el" href="structlms.html#94615d22fba40d580a8a0055d28221c4">cb</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;void *&nbsp;&nbsp;&nbsp;<a class="el" href="structlms.html#2416f15bfd15aaa5e75606b5a0686362">data</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="lightmediascanner_8h.html#55ee3894f334dc5b30431bf94971f110">lms_free_callback_t</a>&nbsp;&nbsp;&nbsp;<a class="el" href="structlms.html#3f04a1830b8ffa69c9da089b7e6fb258">free_data</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlms.html#3f4bc299aa74c9255b730e106e0e7a8f">progress</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlms.html#1dc82aac2ab3ff643027878bb1aa3cb8">commit_interval</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlms.html#bb03533445b77299e964b2ec02bca039">is_processing</a>:1</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlms.html#d028e3681568215f6facd7d477c74461">stop_processing</a>:1</td></tr>
+
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+
+<p>Definition at line <a class="el" href="lightmediascanner__private_8h-source.html#l00076">76</a> of file <a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>.</p>
+<hr><h2>Field Documentation</h2>
+<a class="anchor" name="94615d22fba40d580a8a0055d28221c4"></a><!-- doxytag: member="lms::cb" ref="94615d22fba40d580a8a0055d28221c4" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="lightmediascanner_8h.html#117b4bb24ec8fc48fc4e6f0d7fa9ea3a">lms_progress_callback_t</a> <a class="el" href="structlms.html#94615d22fba40d580a8a0055d28221c4">lms::cb</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Definition at line <a class="el" href="lightmediascanner__private_8h-source.html#l00083">83</a> of file <a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>.</p>
+
+<p>Referenced by <a class="el" href="lightmediascanner_8c-source.html#l00195">lms_set_progress_callback()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="1dc82aac2ab3ff643027878bb1aa3cb8"></a><!-- doxytag: member="lms::commit_interval" ref="1dc82aac2ab3ff643027878bb1aa3cb8" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">unsigned int <a class="el" href="structlms.html#1dc82aac2ab3ff643027878bb1aa3cb8">lms::commit_interval</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Definition at line <a class="el" href="lightmediascanner__private_8h-source.html#l00087">87</a> of file <a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>.</p>
+
+<p>Referenced by <a class="el" href="lightmediascanner_8c-source.html#l00449">lms_get_commit_interval()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00121">lms_new()</a>, and <a class="el" href="lightmediascanner_8c-source.html#l00472">lms_set_commit_interval()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="eba2db305bafddedf143ff7b9f2396db"></a><!-- doxytag: member="lms::cs_conv" ref="eba2db305bafddedf143ff7b9f2396db" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="group__LMS__CHARSET.html#g50e57a19bb3d062fe7eea437a8b8e949">lms_charset_conv_t</a>* <a class="el" href="structlms.html#eba2db305bafddedf143ff7b9f2396db">lms::cs_conv</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Definition at line <a class="el" href="lightmediascanner__private_8h-source.html#l00079">79</a> of file <a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>.</p>
+
+<p>Referenced by <a class="el" href="lightmediascanner_8c-source.html#l00496">lms_charset_add()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00519">lms_charset_del()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00159">lms_free()</a>, and <a class="el" href="lightmediascanner_8c-source.html#l00121">lms_new()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="2416f15bfd15aaa5e75606b5a0686362"></a><!-- doxytag: member="lms::data" ref="2416f15bfd15aaa5e75606b5a0686362" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void* <a class="el" href="structlms.html#2416f15bfd15aaa5e75606b5a0686362">lms::data</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Definition at line <a class="el" href="lightmediascanner__private_8h-source.html#l00084">84</a> of file <a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>.</p>
+
+<p>Referenced by <a class="el" href="lightmediascanner_8c-source.html#l00159">lms_free()</a>, and <a class="el" href="lightmediascanner_8c-source.html#l00195">lms_set_progress_callback()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="02e767169813808f193c23733ba89b4b"></a><!-- doxytag: member="lms::db_path" ref="02e767169813808f193c23733ba89b4b" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">char* <a class="el" href="structlms.html#02e767169813808f193c23733ba89b4b">lms::db_path</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Definition at line <a class="el" href="lightmediascanner__private_8h-source.html#l00080">80</a> of file <a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>.</p>
+
+<p>Referenced by <a class="el" href="lightmediascanner_8c-source.html#l00159">lms_free()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00385">lms_get_db_path()</a>, and <a class="el" href="lightmediascanner_8c-source.html#l00121">lms_new()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="3f04a1830b8ffa69c9da089b7e6fb258"></a><!-- doxytag: member="lms::free_data" ref="3f04a1830b8ffa69c9da089b7e6fb258" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="lightmediascanner_8h.html#55ee3894f334dc5b30431bf94971f110">lms_free_callback_t</a> <a class="el" href="structlms.html#3f04a1830b8ffa69c9da089b7e6fb258">lms::free_data</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Definition at line <a class="el" href="lightmediascanner__private_8h-source.html#l00085">85</a> of file <a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>.</p>
+
+<p>Referenced by <a class="el" href="lightmediascanner_8c-source.html#l00159">lms_free()</a>, and <a class="el" href="lightmediascanner_8c-source.html#l00195">lms_set_progress_callback()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="bb03533445b77299e964b2ec02bca039"></a><!-- doxytag: member="lms::is_processing" ref="bb03533445b77299e964b2ec02bca039" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">unsigned int <a class="el" href="structlms.html#bb03533445b77299e964b2ec02bca039">lms::is_processing</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Definition at line <a class="el" href="lightmediascanner__private_8h-source.html#l00088">88</a> of file <a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>.</p>
+
+<p>Referenced by <a class="el" href="lightmediascanner__check_8c-source.html#l00900">lms_check()</a>, <a class="el" href="lightmediascanner__check_8c-source.html#l00949">lms_check_single_process()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00159">lms_free()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00366">lms_is_processing()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00221">lms_parser_add()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00334">lms_parser_del()</a>, and <a class="el" href="lightmediascanner__process_8c-source.html#l01082">lms_stop_processing()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="9cdd3a937a0a2bd4515e9e888bb519e3"></a><!-- doxytag: member="lms::n_parsers" ref="9cdd3a937a0a2bd4515e9e888bb519e3" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int <a class="el" href="structlms.html#9cdd3a937a0a2bd4515e9e888bb519e3">lms::n_parsers</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Definition at line <a class="el" href="lightmediascanner__private_8h-source.html#l00078">78</a> of file <a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>.</p>
+
+<p>Referenced by <a class="el" href="lightmediascanner_8c-source.html#l00159">lms_free()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00221">lms_parser_add()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00334">lms_parser_del()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00294">lms_parser_del_int()</a>, <a class="el" href="lightmediascanner__process_8c-source.html#l00367">lms_parsers_check_using()</a>, <a class="el" href="lightmediascanner__process_8c-source.html#l00345">lms_parsers_finish()</a>, <a class="el" href="lightmediascanner__process_8c-source.html#l00387">lms_parsers_run()</a>, <a class="el" href="lightmediascanner__process_8c-source.html#l00293">lms_parsers_setup()</a>, and <a class="el" href="lightmediascanner__process_8c-source.html#l00319">lms_parsers_start()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="52883423c9a1276420ba2bb9b50a138c"></a><!-- doxytag: member="lms::parsers" ref="52883423c9a1276420ba2bb9b50a138c" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">struct <a class="el" href="structparser.html">parser</a>* <a class="el" href="structlms.html#52883423c9a1276420ba2bb9b50a138c">lms::parsers</a><code> [read]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Definition at line <a class="el" href="lightmediascanner__private_8h-source.html#l00077">77</a> of file <a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>.</p>
+
+<p>Referenced by <a class="el" href="lightmediascanner_8c-source.html#l00159">lms_free()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00221">lms_parser_add()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00334">lms_parser_del()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00294">lms_parser_del_int()</a>, <a class="el" href="lightmediascanner__process_8c-source.html#l00367">lms_parsers_check_using()</a>, <a class="el" href="lightmediascanner__process_8c-source.html#l00345">lms_parsers_finish()</a>, <a class="el" href="lightmediascanner__process_8c-source.html#l00387">lms_parsers_run()</a>, <a class="el" href="lightmediascanner__process_8c-source.html#l00293">lms_parsers_setup()</a>, and <a class="el" href="lightmediascanner__process_8c-source.html#l00319">lms_parsers_start()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="3f4bc299aa74c9255b730e106e0e7a8f"></a><!-- doxytag: member="lms::progress" ref="3f4bc299aa74c9255b730e106e0e7a8f" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">struct { ... }   <a class="el" href="structlms.html#3f4bc299aa74c9255b730e106e0e7a8f">lms::progress</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Referenced by <a class="el" href="lightmediascanner_8c-source.html#l00159">lms_free()</a>, and <a class="el" href="lightmediascanner_8c-source.html#l00195">lms_set_progress_callback()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="0f545adf2fc37994b7f55f7ea7aac555"></a><!-- doxytag: member="lms::slave_timeout" ref="0f545adf2fc37994b7f55f7ea7aac555" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int <a class="el" href="structlms.html#0f545adf2fc37994b7f55f7ea7aac555">lms::slave_timeout</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Definition at line <a class="el" href="lightmediascanner__private_8h-source.html#l00081">81</a> of file <a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>.</p>
+
+<p>Referenced by <a class="el" href="lightmediascanner_8c-source.html#l00407">lms_get_slave_timeout()</a>, <a class="el" href="lightmediascanner_8c-source.html#l00121">lms_new()</a>, and <a class="el" href="lightmediascanner_8c-source.html#l00427">lms_set_slave_timeout()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="d028e3681568215f6facd7d477c74461"></a><!-- doxytag: member="lms::stop_processing" ref="d028e3681568215f6facd7d477c74461" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">unsigned int <a class="el" href="structlms.html#d028e3681568215f6facd7d477c74461">lms::stop_processing</a>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Definition at line <a class="el" href="lightmediascanner__private_8h-source.html#l00089">89</a> of file <a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a>.</p>
+
+<p>Referenced by <a class="el" href="lightmediascanner__check_8c-source.html#l00900">lms_check()</a>, <a class="el" href="lightmediascanner__check_8c-source.html#l00949">lms_check_single_process()</a>, and <a class="el" href="lightmediascanner__process_8c-source.html#l01082">lms_stop_processing()</a>.</p>
+
+</div>
+</div><p>
+<hr>The documentation for this struct was generated from the following file:<ul>
+<li>src/lib/<a class="el" href="lightmediascanner__private_8h-source.html">lightmediascanner_private.h</a></ul>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Wed Apr 22 23:56:01 2009 for Light Media Scanner by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+</body>
+</html>