spp_8h.html

BlueLab3 bluetooth API 说明文档

  </tr>
</table>
<a class="anchor" name="a40" doxytag="spp.h::spp_connect_status" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> enum <a class="el" href="spp_8h.html#a40">spp_connect_status</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return status for the SPP_CONNECT_CFM message. 
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a40a17" doxytag="spp_connect_success" ></a>spp_connect_success</em>&nbsp;</td><td>
Successful connection. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a40a18" doxytag="spp_connect_sdp_fail" ></a>spp_connect_sdp_fail</em>&nbsp;</td><td>
Unsuccessful due to a service search failure. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a40a19" doxytag="spp_connect_slc_failed" ></a>spp_connect_slc_failed</em>&nbsp;</td><td>
Unsuccessful due to a service level connection failure. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a40a20" doxytag="spp_connect_failed_busy" ></a>spp_connect_failed_busy</em>&nbsp;</td><td>
Unsuccessful due to service level connection already established. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a40a21" doxytag="spp_connect_failed" ></a>spp_connect_failed</em>&nbsp;</td><td>
Unsuccessful due to RFCOMM connection failing to be established. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a40a22" doxytag="spp_connect_server_channel_not_registered" ></a>spp_connect_server_channel_not_registered</em>&nbsp;</td><td>
Unsuccessful due to attempt to connect to unallocated server channel. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a40a23" doxytag="spp_connect_timeout" ></a>spp_connect_timeout</em>&nbsp;</td><td>
Unsuccessful due to connection attempt timing out. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a40a24" doxytag="spp_connect_rejected" ></a>spp_connect_rejected</em>&nbsp;</td><td>
Unsuccessful due to remote device rejecting connection. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a40a25" doxytag="spp_connect_normal_disconnect" ></a>spp_connect_normal_disconnect</em>&nbsp;</td><td>
Unsuccessful due to remote device terminating the connection. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a40a26" doxytag="spp_connect_abnormal_disconnect" ></a>spp_connect_abnormal_disconnect</em>&nbsp;</td><td>
Unsuccessful due to an abnormal disconnect while establishing an rfcomm connection. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a40a27" doxytag="spp_connect_dun_invalid" ></a>spp_connect_dun_invalid</em>&nbsp;</td><td>
Unsuccessful due to being an invalid request. DUN DCE cannot initial connection. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a41" doxytag="spp.h::spp_disconnect_status" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> enum <a class="el" href="spp_8h.html#a41">spp_disconnect_status</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Possible status codes for the disconnect message. 
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a41a28" doxytag="spp_disconnect_success" ></a>spp_disconnect_success</em>&nbsp;</td><td>
Successful disconnection. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a41a29" doxytag="spp_disconnect_link_loss" ></a>spp_disconnect_link_loss</em>&nbsp;</td><td>
Unsuccessful due to the link being lost. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a41a30" doxytag="spp_disconnect_no_slc" ></a>spp_disconnect_no_slc</em>&nbsp;</td><td>
Unsuccessful due to no service level connection. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a41a31" doxytag="spp_disconnect_timeout" ></a>spp_disconnect_timeout</em>&nbsp;</td><td>
Unsuccessful due to time out. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a41a32" doxytag="spp_disconnect_error" ></a>spp_disconnect_error</em>&nbsp;</td><td>
Unsuccessful for some other reason. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a33" doxytag="spp.h::SppInit" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void SppInit           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="struct_task_data.html">Task</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>theAppTask</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="spp_8h.html#a38">spp_device_type</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>type_of_device</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a4">uint16</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>priority</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Initialise the SPP library. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>theAppTask</em>&nbsp;</td><td>The current application task.</td></tr>
    <tr><td></td><td valign=top><em>type_of_device</em>&nbsp;</td><td>devA(Master), devB(Slave), dunDCE(Master) or dunDTE(Slave).</td></tr>
    <tr><td></td><td valign=top><em>priority</em>&nbsp;</td><td>The profile instance low power mode priority. For a set of profile instances with connections on a given ACL the instance with the highest priority value wins and the low power mode on the ACL is set according to it's power table. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a34" doxytag="spp.h::SppConnect" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void SppConnect           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="spp_8h.html#a1">SPP</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>spp</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="structbdaddr.html">bdaddr</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>bd_addr</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Handle Connect request by sending an internal message. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>spp</em>&nbsp;</td><td>Serial Port Profile structure. </td></tr>
    <tr><td></td><td valign=top><em>bd_addr</em>&nbsp;</td><td>Bluetooth address of device to connect to. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a35" doxytag="spp.h::SppConnectResponse" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void SppConnectResponse           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="spp_8h.html#a1">SPP</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>spp</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a9">bool</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>response</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="structbdaddr.html">bdaddr</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>bd_addr</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Handle response to a connection request by sending an internal message. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>spp</em>&nbsp;</td><td>Serial Port Profile structure. </td></tr>
    <tr><td></td><td valign=top><em>response</em>&nbsp;</td><td>TRUE to connect, FALSE to refuse the connection. </td></tr>
    <tr><td></td><td valign=top><em>bd_addr</em>&nbsp;</td><td>Bluetooth address of the device to connect to. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a36" doxytag="spp.h::SppDisconnect" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void SppDisconnect           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="spp_8h.html#a1">SPP</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>spp</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Disconnect the service level connection for the supported profile. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>spp</em>&nbsp;</td><td>Serial Port Profile structure. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>

</body>
</html>