MARVEL/pwm32e_pro
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
eab8e1cc9832256c186bfbc1da5cab963cd04e9e
pwm32e_pro/doc/网页版文档/xc__gatt__client__api_8h_source.html
T
moyuhai 41a602f89c V1.0
2026-06-09 16:39:17 +08:00

131 lines
20 KiB
HTML
Raw Blame History

<!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" lang="zh">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BLE5.2: TEST2/api/xc_gatt_client_api.h 源文件</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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="xinchip.png"/></td>
<td id="projectalign">
<div id="projectname">BLE5.2<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">开发文档说明</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 制作者 Doxygen 1.9.7 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>首页</span></a></li>
<li><a href="pages.html"><span>相关页面</span></a></li>
<li><a href="annotated.html"><span>类</span></a></li>
<li class="current"><a href="files.html"><span>文件</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>文件列表</span></a></li>
<li><a href="globals.html"><span>文件成员</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_e551eb05443008c96ab2f08dbb3250a6.html">TEST2</a></li><li class="navelem"><a class="el" href="dir_a213a656435eb838f44f965c240ae24d.html">api</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">xc_gatt_client_api.h</div></div>
</div><!--header-->
<div class="contents">
<a href="xc__gatt__client__api_8h.html">浏览该文件的文档.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#ifndef __XC_GATT_CLIENT_API_H__</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#define __XC_GATT_CLIENT_API_H__</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &quot;gatt_db.h&quot;</span> <span class="comment">// GATT Database access</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &quot;gatt.h&quot;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &quot;co_buf.h&quot;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &quot;rwble_hl_error.h&quot;</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#aa7a996ce909f2ed4d80d8eabf6f3a071">xc_ble_gatt_user_cli_register</a>(uint16_t pref_mtu, uint8_t prio_level, <span class="keyword">const</span> gatt_cli_cb_t* p_cb, uint8_t* p_user_lid);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#ad4aa4b1043f7a1cf9c8a7be4c890f5dc">xc_ble_gatt_user_unregister</a>(uint8_t user_lid);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#a74cc834949cf0f8f6138a2c92e13af0c">xc_ble_gatt_cli_discover_svc</a>(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint8_t disc_type, <span class="keywordtype">bool</span> full,</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> uint16_t start_hdl, uint16_t end_hdl, uint8_t uuid_type, <span class="keyword">const</span> uint8_t* p_uuid);</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#a1b53c3d77476921e8aa7de8e6ccf63b4">xc_ble_gatt_cli_discover_inc_svc</a>(uint8_t conidx, uint8_t user_lid, uint16_t dummy,</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> uint16_t start_hdl, uint16_t end_hdl);</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#aa0fdd832e831611ee57aef9e5a93ddb1">xc_ble_gatt_cli_discover_char</a>(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint8_t disc_type,</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> uint16_t start_hdl, uint16_t end_hdl, uint8_t uuid_type, <span class="keyword">const</span> uint8_t* p_uuid);</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> </div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#a13338ee47dfdeb86c8347f1180036c9e">xc_ble_gatt_cli_discover_desc</a>(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint16_t start_hdl, uint16_t end_hdl);</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> </div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#a414f2e13cb126a72fcc1ce6941a11767">xc_ble_gatt_cli_discover_cancel</a>(uint8_t conidx, uint8_t user_lid, uint16_t dummy);</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#ad1dae5d1ecebe172252b2e180dd2b450">xc_ble_gatt_cli_read</a>(uint8_t conidx, uint8_t user_lid, uint16_t dummy,</div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> uint16_t hdl, uint16_t offset, uint16_t length);</div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> </div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#af92611d9ded19d22a42617aae9fb7f7b">xc_ble_gatt_cli_read_by_uuid</a>(uint8_t conidx, uint8_t user_lid, uint16_t dummy,</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> uint16_t start_hdl, uint16_t end_hdl, uint8_t uuid_type, <span class="keyword">const</span> uint8_t* p_uuid);</div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> </div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#abc54bab10dfe3a08b3980f01a9c6fd55">xc_ble_gatt_cli_write</a>(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint8_t write_type,</div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span> uint16_t hdl, uint16_t length, <span class="keyword">const</span> uint8_t* p_data);</div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span> </div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno"> 271</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#a1ba2ef3e93796b5cdceb7b8d4bf65e1e">xc_ble_gatt_cli_event_register</a>(uint8_t conidx, uint8_t user_lid, uint16_t start_hdl, uint16_t end_hdl);</div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno"> 272</span> </div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno"> 286</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#a66c7f9c7cd76407d5e0e6467605bbad3">xc_ble_gatt_cli_event_unregister</a>(uint8_t conidx, uint8_t user_lid, uint16_t start_hdl, uint16_t end_hdl);</div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno"> 287</span> </div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno"> 299</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#a7b3326abe0243c1e495ef31d0972645d">xc_ble_gatt_cli_mtu_exch</a>(uint8_t conidx, uint8_t user_lid);</div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno"> 300</span> </div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno"> 313</span>uint16_t <a class="code hl_function" href="xc__gatt__client__api_8h.html#aee2a093ffcd8d8f0898ccabcacd3834b">xc_ble_gatt_cli_indicate_cfm</a>(uint8_t conidx, uint8_t user_lid, uint16_t token);</div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno"> 314</span> </div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno"> 315</span> </div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno"> 316</span> </div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno"> 317</span><span class="preprocessor">#endif </span><span class="comment">// __XC_GATT_CLIENT_API_H__</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno"> 318</span> </div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno"> 319</span> </div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno"> 320</span> </div>
<div class="ttc" id="axc__gatt__client__api_8h_html_a13338ee47dfdeb86c8347f1180036c9e"><div class="ttname"><a href="xc__gatt__client__api_8h.html#a13338ee47dfdeb86c8347f1180036c9e">xc_ble_gatt_cli_discover_desc</a></div><div class="ttdeci">uint16_t xc_ble_gatt_cli_discover_desc(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint16_t start_hdl, uint16_t end_hdl)</div><div class="ttdoc">Command used by a GATT client user to discover characteristic descriptor exposed by peer device in it...</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00051">xc_gatt_client_api.c:51</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_a1b53c3d77476921e8aa7de8e6ccf63b4"><div class="ttname"><a href="xc__gatt__client__api_8h.html#a1b53c3d77476921e8aa7de8e6ccf63b4">xc_ble_gatt_cli_discover_inc_svc</a></div><div class="ttdeci">uint16_t xc_ble_gatt_cli_discover_inc_svc(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint16_t start_hdl, uint16_t end_hdl)</div><div class="ttdoc">Command used by a GATT client user to discover included services, exposed by peer device in its attri...</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00034">xc_gatt_client_api.c:34</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_a1ba2ef3e93796b5cdceb7b8d4bf65e1e"><div class="ttname"><a href="xc__gatt__client__api_8h.html#a1ba2ef3e93796b5cdceb7b8d4bf65e1e">xc_ble_gatt_cli_event_register</a></div><div class="ttdeci">uint16_t xc_ble_gatt_cli_event_register(uint8_t conidx, uint8_t user_lid, uint16_t start_hdl, uint16_t end_hdl)</div><div class="ttdoc">Command used by a GATT client user to register for reception of events (notification / indication) fo...</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00099">xc_gatt_client_api.c:99</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_a414f2e13cb126a72fcc1ce6941a11767"><div class="ttname"><a href="xc__gatt__client__api_8h.html#a414f2e13cb126a72fcc1ce6941a11767">xc_ble_gatt_cli_discover_cancel</a></div><div class="ttdeci">uint16_t xc_ble_gatt_cli_discover_cancel(uint8_t conidx, uint8_t user_lid, uint16_t dummy)</div><div class="ttdoc">Command used by a GATT client user to cancel an on-going discovery procedure. The dummy parameter in ...</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00058">xc_gatt_client_api.c:58</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_a66c7f9c7cd76407d5e0e6467605bbad3"><div class="ttname"><a href="xc__gatt__client__api_8h.html#a66c7f9c7cd76407d5e0e6467605bbad3">xc_ble_gatt_cli_event_unregister</a></div><div class="ttdeci">uint16_t xc_ble_gatt_cli_event_unregister(uint8_t conidx, uint8_t user_lid, uint16_t start_hdl, uint16_t end_hdl)</div><div class="ttdoc">Command used by a GATT client user to stop reception of events (notification / indication) onto a spe...</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00105">xc_gatt_client_api.c:105</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_a74cc834949cf0f8f6138a2c92e13af0c"><div class="ttname"><a href="xc__gatt__client__api_8h.html#a74cc834949cf0f8f6138a2c92e13af0c">xc_ble_gatt_cli_discover_svc</a></div><div class="ttdeci">uint16_t xc_ble_gatt_cli_discover_svc(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint8_t disc_type, bool full, uint16_t start_hdl, uint16_t end_hdl, uint8_t uuid_type, const uint8_t *p_uuid)</div><div class="ttdoc">Command used by a GATT client user to discover primary or secondary services, exposed by peer device ...</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00025">xc_gatt_client_api.c:25</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_a7b3326abe0243c1e495ef31d0972645d"><div class="ttname"><a href="xc__gatt__client__api_8h.html#a7b3326abe0243c1e495ef31d0972645d">xc_ble_gatt_cli_mtu_exch</a></div><div class="ttdeci">uint16_t xc_ble_gatt_cli_mtu_exch(uint8_t conidx, uint8_t user_lid)</div><div class="ttdoc">Request a MTU exchange on legacy attribute bearer. There is no callback executed when the procedure i...</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00111">xc_gatt_client_api.c:111</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_aa0fdd832e831611ee57aef9e5a93ddb1"><div class="ttname"><a href="xc__gatt__client__api_8h.html#aa0fdd832e831611ee57aef9e5a93ddb1">xc_ble_gatt_cli_discover_char</a></div><div class="ttdeci">uint16_t xc_ble_gatt_cli_discover_char(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint8_t disc_type, uint16_t start_hdl, uint16_t end_hdl, uint8_t uuid_type, const uint8_t *p_uuid)</div><div class="ttdoc">Command used by a GATT client user to discover all or according to a specific UUID characteristics ex...</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00042">xc_gatt_client_api.c:42</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_aa7a996ce909f2ed4d80d8eabf6f3a071"><div class="ttname"><a href="xc__gatt__client__api_8h.html#aa7a996ce909f2ed4d80d8eabf6f3a071">xc_ble_gatt_user_cli_register</a></div><div class="ttdeci">uint16_t xc_ble_gatt_user_cli_register(uint16_t pref_mtu, uint8_t prio_level, const gatt_cli_cb_t *p_cb, uint8_t *p_user_lid)</div><div class="ttdoc">Command used to register a GATT user. This must be done prior to any GATT procedure execution.</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00013">xc_gatt_client_api.c:13</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_abc54bab10dfe3a08b3980f01a9c6fd55"><div class="ttname"><a href="xc__gatt__client__api_8h.html#abc54bab10dfe3a08b3980f01a9c6fd55">xc_ble_gatt_cli_write</a></div><div class="ttdeci">uint16_t xc_ble_gatt_cli_write(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint8_t write_type, uint16_t hdl, uint16_t length, const uint8_t *p_data)</div><div class="ttdoc">Command used by a GATT client user to request to write value of an attribute in peer database.</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00079">xc_gatt_client_api.c:79</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_ad1dae5d1ecebe172252b2e180dd2b450"><div class="ttname"><a href="xc__gatt__client__api_8h.html#ad1dae5d1ecebe172252b2e180dd2b450">xc_ble_gatt_cli_read</a></div><div class="ttdeci">uint16_t xc_ble_gatt_cli_read(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint16_t hdl, uint16_t offset, uint16_t length)</div><div class="ttdoc">Command used by a GATT client user to read value of an attribute (identified by its handle) present i...</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00064">xc_gatt_client_api.c:64</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_ad4aa4b1043f7a1cf9c8a7be4c890f5dc"><div class="ttname"><a href="xc__gatt__client__api_8h.html#ad4aa4b1043f7a1cf9c8a7be4c890f5dc">xc_ble_gatt_user_unregister</a></div><div class="ttdeci">uint16_t xc_ble_gatt_user_unregister(uint8_t user_lid)</div><div class="ttdoc">Command used to unregister a GATT user (client or server).</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00020">xc_gatt_client_api.c:20</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_aee2a093ffcd8d8f0898ccabcacd3834b"><div class="ttname"><a href="xc__gatt__client__api_8h.html#aee2a093ffcd8d8f0898ccabcacd3834b">xc_ble_gatt_cli_indicate_cfm</a></div><div class="ttdeci">uint16_t xc_ble_gatt_cli_indicate_cfm(uint8_t conidx, uint8_t user_lid, uint16_t token)</div><div class="ttdoc">Upper layer provide status of attribute event handled by GATT client user. confirmation of indicate b...</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00116">xc_gatt_client_api.c:116</a></div></div>
<div class="ttc" id="axc__gatt__client__api_8h_html_af92611d9ded19d22a42617aae9fb7f7b"><div class="ttname"><a href="xc__gatt__client__api_8h.html#af92611d9ded19d22a42617aae9fb7f7b">xc_ble_gatt_cli_read_by_uuid</a></div><div class="ttdeci">uint16_t xc_ble_gatt_cli_read_by_uuid(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint16_t start_hdl, uint16_t end_hdl, uint8_t uuid_type, const uint8_t *p_uuid)</div><div class="ttdoc">Command used by a GATT client user to read value of an attribute with a given UUID in peer database.</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__client__api_8c_source.html#l00070">xc_gatt_client_api.c:70</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
制作者&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink