ftpc_8h.html

BlueLab3 bluetooth API 说明文档

          <td class="md" nowrap valign="top"> void FtpcPushObjectNextPacketSource           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="ftpc_8h.html#a1">FTPC</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>ftpc</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 object 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>ftpc</em>&nbsp;</td><td>FTPC 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 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>
A FTPC_PUSH_OBJECT_DATA_IND message will be received for each packet. A FTPC_PUSH_OBJECT_COMPLETE_IND message will be received after the last packet.     </td>
  </tr>
</table>
<a class="anchor" name="a27" doxytag="ftpc.h::FtpcPullObject" ></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 FtpcPullObject           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="ftpc_8h.html#a1">FTPC</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>ftpc</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></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>
Pull the first packet of an object from 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>ftpc</em>&nbsp;</td><td>FTPC Session Handle. </td></tr>
    <tr><td></td><td valign=top><em>size_name</em>&nbsp;</td><td>Length of the object name. </td></tr>
    <tr><td></td><td valign=top><em>name</em>&nbsp;</td><td>Object name.</td></tr>
  </table>
</dl>
The ownership of the pointer 'name' remains with the caller and must remain valid until a FTPC_PULL_OBJECT_START_IND message has been received.<p>
A FTPC_PULL_OBJECT_START_IND message will be received for the first packet. A FTPC_PULL_OBJECT_COMPLETE_IND message will be received after the last packet.     </td>
  </tr>
</table>
<a class="anchor" name="a28" doxytag="ftpc.h::FtpcPullObjectNextPacket" ></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 FtpcPullObjectNextPacket           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="ftpc_8h.html#a1">FTPC</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>ftpc</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>
Pull the next packet of the current object from 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>ftpc</em>&nbsp;</td><td>FTPC Session Handle.</td></tr>
  </table>
</dl>
A FTPC_PULL_OBJECT_DATA_IND message will be received for each packet after the first. A FTPC_PULL_OBJECT_COMPLETE_IND message will be received after the last packet.     </td>
  </tr>
</table>
<a class="anchor" name="a29" doxytag="ftpc.h::FtpcAbort" ></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 FtpcAbort           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="ftpc_8h.html#a1">FTPC</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>ftpc</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>
Abort the current multi-packet operation. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>ftpc</em>&nbsp;</td><td>FTPC Session Handle.</td></tr>
  </table>
</dl>
The relevant COMPLETE_IND message will be received with the status code of ftpc_aborted on success.     </td>
  </tr>
</table>
<a class="anchor" name="a30" doxytag="ftpc.h::FtpcDelete" ></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 FtpcDelete           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="ftpc_8h.html#a1">FTPC</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>ftpc</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>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></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>
Delete an Object. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>ftpc</em>&nbsp;</td><td>FTPC Session Handle. </td></tr>
    <tr><td></td><td valign=top><em>size_name</em>&nbsp;</td><td>Length of the object name. </td></tr>
    <tr><td></td><td valign=top><em>name</em>&nbsp;</td><td>The object name.</td></tr>
  </table>
</dl>
A FTPC_DELETE_COMPLETE_IND message will be received on completion.     </td>
  </tr>
</table>
<a class="anchor" name="a31" doxytag="ftpc.h::FtpcPacketComplete" ></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 FtpcPacketComplete           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="ftpc_8h.html#a1">FTPC</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>ftpc</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>ftpc</em>&nbsp;</td><td>FTPC Session Handle (as returned in FTPC_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 FTPC_PULL_OBJECT_START_IND has been received, FtpcPacketComplete must be called before calling FtpcPullObjectNextPacket.<p>
No message is received on completion.     </td>
  </tr>
</table>

</body>
</html>