opps_8h.html

BlueLab3 bluetooth API 说明文档

The ownership of all pointers remains with the caller.<p>
If data is in a VM Source (e.g. from the filesystem), OppsPushBusinessCardStartSource should be used instead of OppsPushBusinessCardStart.<p>
This function should be called on receipt of a OPPS_PULL_BC_START_IND message. A OPPS_PULL_BC_DATA_IND message will be received to request the next packet. A OPPS_PULL_BC_COMPLETE_IND message will be received after sending the final packet.     </td>
  </tr>
</table>
<a class="anchor" name="a20" doxytag="opps.h::OppsPushBusinessCardNext" ></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 OppsPushBusinessCardNext           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="opps_8h.html#a1">OPPS</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>opps</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="csrtypes_8h.html#a4">uint16</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>size_packet</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>packet</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="csrtypes_8h.html#a9">bool</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>lastPacket</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>
Push the next packet of the current vCard to the server. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>opps</em>&nbsp;</td><td>OPPS Session Handle. </td></tr>
    <tr><td></td><td valign=top><em>size_packet</em>&nbsp;</td><td>Length of the packet supplied with this request. </td></tr>
    <tr><td></td><td valign=top><em>packet</em>&nbsp;</td><td>Packet to send. </td></tr>
    <tr><td></td><td valign=top><em>lastPacket</em>&nbsp;</td><td>Is this the last packet? Yes(TRUE) or No(FALSE).</td></tr>
  </table>
</dl>
The ownership of the pointer 'packet' remains with the caller.<p>
If data is in a VM Source (e.g. from the filesystem), OppsPushBusinessCardNextSource should be used instead of OppsPushBusinessCardNext.<p>
This function should be called on receipt of a OPPS_PULL_BC_DATA_IND message. A OPPS_PULL_BC_DATA_IND message will be received to request the next packet. A OPPS_PULL_BC_COMPLETE_IND message will be received after sending the final packet.     </td>
  </tr>
</table>
<a class="anchor" name="a21" doxytag="opps.h::OppsPushBusinessCardStartSource" ></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 OppsPushBusinessCardStartSource           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="opps_8h.html#a1">OPPS</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>opps</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="csrtypes_8h.html#a4">uint16</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>size_name</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="csrtypes_8h.html#a4">uint16</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>size_packet</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="source___8h.html#a0">Source</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>src</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="csrtypes_8h.html#a3">uint32</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>totalLen</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="csrtypes_8h.html#a9">bool</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>onlyPacket</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>
Push the first packet of a vCard (business card) to the server. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>opps</em>&nbsp;</td><td>OPPS Session Handle. </td></tr>
    <tr><td></td><td valign=top><em>size_name</em>&nbsp;</td><td>Length of the name field. </td></tr>
    <tr><td></td><td valign=top><em>name</em>&nbsp;</td><td>The object name. </td></tr>
    <tr><td></td><td valign=top><em>size_packet</em>&nbsp;</td><td>Length of the packet supplied with this request. </td></tr>
    <tr><td></td><td valign=top><em>src</em>&nbsp;</td><td>Source containing the data packet. </td></tr>
    <tr><td></td><td valign=top><em>totalLen</em>&nbsp;</td><td>Total length of the object being sent. </td></tr>
    <tr><td></td><td valign=top><em>onlyPacket</em>&nbsp;</td><td>Is this the only packet? Yes(TRUE) or No(FALSE).</td></tr>
  </table>
</dl>
This function should be called on receipt of a OPPS_PULL_BC_START_IND message. A OPPS_PULL_BC_DATA_IND message will be received to request the next packet. A OPPS_PULL_BC_COMPLETE_IND message will be received after sending the final packet.     </td>
  </tr>
</table>
<a class="anchor" name="a22" doxytag="opps.h::OppsPushBusinessCardNextSource" ></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 OppsPushBusinessCardNextSource           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="opps_8h.html#a1">OPPS</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>opps</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="csrtypes_8h.html#a4">uint16</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>size_packet</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="source___8h.html#a0">Source</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>src</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="csrtypes_8h.html#a9">bool</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>lastPacket</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>
Push the next packet of the current vCard to the server. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>opps</em>&nbsp;</td><td>OPPS Session Handle. </td></tr>
    <tr><td></td><td valign=top><em>size_packet</em>&nbsp;</td><td>Length of the packet supplied with this request. </td></tr>
    <tr><td></td><td valign=top><em>src</em>&nbsp;</td><td>Source containing the data packet. </td></tr>
    <tr><td></td><td valign=top><em>lastPacket</em>&nbsp;</td><td>Is this the last packet? Yes(TRUE) or No(FALSE).</td></tr>
  </table>
</dl>
This function should be called on receipt of a OPPS_PULL_BC_DATA_IND message. A OPPS_PULL_BC_DATA_IND message will be received to request the next packet. A OPPS_PULL_BC_COMPLETE_IND message will be received after sending the final packet.     </td>
  </tr>
</table>
<a class="anchor" name="a23" doxytag="opps.h::OppsPacketComplete" ></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 OppsPacketComplete           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="opps_8h.html#a1">OPPS</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>opps</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 packet received has been processed and is no longer needed. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>opps</em>&nbsp;</td><td>OPPS Session Handle (as returned in OPPS_INIT_CFM).</td></tr>
  </table>
</dl>
Every packet send to the client that contains a source must be declared complete before the next function is called. e.g. When a OPPS_PUSH_OBJ_START_IND has been received, OppsPacketComplete must be called before calling OppsGetNextPutPacket.<p>
No message is received on completion.     </td>
  </tr>
</table>

</body>
</html>