stream_8h.html

BlueLab3 bluetooth API 说明文档

       
    </td>
    <td>

<p>
Find the Sink corresponding to an L2CAP connection. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>cid</em>&nbsp;</td><td>The connection ID to fetch the Sink for. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a28" doxytag="stream.h::StreamKalimbaSink" ></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="sink___8h.html#a0">Sink</a> StreamKalimbaSink           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>port</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>
The Sink connected to the port passed on Kalimba. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>port</em>&nbsp;</td><td>In the range 0..3 (BC3-MM) or 0..7 (BC5-MM) </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a29" doxytag="stream.h::StreamFileSource" ></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="source___8h.html#a0">Source</a> StreamFileSource           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="file__if_8h.html#a2">FILE_INDEX</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>index</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 a source with the contents of the specified file. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>index</em>&nbsp;</td><td>the file whose contents are requested</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>0 if index is FILE_NONE, or does not correspond to a narrow file. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a30" doxytag="stream.h::StreamUsbClassSink" ></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="sink___8h.html#a0">Sink</a> StreamUsbClassSink           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="usb___8h.html#a8">UsbInterface</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>interface</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 the USB Class Request Sink. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>The</em>&nbsp;</td><td>USB interface to fetch the Sink for. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a31" doxytag="stream.h::StreamUsbEndPointSink" ></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="sink___8h.html#a0">Sink</a> StreamUsbEndPointSink           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="usb___8h.html#a9">EndPoint</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>end_point</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 the USB Request Sink associated with the USB transport. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>end_point</em>&nbsp;</td><td>The USB endpoint to fetch the Sink for. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a32" doxytag="stream.h::StreamUsbVendorSink" ></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="sink___8h.html#a0">Sink</a> StreamUsbVendorSink           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </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 the USB Vendor Sink associated with the USB transport. 
<p>
    </td>
  </tr>
</table>
<a class="anchor" name="a33" doxytag="stream.h::StreamHidSource" ></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="source___8h.html#a0">Source</a> StreamHidSource           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </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>
Get the primary source for HID. 
<p>
This is the main data from the sensor. See the HID_SENSOR types for allowed sensors.     </td>
  </tr>
</table>
<a class="anchor" name="a34" doxytag="stream.h::StreamHidAuxSource" ></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="source___8h.html#a0">Source</a> StreamHidAuxSource           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </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>
Get the auxiliary source for HID. 
<p>
For a keyboard this carries the aux keys. See the HID_SENSOR types for allowed sensors.     </td>
  </tr>
</table>
<a class="anchor" name="a35" doxytag="stream.h::StreamEnableSniffSubrating" ></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> StreamEnableSniffSubrating           </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>max_remote_latency</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>max_local_latency</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>min_remote_timeout</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>min_local_timeout</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>
Enable support for sniff sub-rating. 
<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>A sink associated with the ACL connection </td></tr>
    <tr><td></td><td valign=top><em>max_remote_latency</em>&nbsp;</td><td>As in the equivalent HCI command, but in slots </td></tr>
    <tr><td></td><td valign=top><em>max_local_latency</em>&nbsp;</td><td>As in the equivalent HCI command, but in slots </td></tr>
    <tr><td></td><td valign=top><em>min_remote_timeout</em>&nbsp;</td><td>As in the equivalent HCI command, but in slots </td></tr>
    <tr><td></td><td valign=top><em>min_local_timeout</em>&nbsp;</td><td>As in the equivalent HCI command, but in slots</td></tr>
  </table>
</dl>
Note that this feature is experimental.     </td>
  </tr>
</table>
<a class="anchor" name="a36" doxytag="stream.h::StreamConnectAndDispose" ></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> StreamConnectAndDispose           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="source___8h.html#a0">Source</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>source</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="sink___8h.html#a0">Sink</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>sink</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>
Make an automatic connection between a source and sink, or dispose it. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>source</em>&nbsp;</td><td>The Source data will be taken from. </td></tr>
    <tr><td></td><td valign=top><em>sink</em>&nbsp;</td><td>The Sink data will be written to.</td></tr>
  </table>
</dl>
Like StreamConnect, but if the connection could not be made then the source will be passed to StreamConnectDispose. Similarly, if the connection is subsequently broken using StreamDisconnect or by the sink being closed the source will be passed to StreamConnectDispose.<p>
The end result is that the source will be tidied up correctly, no matter what happens after this call.<p>
Note that the task associated with the source will be changed. Messages related to the source will no longer be sent to the task previously associated with it.     </td>
  </tr>
</table>

</body>
</html>