mirror
/
libx52
mirror of https://github.com/nirenjan/libx52.git
1
0
Fork 0
Code Releases Wiki Activity

deploy: 87bf5881dd

gh-pages
nirenjan 2021-11-07 15:56:48 +00:00
parent 60ae016d14
commit 9078ff08c6
7 changed files with 30 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
globals.html
View File

@ -533,7 +533,7 @@ $(function() {
: <a class="el" href="group__x52dcomm.html#ga59b382427afc417499311336747fb191">x52dcomm.h</a>
</li>
<li>x52d_send_command()
: <a class="el" href="group__x52dcomm.html#gad72175611919fcafc0a0533b7a01f167">x52dcomm.h</a>
: <a class="el" href="group__x52dcomm.html#gaef9b481c4e5faaac14e2681cb64c3faa">x52dcomm.h</a>
</li>
</ul>
</div><!-- contents -->

2
globals_func.html
View File

@ -200,7 +200,7 @@ $(function() {
: <a class="el" href="group__x52dcomm.html#ga59b382427afc417499311336747fb191">x52dcomm.h</a>
</li>
<li>x52d_send_command()
: <a class="el" href="group__x52dcomm.html#gad72175611919fcafc0a0533b7a01f167">x52dcomm.h</a>
: <a class="el" href="group__x52dcomm.html#gaef9b481c4e5faaac14e2681cb64c3faa">x52dcomm.h</a>
</li>
</ul>
</div><!-- contents -->

23
group__x52dcomm.html
View File

@ -78,9 +78,9 @@ Functions</h2></td></tr>
<tr class="memitem:ga59b382427afc417499311336747fb191"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__x52dcomm.html#ga59b382427afc417499311336747fb191">x52d_dial_command</a> (const char *sock_path)</td></tr>
<tr class="memdesc:ga59b382427afc417499311336747fb191"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a connection to the daemon. <a href="group__x52dcomm.html#ga59b382427afc417499311336747fb191">More...</a><br /></td></tr>
<tr class="separator:ga59b382427afc417499311336747fb191"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad72175611919fcafc0a0533b7a01f167"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__x52dcomm.html#gad72175611919fcafc0a0533b7a01f167">x52d_send_command</a> (int sock_fd, char *buffer, size_t buflen)</td></tr>
<tr class="memdesc:gad72175611919fcafc0a0533b7a01f167"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a command to the daemon and retrieve the response. <a href="group__x52dcomm.html#gad72175611919fcafc0a0533b7a01f167">More...</a><br /></td></tr>
<tr class="separator:gad72175611919fcafc0a0533b7a01f167"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef9b481c4e5faaac14e2681cb64c3faa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__x52dcomm.html#gaef9b481c4e5faaac14e2681cb64c3faa">x52d_send_command</a> (int sock_fd, char *buffer, size_t bufin, size_t bufout)</td></tr>
<tr class="memdesc:gaef9b481c4e5faaac14e2681cb64c3faa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a command to the daemon and retrieve the response. <a href="group__x52dcomm.html#gaef9b481c4e5faaac14e2681cb64c3faa">More...</a><br /></td></tr>
<tr class="separator:gaef9b481c4e5faaac14e2681cb64c3faa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>These functions are used to communicate with the X52 daemon. </p>
@ -103,7 +103,7 @@ Functions</h2></td></tr>
<p>Open a connection to the daemon. </p>
<p>This method opens a socket connection to the daemon command socket. This socket allows the client to issue commands and retrieve data. The <code>sock_path</code> parameter may be NULL, in which case, it will use the default socket path.</p>
<p>The client will need to use the returned descriptor to communicate with the daemon using <a class="el" href="group__x52dcomm.html#gad72175611919fcafc0a0533b7a01f167">x52d_send_command</a>. Once finished, the client may use the <code>close(2)</code> method to close the file descriptor.</p>
<p>The client will need to use the returned descriptor to communicate with the daemon using <a class="el" href="group__x52dcomm.html#gaef9b481c4e5faaac14e2681cb64c3faa">x52d_send_command</a>. Once finished, the client may use the <code>close(2)</code> method to close the file descriptor.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sock_path</td><td>Path to the daemon command socket.</td></tr>
@ -122,8 +122,8 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gad72175611919fcafc0a0533b7a01f167"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad72175611919fcafc0a0533b7a01f167">&#9670;&nbsp;</a></span>x52d_send_command()</h2>
<a id="gaef9b481c4e5faaac14e2681cb64c3faa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaef9b481c4e5faaac14e2681cb64c3faa">&#9670;&nbsp;</a></span>x52d_send_command()</h2>
<div class="memitem">
<div class="memproto">
@ -144,7 +144,13 @@ Functions</h2></td></tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>buflen</em>&#160;</td>
<td class="paramname"><em>bufin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>bufout</em>&#160;</td>
</tr>
<tr>
<td></td>
@ -162,7 +168,8 @@ Functions</h2></td></tr>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sock_fd</td><td>Socket descriptor returned from <a class="el" href="group__x52dcomm.html#ga59b382427afc417499311336747fb191">x52d_dial_command</a></td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">buffer</td><td>Pointer to the string containing the command and parameters. This is also used to save the returned response.</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buflen</td><td>Length of the buffer to hold the returned response.</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bufin</td><td>Length of the command in the input buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bufout</td><td>Maximum length of the response</td></tr>
</table>
</dd>
</dl>

2
search/all_a.js
View File

@ -2,6 +2,6 @@ var searchData=
[
['x52_20driver_20daemon_177',['X52 driver daemon',['../x52d.html',1,'']]],
['x52d_5fdial_5fcommand_178',['x52d_dial_command',['../group__x52dcomm.html#ga59b382427afc417499311336747fb191',1,'x52dcomm.h']]],
['x52d_5fsend_5fcommand_179',['x52d_send_command',['../group__x52dcomm.html#gad72175611919fcafc0a0533b7a01f167',1,'x52dcomm.h']]],
['x52d_5fsend_5fcommand_179',['x52d_send_command',['../group__x52dcomm.html#gaef9b481c4e5faaac14e2681cb64c3faa',1,'x52dcomm.h']]],
['x52dcomm_2eh_180',['x52dcomm.h',['../x52dcomm_8h.html',1,'']]]
];

2
search/functions_1.js
View File

@ -1,5 +1,5 @@
var searchData=
[
['x52d_5fdial_5fcommand_228',['x52d_dial_command',['../group__x52dcomm.html#ga59b382427afc417499311336747fb191',1,'x52dcomm.h']]],
['x52d_5fsend_5fcommand_229',['x52d_send_command',['../group__x52dcomm.html#gad72175611919fcafc0a0533b7a01f167',1,'x52dcomm.h']]]
['x52d_5fsend_5fcommand_229',['x52d_send_command',['../group__x52dcomm.html#gaef9b481c4e5faaac14e2681cb64c3faa',1,'x52dcomm.h']]]
];

6
x52dcomm_8h.html
View File

@ -84,9 +84,9 @@ Functions</h2></td></tr>
<tr class="memitem:ga59b382427afc417499311336747fb191"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__x52dcomm.html#ga59b382427afc417499311336747fb191">x52d_dial_command</a> (const char *sock_path)</td></tr>
<tr class="memdesc:ga59b382427afc417499311336747fb191"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a connection to the daemon. <a href="group__x52dcomm.html#ga59b382427afc417499311336747fb191">More...</a><br /></td></tr>
<tr class="separator:ga59b382427afc417499311336747fb191"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad72175611919fcafc0a0533b7a01f167"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__x52dcomm.html#gad72175611919fcafc0a0533b7a01f167">x52d_send_command</a> (int sock_fd, char *buffer, size_t buflen)</td></tr>
<tr class="memdesc:gad72175611919fcafc0a0533b7a01f167"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a command to the daemon and retrieve the response. <a href="group__x52dcomm.html#gad72175611919fcafc0a0533b7a01f167">More...</a><br /></td></tr>
<tr class="separator:gad72175611919fcafc0a0533b7a01f167"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef9b481c4e5faaac14e2681cb64c3faa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__x52dcomm.html#gaef9b481c4e5faaac14e2681cb64c3faa">x52d_send_command</a> (int sock_fd, char *buffer, size_t bufin, size_t bufout)</td></tr>
<tr class="memdesc:gaef9b481c4e5faaac14e2681cb64c3faa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a command to the daemon and retrieve the response. <a href="group__x52dcomm.html#gaef9b481c4e5faaac14e2681cb64c3faa">More...</a><br /></td></tr>
<tr class="separator:gaef9b481c4e5faaac14e2681cb64c3faa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Functions, structures and enumerations for the Saitek X52 MFD &amp; LED daemon communication library. </p>

16
x52dcomm_8h_source.html
View File

@ -90,17 +90,17 @@ $(function() {
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__x52dcomm.html#ga59b382427afc417499311336747fb191">x52d_dial_command</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *sock_path);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__x52dcomm.html#gad72175611919fcafc0a0533b7a01f167">x52d_send_command</a>(<span class="keywordtype">int</span> sock_fd, <span class="keywordtype">char</span> *buffer, <span class="keywordtype">size_t</span> buflen);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;}</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#endif // !defined X52DCOMM_H</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__x52dcomm.html#gaef9b481c4e5faaac14e2681cb64c3faa">x52d_send_command</a>(<span class="keywordtype">int</span> sock_fd, <span class="keywordtype">char</span> *buffer, <span class="keywordtype">size_t</span> bufin, <span class="keywordtype">size_t</span> bufout);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;}</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="preprocessor">#endif // !defined X52DCOMM_H</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="agroup__x52dcomm_html_ga59b382427afc417499311336747fb191"><div class="ttname"><a href="group__x52dcomm.html#ga59b382427afc417499311336747fb191">x52d_dial_command</a></div><div class="ttdeci">int x52d_dial_command(const char *sock_path)</div><div class="ttdoc">Open a connection to the daemon.</div></div>
<div class="ttc" id="agroup__x52dcomm_html_gad72175611919fcafc0a0533b7a01f167"><div class="ttname"><a href="group__x52dcomm.html#gad72175611919fcafc0a0533b7a01f167">x52d_send_command</a></div><div class="ttdeci">int x52d_send_command(int sock_fd, char *buffer, size_t buflen)</div><div class="ttdoc">Send a command to the daemon and retrieve the response.</div></div>
<div class="ttc" id="agroup__x52dcomm_html_gaef9b481c4e5faaac14e2681cb64c3faa"><div class="ttname"><a href="group__x52dcomm.html#gaef9b481c4e5faaac14e2681cb64c3faa">x52d_send_command</a></div><div class="ttdeci">int x52d_send_command(int sock_fd, char *buffer, size_t bufin, size_t bufout)</div><div class="ttdoc">Send a command to the daemon and retrieve the response.</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">