MARVEL/hpw421
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
Files
99c8fe1f8ea1c9f605a77bb8503ec12f98f5d66b
hpw421/doc/网页版文档/xc__gatt__server__api_8h_source.html
T
xushaoxiang 2339bbfd1f hpw421初始版本
2026-06-06 16:49:48 +08:00

128 lines
18 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_server_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_server_api.h</div></div>
</div><!--header-->
<div class="contents">
<a href="xc__gatt__server__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_SERVER_API_H__</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#define __XC_GATT_SERVER_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="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="xc__gatt__server__api_8h.html#a17af631b0bdca6dc42000d29d5e5d551"> 20</a></span><span class="keyword">enum</span> <a class="code hl_enumeration" href="xc__gatt__server__api_8h.html#a17af631b0bdca6dc42000d29d5e5d551">gatt_err</a></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>{</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="xc__gatt__server__api_8h.html#a17af631b0bdca6dc42000d29d5e5d551a15a01b2e866d4aef1794c1a9bb9e35cc"> 23</a></span> <a class="code hl_enumvalue" href="xc__gatt__server__api_8h.html#a17af631b0bdca6dc42000d29d5e5d551a15a01b2e866d4aef1794c1a9bb9e35cc">GATT_NO_ERROR</a> = 0x00,</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>};</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="xc__gatt__server__api_8h.html#af828ddd83bfcb936f1ffa2bf6ee21578"> 26</a></span><span class="keyword">enum</span> <a class="code hl_enumeration" href="xc__gatt__server__api_8h.html#af828ddd83bfcb936f1ffa2bf6ee21578">gatt_switch</a></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span>{</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="xc__gatt__server__api_8h.html#af828ddd83bfcb936f1ffa2bf6ee21578ab40c9b7d024f76bedcb46cc77b1f9298"> 28</a></span> <a class="code hl_enumvalue" href="xc__gatt__server__api_8h.html#af828ddd83bfcb936f1ffa2bf6ee21578ab40c9b7d024f76bedcb46cc77b1f9298">GATT_DISABLE</a> = 0,</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_enumvalue" href="xc__gatt__server__api_8h.html#af828ddd83bfcb936f1ffa2bf6ee21578a6e2397a60859a9bc3ae583d9f2b5328f">GATT_ENABLE</a> = 1</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="xc__gatt__server__api_8h.html#af828ddd83bfcb936f1ffa2bf6ee21578a6e2397a60859a9bc3ae583d9f2b5328f"> 30</a></span>};</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>uint16_t <a class="code hl_function" href="xc__gatt__server__api_8h.html#a0d2f9f632077a0aa60edfb1b4b958573">xc_ble_gatt_user_srv_register</a>(uint16_t pref_mtu, uint8_t prio_level, <span class="keyword">const</span> gatt_srv_cb_t* p_cb, uint8_t* p_user_lid);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span>uint16_t <a class="code hl_function" href="xc__gatt__server__api_8h.html#ae1a5e7496618129e47cc296204d57371">xc_ble_gatt_service_add</a>(uint8_t user_lid, uint8_t info, <span class="keyword">const</span> uint8_t* p_uuid, uint8_t nb_att, <span class="keyword">const</span> uint8_t* p_att_mask,</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">const</span> gatt_att_desc_t* p_atts, uint8_t nb_att_rsvd, uint16_t* p_start_hdl);</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span>uint16_t <a class="code hl_function" href="xc__gatt__server__api_8h.html#ab8bb092e4ad03053689b18478ba3720f">xc_ble_gatt_service16_add</a>(uint8_t user_lid, uint8_t info, uint16_t uuid16, uint8_t nb_att, <span class="keyword">const</span> uint8_t* p_att_mask,</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keyword">const</span> gatt_att16_desc_t* p_atts, uint8_t nb_att_rsvd, uint16_t* p_start_hdl);</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span>uint16_t <a class="code hl_function" href="xc__gatt__server__api_8h.html#a0338534f23ffd6dc99129905a931c5cc">xc_ble_gatt_service_remove</a>(uint8_t user_lid, uint16_t start_hdl);</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span>uint16_t <a class="code hl_function" href="xc__gatt__server__api_8h.html#ad2b3907a378e1e09c8af4c62ae190659">xc_ble_gatt_srv_notify</a>(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint16_t hdl,</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> uint16_t length, <span class="keyword">const</span> uint8_t *p_value);</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> </div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span>uint16_t <a class="code hl_function" href="xc__gatt__server__api_8h.html#ac33c66a1b8d8b24a72c563be5d09e14b">xc_ble_gatt_srv_indicate</a>(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint16_t hdl,</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> uint16_t length, <span class="keyword">const</span> uint8_t *p_value);</div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> </div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span>uint16_t <a class="code hl_function" href="xc__gatt__server__api_8h.html#a5a0dc7a37707ac90e70b5b9d08d1190c">xc_ble_gatt_srv_read_cfm</a>(uint8_t conidx, uint8_t user_lid, uint16_t token, uint16_t status,</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> uint16_t att_length, uint16_t length, <span class="keyword">const</span> uint8_t *p_value);</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> </div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span>uint16_t <a class="code hl_function" href="xc__gatt__server__api_8h.html#a6fa35175559567fb8c7301b6bae1bf24">xc_ble_gatt_srv_write_cfm</a>(uint8_t conidx, uint8_t user_lid, uint16_t token, uint16_t status);</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> </div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span><span class="preprocessor">#endif </span><span class="comment">// __XC_GATT_SERVER_API_H__</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> </div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> </div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> </div>
<div class="ttc" id="axc__gatt__server__api_8h_html_a0338534f23ffd6dc99129905a931c5cc"><div class="ttname"><a href="xc__gatt__server__api_8h.html#a0338534f23ffd6dc99129905a931c5cc">xc_ble_gatt_service_remove</a></div><div class="ttdeci">uint16_t xc_ble_gatt_service_remove(uint8_t user_lid, uint16_t start_hdl)</div><div class="ttdoc">Command used to remove a service from local attribute database.</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__server__api_8c_source.html#l00040">xc_gatt_server_api.c:40</a></div></div>
<div class="ttc" id="axc__gatt__server__api_8h_html_a0d2f9f632077a0aa60edfb1b4b958573"><div class="ttname"><a href="xc__gatt__server__api_8h.html#a0d2f9f632077a0aa60edfb1b4b958573">xc_ble_gatt_user_srv_register</a></div><div class="ttdeci">uint16_t xc_ble_gatt_user_srv_register(uint16_t pref_mtu, uint8_t prio_level, const gatt_srv_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__server__api_8c_source.html#l00013">xc_gatt_server_api.c:13</a></div></div>
<div class="ttc" id="axc__gatt__server__api_8h_html_a17af631b0bdca6dc42000d29d5e5d551"><div class="ttname"><a href="xc__gatt__server__api_8h.html#a17af631b0bdca6dc42000d29d5e5d551">gatt_err</a></div><div class="ttdeci">gatt_err</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__server__api_8h_source.html#l00020">xc_gatt_server_api.h:21</a></div></div>
<div class="ttc" id="axc__gatt__server__api_8h_html_a17af631b0bdca6dc42000d29d5e5d551a15a01b2e866d4aef1794c1a9bb9e35cc"><div class="ttname"><a href="xc__gatt__server__api_8h.html#a17af631b0bdca6dc42000d29d5e5d551a15a01b2e866d4aef1794c1a9bb9e35cc">GATT_NO_ERROR</a></div><div class="ttdeci">@ GATT_NO_ERROR</div><div class="ttdoc">No error</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__server__api_8h_source.html#l00023">xc_gatt_server_api.h:23</a></div></div>
<div class="ttc" id="axc__gatt__server__api_8h_html_a5a0dc7a37707ac90e70b5b9d08d1190c"><div class="ttname"><a href="xc__gatt__server__api_8h.html#a5a0dc7a37707ac90e70b5b9d08d1190c">xc_ble_gatt_srv_read_cfm</a></div><div class="ttdeci">uint16_t xc_ble_gatt_srv_read_cfm(uint8_t conidx, uint8_t user_lid, uint16_t token, uint16_t status, uint16_t att_length, uint16_t length, const uint8_t *p_value)</div><div class="ttdoc">Upper layer provide attribute value requested by GATT Layer for a read procedure If rejected,...</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__server__api_8c_source.html#l00093">xc_gatt_server_api.c:93</a></div></div>
<div class="ttc" id="axc__gatt__server__api_8h_html_a6fa35175559567fb8c7301b6bae1bf24"><div class="ttname"><a href="xc__gatt__server__api_8h.html#a6fa35175559567fb8c7301b6bae1bf24">xc_ble_gatt_srv_write_cfm</a></div><div class="ttdeci">uint16_t xc_ble_gatt_srv_write_cfm(uint8_t conidx, uint8_t user_lid, uint16_t token, uint16_t status)</div><div class="ttdoc">Upper layer provide status of attribute value modification by GATT server user. Confirmation server u...</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__server__api_8c_source.html#l00123">xc_gatt_server_api.c:123</a></div></div>
<div class="ttc" id="axc__gatt__server__api_8h_html_ab8bb092e4ad03053689b18478ba3720f"><div class="ttname"><a href="xc__gatt__server__api_8h.html#ab8bb092e4ad03053689b18478ba3720f">xc_ble_gatt_service16_add</a></div><div class="ttdeci">uint16_t xc_ble_gatt_service16_add(uint8_t user_lid, uint8_t info, uint16_t uuid16, uint8_t nb_att, const uint8_t *p_att_mask, const gatt_att16_desc_t *p_atts, uint8_t nb_att_rsvd, uint16_t *p_start_hdl)</div><div class="ttdoc">Command used to add a service into local attribute database.</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__server__api_8c_source.html#l00030">xc_gatt_server_api.c:30</a></div></div>
<div class="ttc" id="axc__gatt__server__api_8h_html_ac33c66a1b8d8b24a72c563be5d09e14b"><div class="ttname"><a href="xc__gatt__server__api_8h.html#ac33c66a1b8d8b24a72c563be5d09e14b">xc_ble_gatt_srv_indicate</a></div><div class="ttdeci">uint16_t xc_ble_gatt_srv_indicate(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint16_t hdl, uint16_t length, const uint8_t *p_value)</div><div class="ttdoc">Command used by a GATT server user to send indication</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__server__api_8c_source.html#l00069">xc_gatt_server_api.c:69</a></div></div>
<div class="ttc" id="axc__gatt__server__api_8h_html_ad2b3907a378e1e09c8af4c62ae190659"><div class="ttname"><a href="xc__gatt__server__api_8h.html#ad2b3907a378e1e09c8af4c62ae190659">xc_ble_gatt_srv_notify</a></div><div class="ttdeci">uint16_t xc_ble_gatt_srv_notify(uint8_t conidx, uint8_t user_lid, uint16_t dummy, uint16_t hdl, uint16_t length, const uint8_t *p_value)</div><div class="ttdoc">Command used by a GATT server user to send notifications</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__server__api_8c_source.html#l00045">xc_gatt_server_api.c:45</a></div></div>
<div class="ttc" id="axc__gatt__server__api_8h_html_ae1a5e7496618129e47cc296204d57371"><div class="ttname"><a href="xc__gatt__server__api_8h.html#ae1a5e7496618129e47cc296204d57371">xc_ble_gatt_service_add</a></div><div class="ttdeci">uint16_t xc_ble_gatt_service_add(uint8_t user_lid, uint8_t info, const uint8_t *p_uuid, uint8_t nb_att, const uint8_t *p_att_mask, const gatt_att_desc_t *p_atts, uint8_t nb_att_rsvd, uint16_t *p_start_hdl)</div><div class="ttdoc">Command used to add a service into local attribute database.</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__server__api_8c_source.html#l00020">xc_gatt_server_api.c:20</a></div></div>
<div class="ttc" id="axc__gatt__server__api_8h_html_af828ddd83bfcb936f1ffa2bf6ee21578"><div class="ttname"><a href="xc__gatt__server__api_8h.html#af828ddd83bfcb936f1ffa2bf6ee21578">gatt_switch</a></div><div class="ttdeci">gatt_switch</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__server__api_8h_source.html#l00026">xc_gatt_server_api.h:27</a></div></div>
<div class="ttc" id="axc__gatt__server__api_8h_html_af828ddd83bfcb936f1ffa2bf6ee21578a6e2397a60859a9bc3ae583d9f2b5328f"><div class="ttname"><a href="xc__gatt__server__api_8h.html#af828ddd83bfcb936f1ffa2bf6ee21578a6e2397a60859a9bc3ae583d9f2b5328f">GATT_ENABLE</a></div><div class="ttdeci">@ GATT_ENABLE</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__server__api_8h_source.html#l00030">xc_gatt_server_api.h:29</a></div></div>
<div class="ttc" id="axc__gatt__server__api_8h_html_af828ddd83bfcb936f1ffa2bf6ee21578ab40c9b7d024f76bedcb46cc77b1f9298"><div class="ttname"><a href="xc__gatt__server__api_8h.html#af828ddd83bfcb936f1ffa2bf6ee21578ab40c9b7d024f76bedcb46cc77b1f9298">GATT_DISABLE</a></div><div class="ttdeci">@ GATT_DISABLE</div><div class="ttdef"><b>Definition</b> <a href="xc__gatt__server__api_8h_source.html#l00028">xc_gatt_server_api.h:28</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