mirror of https://github.com/nirenjan/libx52.git
122 lines
11 KiB
HTML
122 lines
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libx52: /home/runner/work/libx52/libx52/daemon/x52dcomm.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">libx52
|
|
 <span id="projectnumber">0.3.0</span>
|
|
</div>
|
|
<div id="projectbrief">Saitek X52/X52Pro drivers for Linux/Unix</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_39030b11ec2f66a58a20203c6f23f032.html">daemon</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">x52dcomm.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="x52dcomm_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Saitek X52 Pro MFD & LED driver</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (C) 2021 Nirenjan Krishnan (nirenjan@nirenjan.org)</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * SPDX-License-Identifier: GPL-2.0-only WITH Classpath-exception-2.0</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef X52DCOMM_H</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define X52DCOMM_H</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <stddef.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="group__x52dcomm.html#ga59b382427afc417499311336747fb191"> 55</a></span> <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>  </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="group__x52dcomm.html#gadfb485d611919a9a5a6dea019794f0e8"> 76</a></span> <span class="keywordtype">int</span> <a class="code" href="group__x52dcomm.html#gadfb485d611919a9a5a6dea019794f0e8">x52d_dial_notify</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *sock_path);</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="group__x52dcomm.html#ga667ce343cc456bcb63221258bc35ad4e"> 95</a></span> <span class="keywordtype">int</span> <a class="code" href="group__x52dcomm.html#ga667ce343cc456bcb63221258bc35ad4e">x52d_format_command</a>(<span class="keywordtype">int</span> argc, <span class="keyword">const</span> <span class="keywordtype">char</span> **argv, <span class="keywordtype">char</span> *buffer, <span class="keywordtype">size_t</span> buflen);</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="group__x52dcomm.html#gaef9b481c4e5faaac14e2681cb64c3faa"> 124</a></span> <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="l00125"></a><span class="lineno"> 125</span>  </div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="group__x52dcomm.html#ga9a817265ac0e43fb191efe3347922df8"> 129</a></span> <span class="keyword">typedef</span> int (* <a class="code" href="group__x52dcomm.html#ga9a817265ac0e43fb191efe3347922df8">x52d_notify_callback_fn</a>)(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv);</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  </div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"><a class="line" href="group__x52dcomm.html#ga0494e9f6fa20d568878f893f3474ed1c"> 150</a></span> <span class="keywordtype">int</span> <a class="code" href="group__x52dcomm.html#ga0494e9f6fa20d568878f893f3474ed1c">x52d_recv_notification</a>(<span class="keywordtype">int</span> sock_fd, <a class="code" href="group__x52dcomm.html#ga9a817265ac0e43fb191efe3347922df8">x52d_notify_callback_fn</a> callback);</div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  </div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> }</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="preprocessor">#endif </span><span class="comment">// !defined X52DCOMM_H</span></div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  </div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  </div>
|
|
<div class="ttc" id="agroup__x52dcomm_html_ga0494e9f6fa20d568878f893f3474ed1c"><div class="ttname"><a href="group__x52dcomm.html#ga0494e9f6fa20d568878f893f3474ed1c">x52d_recv_notification</a></div><div class="ttdeci">int x52d_recv_notification(int sock_fd, x52d_notify_callback_fn callback)</div><div class="ttdoc">Receive a notification from the daemon.</div></div>
|
|
<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 command socket.</div></div>
|
|
<div class="ttc" id="agroup__x52dcomm_html_ga667ce343cc456bcb63221258bc35ad4e"><div class="ttname"><a href="group__x52dcomm.html#ga667ce343cc456bcb63221258bc35ad4e">x52d_format_command</a></div><div class="ttdeci">int x52d_format_command(int argc, const char **argv, char *buffer, size_t buflen)</div><div class="ttdoc">Format a series of command strings into a buffer.</div></div>
|
|
<div class="ttc" id="agroup__x52dcomm_html_ga9a817265ac0e43fb191efe3347922df8"><div class="ttname"><a href="group__x52dcomm.html#ga9a817265ac0e43fb191efe3347922df8">x52d_notify_callback_fn</a></div><div class="ttdeci">int(* x52d_notify_callback_fn)(int argc, char **argv)</div><div class="ttdoc">Notification callback function type.</div><div class="ttdef"><b>Definition:</b> x52dcomm.h:129</div></div>
|
|
<div class="ttc" id="agroup__x52dcomm_html_gadfb485d611919a9a5a6dea019794f0e8"><div class="ttname"><a href="group__x52dcomm.html#gadfb485d611919a9a5a6dea019794f0e8">x52d_dial_notify</a></div><div class="ttdeci">int x52d_dial_notify(const char *sock_path)</div><div class="ttdoc">Open a connection to the daemon notify socket.</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>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|