mirror of
https://github.com/felis/USB_Host_Shield_2.0.git
synced 2024-03-22 11:31:26 +01:00
242 lines
13 KiB
HTML
242 lines
13 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.6"/>
|
|
<title>USB Host Shield 2.0: BluetoothService Class Reference</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/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="imageStyle.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 style="padding-left: 0.5em;">
|
|
<div id="projectname">USB Host Shield 2.0
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_bluetooth_service-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">BluetoothService Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="_b_t_d_8h_source.html">BTD.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for BluetoothService:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_bluetooth_service__inherit__graph.png" border="0" usemap="#_bluetooth_service_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="_bluetooth_service_inherit__map" id="_bluetooth_service_inherit__map">
|
|
<area shape="rect" id="node2" href="class_b_t_h_i_d.html" title="BTHID" alt="" coords="5,83,67,111"/><area shape="rect" id="node4" href="class_p_s3_b_t.html" title="PS3BT" alt="" coords="91,83,153,111"/><area shape="rect" id="node5" href="class_s_p_p.html" title="SPP" alt="" coords="179,83,227,111"/><area shape="rect" id="node6" href="class_w_i_i.html" title="WII" alt="" coords="251,83,292,111"/><area shape="rect" id="node3" href="class_p_s4_b_t.html" title="PS4BT" alt="" coords="4,161,67,189"/></map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a8dc98310fe481357eaa86c53e49af113"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_service.html#a8dc98310fe481357eaa86c53e49af113">ACLData</a> (uint8_t *ACLData)</td></tr>
|
|
<tr class="separator:a8dc98310fe481357eaa86c53e49af113"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a680692ff13cb37eb81ddbb74bc9e0383"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_service.html#a680692ff13cb37eb81ddbb74bc9e0383">Run</a> ()</td></tr>
|
|
<tr class="separator:a680692ff13cb37eb81ddbb74bc9e0383"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dff7caf251f1d8a5f358b368445cb48"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_service.html#a1dff7caf251f1d8a5f358b368445cb48">Reset</a> ()</td></tr>
|
|
<tr class="separator:a1dff7caf251f1d8a5f358b368445cb48"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66ee2f09c6087b82e3920c3d652a99b2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bluetooth_service.html#a66ee2f09c6087b82e3920c3d652a99b2">disconnect</a> ()</td></tr>
|
|
<tr class="separator:a66ee2f09c6087b82e3920c3d652a99b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>All Bluetooth services should inherit this class. </p>
|
|
|
|
<p>Definition at line <a class="el" href="_b_t_d_8h_source.html#l00211">211</a> of file <a class="el" href="_b_t_d_8h_source.html">BTD.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a8dc98310fe481357eaa86c53e49af113"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void BluetoothService::ACLData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>ACLData</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used to pass acldata to the Bluetooth service. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ACLData</td><td>Pointer to the incoming acldata. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_s_p_p.html#abdfe9453fb82781bec53a191c2e9fb1d">SPP</a>, <a class="el" href="class_w_i_i.html#a81e1eb4d9ef9999a84e71d764d54dff7">WII</a>, <a class="el" href="class_p_s3_b_t.html#aa310ede24b68b1b03cfc49c4308c66b7">PS3BT</a>, and <a class="el" href="class_b_t_h_i_d.html#a84eb1b910027f2d78741f65225c14e54">BTHID</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a680692ff13cb37eb81ddbb74bc9e0383"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void BluetoothService::Run </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used to run the different state machines in the Bluetooth service. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_s_p_p.html#a2de67ee7ad1be9d2f3daf7dc08dc5f90">SPP</a>, <a class="el" href="class_w_i_i.html#ac5cd06f3e9aa2a0d9b9691f00c047e72">WII</a>, <a class="el" href="class_p_s3_b_t.html#ab41f25f45573239990f68611dc825086">PS3BT</a>, and <a class="el" href="class_b_t_h_i_d.html#a938eab04e406a29cc9324dad3ccb52cc">BTHID</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1dff7caf251f1d8a5f358b368445cb48"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void BluetoothService::Reset </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used to reset the Bluetooth service. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_s_p_p.html#ae2c661bd46cd2d74bd29c4c771cd2ef0">SPP</a>, <a class="el" href="class_w_i_i.html#a769ee2f9a0088da097438bc3cc677f7c">WII</a>, <a class="el" href="class_p_s3_b_t.html#a576d72cdf12af58ae59c8f2a02f99c0f">PS3BT</a>, and <a class="el" href="class_b_t_h_i_d.html#af4c58b81414a037910dd6fb78f97b96e">BTHID</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a66ee2f09c6087b82e3920c3d652a99b2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void BluetoothService::disconnect </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used to disconnect both the L2CAP Channel and the HCI Connection for the Bluetooth service. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_s_p_p.html#a2b4b1f85f553c6a2fdd523e50c75c7b0">SPP</a>, <a class="el" href="class_w_i_i.html#aabe4780f258dada1c0564a4ac7607370">WII</a>, <a class="el" href="class_p_s3_b_t.html#a39ad8810c67e85eddc68c8a16d38a985">PS3BT</a>, and <a class="el" href="class_b_t_h_i_d.html#ae1ee62d7b9951ec7960f122c9fc2d2d0">BTHID</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="_b_t_d_8h_source.html">BTD.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|