ftps_8h.html

BlueLab3 bluetooth API 说明文档

<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a46a9" doxytag="ftps_transfer_NotFound" ></a>ftps_transfer_NotFound</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a46a10" doxytag="ftps_transfer_Forbidden" ></a>ftps_transfer_Forbidden</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a46a11" doxytag="ftps_transfer_Unauthorized" ></a>ftps_transfer_Unauthorized</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a46a12" doxytag="ftps_transfer_BadRequest" ></a>ftps_transfer_BadRequest</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a46a13" doxytag="ftps_transfer_Readonly" ></a>ftps_transfer_Readonly</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a46a14" doxytag="ftps_transfer_EOL" ></a>ftps_transfer_EOL</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a47" doxytag="ftps.h::ftps_lib_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="ftps_8h.html#a47">ftps_lib_status</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
FTP status. 
<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="a47a15" doxytag="ftps_success" ></a>ftps_success</em>&nbsp;</td><td>
Last operation was successful. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a16" doxytag="ftps_failure" ></a>ftps_failure</em>&nbsp;</td><td>
Last operation failed. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a17" doxytag="ftps_wrong_state" ></a>ftps_wrong_state</em>&nbsp;</td><td>
Operation failed due to being in the wrong state. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a18" doxytag="ftps_not_idle" ></a>ftps_not_idle</em>&nbsp;</td><td>
A command has been attempted while another command is already running. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a19" doxytag="ftps_invalid_sdp" ></a>ftps_invalid_sdp</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a20" doxytag="ftps_badrequest" ></a>ftps_badrequest</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a21" doxytag="ftps_forbidden" ></a>ftps_forbidden</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a22" doxytag="ftps_notfound" ></a>ftps_notfound</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a23" doxytag="ftps_remote_abort" ></a>ftps_remote_abort</em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="a47a24" doxytag="ftps_end_of_status_list" ></a>ftps_end_of_status_list</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a25" doxytag="ftps.h::FtpsInit" ></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 FtpsInit           </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="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 FTPS 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>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>
FTPS_INIT_CFM message will be received by the application.     </td>
  </tr>
</table>
<a class="anchor" name="a26" doxytag="ftps.h::FtpsConnectResponse" ></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 FtpsConnectResponse           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="ftps_8h.html#a1">FTPS</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>ftps</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>accept</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>pktSize</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="ftps_8h.html#a44">ftps_serv_type</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>type</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>
Respond to a connection request. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>ftps</em>&nbsp;</td><td>FTPS Session Handle. </td></tr>
    <tr><td></td><td valign=top><em>accept</em>&nbsp;</td><td>TRUE to accept the connection, or FALSE to refuse it. </td></tr>
    <tr><td></td><td valign=top><em>pktSize</em>&nbsp;</td><td>Maximum packet size that can be accepted on this connection. </td></tr>
    <tr><td></td><td valign=top><em>type</em>&nbsp;</td><td>Server type - Is the server read only?</td></tr>
  </table>
</dl>
This function should be called on recept of a FTPS_CONNECT_IND message. A FTPS_CONNECT_CFM message will be received on completion.     </td>
  </tr>
</table>
<a class="anchor" name="a27" doxytag="ftps.h::FtpsConnectAuthChallenge" ></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 FtpsConnectAuthChallenge           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="ftps_8h.html#a1">FTPS</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>ftps</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>nonce</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>options</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_realm</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>realm</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>
    </td>
  </tr>
</table>
<a class="anchor" name="a28" doxytag="ftps.h::FtpsGetFolderFirstPacket" ></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 FtpsGetFolderFirstPacket           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="ftps_8h.html#a1">FTPS</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>ftps</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#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>