sink_8h.html

BlueLab3 bluetooth API 说明文档

    <tr><td></td><td valign=top><em>amount</em>&nbsp;</td><td>The number of bytes of data to flush. </td></tr>
    <tr><td></td><td valign=top><em>header</em>&nbsp;</td><td>The header to use. </td></tr>
    <tr><td></td><td valign=top><em>length</em>&nbsp;</td><td>The size of the header.</td></tr>
  </table>
</dl>
The specified bytes of data are then passed to the corresponding byte stream, for example out to the UART, or into BlueStack as if sent by a RFC_DATA_IND for uart/rfcomm sinks respectively.<p>
Returns zero if the operation failed because the sink was invalid or amount exceeded the size of the sink as reported by SinkClaimed. Return a non-zero value on success.<p>
Associates the header with the message.     </td>
  </tr>
</table>
<a class="anchor" name="a5" doxytag="sink.h::SinkGetBdAddr" ></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"> <a class="el" href="csrtypes_8h.html#a9">bool</a> SinkGetBdAddr           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="sink___8h.html#a0">Sink</a>&nbsp;</td>
          <td class="mdname" nowrap>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="structbdaddr.html">bdaddr</a> *&nbsp;</td>
          <td class="mdname" nowrap></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>
Get the Bluetooth address from a sink. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>Sink</em>&nbsp;</td><td>The Sink to fetch the Bluetooth address from. </td></tr>
    <tr><td></td><td valign=top><em>bdaddr</em>&nbsp;</td><td>If the address is found it will be returned to the location pointed at by this value.</td></tr>
  </table>
</dl>
Returns TRUE if such an address was found, FALSE otherwise.     </td>
  </tr>
</table>
<a class="anchor" name="a6" doxytag="sink.h::SinkConfigure" ></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"> <a class="el" href="csrtypes_8h.html#a9">bool</a> SinkConfigure           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="sink___8h.html#a0">Sink</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>sink</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="vm__if_8h.html#a60">vm_sink_config_key</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>key</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>value</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>
Configure a particular sink. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>sink</em>&nbsp;</td><td>The Sink to configure. </td></tr>
    <tr><td></td><td valign=top><em>key</em>&nbsp;</td><td>The key to configure. </td></tr>
    <tr><td></td><td valign=top><em>value</em>&nbsp;</td><td>The value to write to 'key'</td></tr>
  </table>
</dl>
Returns FALSE if the request could not be performed, TRUE otherwise.<p>
See vm_sink_config_key for the possible keys and their meanings. Note that some keys apply only to specific kinds of sink.     </td>
  </tr>
</table>
<a class="anchor" name="a7" doxytag="sink.h::SinkGetRssi" ></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"> <a class="el" href="csrtypes_8h.html#a9">bool</a> SinkGetRssi           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="sink___8h.html#a0">Sink</a>&nbsp;</td>
          <td class="mdname" nowrap>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a6">int16</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>rssi</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>
Get the RSSI for the ACL for a sink. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>Sink</em>&nbsp;</td><td>The Sink which uses the ACL, </td></tr>
    <tr><td></td><td valign=top><em>rssi</em>&nbsp;</td><td>If the sink corresponds to an ACL the RSSI will be written to this location.</td></tr>
  </table>
</dl>
Returns TRUE if the RSSI was obtained, FALSE otherwise.     </td>
  </tr>
</table>
<a class="anchor" name="a8" doxytag="sink.h::SinkPollAwayTime" ></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"> <a class="el" href="csrtypes_8h.html#a9">bool</a> SinkPollAwayTime           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="sink___8h.html#a0">Sink</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>sink</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>msec</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>
Read the away time on the underlying ACL. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>sink</em>&nbsp;</td><td>identifies the underlying ACL </td></tr>
    <tr><td></td><td valign=top><em>msec</em>&nbsp;</td><td>receives the away time if the call succeeds (unmodified otherwise)</td></tr>
  </table>
</dl>
Returns TRUE if the sink identifies an ACL and the away time on that link could be read, FALSE otherwise.<p>
The away time is the time since any packet was received on that ACL and is reported in milliseconds. If the time exceeds 0xFFFF, 0xFFFF will be returned (this is unlikely with sensible link supervision timeouts.)     </td>
  </tr>
</table>
<a class="anchor" name="a9" doxytag="sink.h::SinkIsValid" ></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"> <a class="el" href="csrtypes_8h.html#a9">bool</a> SinkIsValid           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="sink___8h.html#a0">Sink</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>sink</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>
Return non-zero if a sink is valid, zero otherwise. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>sink</em>&nbsp;</td><td>The sink to check. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>

</body>
</html>