📄 ftpc_8h.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>BlueLab: ftpc.h File Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.8 --><div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div><h1>ftpc.h File Reference</h1>Interface to the FTP Client library. <a href="#_details">More...</a><p><h2>Data Structures</h2><ul><li>struct <a class="el" href="struct_f_t_p_c___i_n_i_t___c_f_m___t.html">FTPC_INIT_CFM_T</a><dl class="el"><dd class="mdescRight">This message returns the result of an FtpcInit attempt. <a href="struct_f_t_p_c___i_n_i_t___c_f_m___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___c_o_n_n_e_c_t___c_f_m___t.html">FTPC_CONNECT_CFM_T</a><dl class="el"><dd class="mdescRight">This message returns the result of an FtpcConnect attempt. <a href="struct_f_t_p_c___c_o_n_n_e_c_t___c_f_m___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___a_u_t_h___r_e_q_u_e_s_t___i_n_d___t.html">FTPC_AUTH_REQUEST_IND_T</a><dl class="el"><dd class="mdescRight">This message is received when the remote server requests authentication during connection. <a href="struct_f_t_p_c___a_u_t_h___r_e_q_u_e_s_t___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___d_i_s_c_o_n_n_e_c_t___i_n_d___t.html">FTPC_DISCONNECT_IND_T</a><dl class="el"><dd class="mdescRight">This message returns the result of an FtpcDisconnect attempt. <a href="struct_f_t_p_c___d_i_s_c_o_n_n_e_c_t___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___g_o_t_o___r_o_o_t___c_f_m___t.html">FTPC_GOTO_ROOT_CFM_T</a><dl class="el"><dd class="mdescRight">This message is received as the result of a call to FtpcGotoRoot. <a href="struct_f_t_p_c___g_o_t_o___r_o_o_t___c_f_m___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___g_o_t_o___p_a_r_e_n_t___c_f_m___t.html">FTPC_GOTO_PARENT_CFM_T</a><dl class="el"><dd class="mdescRight">This message is received as the result of a call to FtpcGotoParent. <a href="struct_f_t_p_c___g_o_t_o___p_a_r_e_n_t___c_f_m___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___g_o_t_o___s_u_b_f_o_l_d_e_r___c_f_m___t.html">FTPC_GOTO_SUBFOLDER_CFM_T</a><dl class="el"><dd class="mdescRight">This message is received as the result of a call to FtpcGotoSubFolder. <a href="struct_f_t_p_c___g_o_t_o___s_u_b_f_o_l_d_e_r___c_f_m___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___b_r_o_w_s_e___f_o_l_d_e_r___d_a_t_a___i_n_d___t.html">FTPC_BROWSE_FOLDER_DATA_IND_T</a><dl class="el"><dd class="mdescRight">This message returns the result of an FtpcBrowseFolder attempt. <a href="struct_f_t_p_c___b_r_o_w_s_e___f_o_l_d_e_r___d_a_t_a___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___b_r_o_w_s_e___f_o_l_d_e_r___c_o_m_p_l_e_t_e___i_n_d___t.html">FTPC_BROWSE_FOLDER_COMPLETE_IND_T</a><dl class="el"><dd class="mdescRight">This message is received when a Browse Folder completes. <a href="struct_f_t_p_c___b_r_o_w_s_e___f_o_l_d_e_r___c_o_m_p_l_e_t_e___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___p_u_l_l___o_b_j_e_c_t___s_t_a_r_t___i_n_d___t.html">FTPC_PULL_OBJECT_START_IND_T</a><dl class="el"><dd class="mdescRight">This message returns when a pull operation has started. <a href="struct_f_t_p_c___p_u_l_l___o_b_j_e_c_t___s_t_a_r_t___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___p_u_l_l___o_b_j_e_c_t___c_o_m_p_l_e_t_e___i_n_d___t.html">FTPC_PULL_OBJECT_COMPLETE_IND_T</a><dl class="el"><dd class="mdescRight">This message returns when pull operation is complete. <a href="struct_f_t_p_c___p_u_l_l___o_b_j_e_c_t___c_o_m_p_l_e_t_e___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___p_u_l_l___o_b_j_e_c_t___d_a_t_a___i_n_d___t.html">FTPC_PULL_OBJECT_DATA_IND_T</a><dl class="el"><dd class="mdescRight">This message returns when pulled data has arrived. <a href="struct_f_t_p_c___p_u_l_l___o_b_j_e_c_t___d_a_t_a___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___p_u_s_h___o_b_j_e_c_t___c_o_m_p_l_e_t_e___i_n_d___t.html">FTPC_PUSH_OBJECT_COMPLETE_IND_T</a><dl class="el"><dd class="mdescRight">This message returns when the push operation is complete. <a href="struct_f_t_p_c___p_u_s_h___o_b_j_e_c_t___c_o_m_p_l_e_t_e___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___p_u_s_h___o_b_j_e_c_t___d_a_t_a___i_n_d___t.html">FTPC_PUSH_OBJECT_DATA_IND_T</a><dl class="el"><dd class="mdescRight">This message returns when more data is required to be pushed. <a href="struct_f_t_p_c___p_u_s_h___o_b_j_e_c_t___d_a_t_a___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_f_t_p_c___d_e_l_e_t_e___c_o_m_p_l_e_t_e___i_n_d___t.html">FTPC_DELETE_COMPLETE_IND_T</a><dl class="el"><dd class="mdescRight">This message returns when the delete operation is complete. <a href="struct_f_t_p_c___d_e_l_e_t_e___c_o_m_p_l_e_t_e___i_n_d___t.html#_details">More...</a><br></dl></ul><h2>Defines</h2><ul><li>#define <a class="el" href="ftpc_8h.html#a0">FTPC_MESSAGE_BASE</a> 0x6900</ul><h2>Typedefs</h2><ul><li>typedef __ftpcState <a class="el" href="ftpc_8h.html#a1">FTPC</a></ul><h2>Enumerations</h2><ul><li>enum <a class="el" href="ftpc_8h.html#a32">ftpc_lib_status</a> { <br> <a class="el" href="ftpc_8h.html#a32a2">ftpc_success</a>, <br> <a class="el" href="ftpc_8h.html#a32a3">ftpc_failure</a>, <br> <a class="el" href="ftpc_8h.html#a32a4">ftpc_unsupported</a>, <br> <a class="el" href="ftpc_8h.html#a32a5">ftpc_maxsessions</a>, <br> <a class="el" href="ftpc_8h.html#a32a6">ftpc_wrong_state</a>, <br> <a class="el" href="ftpc_8h.html#a32a7">ftpc_not_idle</a>, <br> <a class="el" href="ftpc_8h.html#a32a8">ftpc_wrong_command</a>, <br> <a class="el" href="ftpc_8h.html#a32a9">ftpc_folder_not_exist</a>, <br> <a class="el" href="ftpc_8h.html#a32a10">ftpc_folder_unauthorised</a>, <br> <a class="el" href="ftpc_8h.html#a32a11">ftpc_folder_at_root</a>, <br> <a class="el" href="ftpc_8h.html#a32a12">ftpc_param_error_invalid_size</a>, <br> <a class="el" href="ftpc_8h.html#a32a13">ftpc_aborted</a>, <br> <a class="el" href="ftpc_8h.html#a32a14">ftpc_end_of_status_list</a><br> }<dl class="el"><dd class="mdescRight">FTP status. <a href="#a32">More...</a><br></dl></ul><h2>Functions</h2><ul><li>void <a class="el" href="ftpc_8h.html#a15">FtpcInit</a> (<a class="el" href="struct_task_data.html">Task</a> theAppTask, <a class="el" href="csrtypes_8h.html#a4">uint16</a> priority)<dl class="el"><dd class="mdescRight">Initialise the FTPC Library. <a href="#a15"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a16">FtpcConnect</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc, const <a class="el" href="structbdaddr.html">bdaddr</a> *bdAddr, const <a class="el" href="csrtypes_8h.html#a4">uint16</a> maxPacketSize)<dl class="el"><dd class="mdescRight">Open an FTPC Connection with a server. <a href="#a16"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a17">FtpcDisconnect</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc)<dl class="el"><dd class="mdescRight">Disconnect from an server. <a href="#a17"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a18">FtpcConnectAuthResponse</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *digest, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_userid, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *userid, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *nonce)<li>void <a class="el" href="ftpc_8h.html#a19">FtpcGotoRoot</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc)<dl class="el"><dd class="mdescRight">Set the current folder on the server to the root folder. <a href="#a19"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a20">FtpcGotoParent</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc)<dl class="el"><dd class="mdescRight">Set the current folder on the server to the parent of the current folder. <a href="#a20"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a21">FtpcGotoSubFolder</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_folder, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *folder, <a class="el" href="csrtypes_8h.html#a9">bool</a> create)<dl class="el"><dd class="mdescRight">Set the current folder on the server to the sub-folder named 'folder'. <a href="#a21"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a22">FtpcBrowseFolder</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc)<dl class="el"><dd class="mdescRight">Get the folder listing from the server. <a href="#a22"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a23">FtpcPushObject</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc, const <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_name, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *name, const <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_type, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *type, const <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_packet, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *packet, const <a class="el" href="csrtypes_8h.html#a3">uint32</a> totalLen, const <a class="el" href="csrtypes_8h.html#a9">bool</a> onlyPacket)<dl class="el"><dd class="mdescRight">Push the first packet of an object to the server. <a href="#a23"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a24">FtpcPushObjectNextPacket</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc, const <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_packet, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *packet, const <a class="el" href="csrtypes_8h.html#a9">bool</a> lastPacket)<dl class="el"><dd class="mdescRight">Push the next packet of the current object to the server. <a href="#a24"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a25">FtpcPushObjectSource</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc, const <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_name, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *name, const <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_type, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *type, const <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_packet, <a class="el" href="source___8h.html#a0">Source</a> src, const <a class="el" href="csrtypes_8h.html#a3">uint32</a> totalLen, const <a class="el" href="csrtypes_8h.html#a9">bool</a> onlyPacket)<dl class="el"><dd class="mdescRight">Push the first packet of an object to the server. <a href="#a25"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a26">FtpcPushObjectNextPacketSource</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc, const <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_packet, <a class="el" href="source___8h.html#a0">Source</a> src, const <a class="el" href="csrtypes_8h.html#a9">bool</a> lastPacket)<dl class="el"><dd class="mdescRight">Push the next packet of the current object to the server. <a href="#a26"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a27">FtpcPullObject</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc, const <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_name, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *name)<dl class="el"><dd class="mdescRight">Pull the first packet of an object from the server. <a href="#a27"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a28">FtpcPullObjectNextPacket</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc)<dl class="el"><dd class="mdescRight">Pull the next packet of the current object from the server. <a href="#a28"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a29">FtpcAbort</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc)<dl class="el"><dd class="mdescRight">Abort the current multi-packet operation. <a href="#a29"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a30">FtpcDelete</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_name, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *name)<dl class="el"><dd class="mdescRight">Delete an Object. <a href="#a30"></a><br></dl><li>void <a class="el" href="ftpc_8h.html#a31">FtpcPacketComplete</a> (<a class="el" href="ftpc_8h.html#a1">FTPC</a> *ftpc)<dl class="el"><dd class="mdescRight">The packet received has been processed and is no longer needed. <a href="#a31"></a><br></dl></ul><hr><a name="_details"></a><h2>Detailed Description</h2>Interface to the FTP Client library. <p>Library Dependecies : connection,region,service, goep, bdaddr<p>Library variants:- ftpc - ftpc with no debug ftpc_debug - ftpc with debug checks ftpc_debug_print - ftpc with debug checks and print output<hr><h2>Define Documentation</h2><a class="anchor" name="a0" doxytag="ftpc.h::FTPC_MESSAGE_BASE" ></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"> #define FTPC_MESSAGE_BASE 0x6900 </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><hr><h2>Typedef Documentation</h2><a class="anchor" name="a1" doxytag="ftpc.h::FTPC" ></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"> typedef struct __ftpcState <a class="el" href="ftpc_8h.html#a1">FTPC</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><hr><h2>Enumeration Type Documentation</h2><a class="anchor" name="a32" doxytag="ftpc.h::ftpc_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="ftpc_8h.html#a32">ftpc_lib_status</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </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="a32a2" doxytag="ftpc_success" ></a>ftpc_success</em> </td><td>Last operation was successful. </td></tr><tr><td valign=top><em><a class="anchor" name="a32a3" doxytag="ftpc_failure" ></a>ftpc_failure</em> </td><td>Last operation failed. </td></tr><tr><td valign=top><em><a class="anchor" name="a32a4" doxytag="ftpc_unsupported" ></a>ftpc_unsupported</em> </td><td>Unsupported feature </td></tr><tr><td valign=top><em><a class="anchor" name="a32a5" doxytag="ftpc_maxsessions" ></a>ftpc_maxsessions</em> </td><td>Could not open a session due to having too many sessions open. </td></tr><tr><td valign=top><em><a class="anchor" name="a32a6" doxytag="ftpc_wrong_state" ></a>ftpc_wrong_state</em> </td><td>Operation failed due to being in the wrong state. </td></tr><tr><td valign=top><em><a class="anchor" name="a32a7" doxytag="ftpc_not_idle" ></a>ftpc_not_idle</em> </td><td>A command has been attempted while another command is already running. </td></tr><tr><td valign=top><em><a class="anchor" name="a32a8" doxytag="ftpc_wrong_command" ></a>ftpc_wrong_command</em> </td><td>A command has been attempted while a different multi-packet command is running. </td></tr><tr><td valign=top><em><a class="anchor" name="a32a9" doxytag="ftpc_folder_not_exist" ></a>ftpc_folder_not_exist</em> </td><td>Folder doesn't exist and couldn't be created. </td></tr><tr><td valign=top><em><a class="anchor" name="a32a10" doxytag="ftpc_folder_unauthorised" ></a>ftpc_folder_unauthorised</em> </td><td>Folder browsing in not permitted. </td></tr><tr><td valign=top><em><a class="anchor" name="a32a11" doxytag="ftpc_folder_at_root" ></a>ftpc_folder_at_root</em> </td><td>A goto parent commnd has been issued and current folder is root. </td></tr><tr><td valign=top><em><a class="anchor" name="a32a12" doxytag="ftpc_param_error_invalid_size" ></a>ftpc_param_error_invalid_size</em> </td><td>Packet size during push operation greater than maximum. </td></tr><tr><td valign=top><em><a class="anchor" name="a32a13" doxytag="ftpc_aborted" ></a>ftpc_aborted</em> </td><td>Current command was aborted. </td></tr><tr><td valign=top><em><a class="anchor" name="a32a14" doxytag="ftpc_end_of_status_list" ></a>ftpc_end_of_status_list</em> </td><td></td></tr></table></dl> </td> </tr></table><hr><h2>Function Documentation</h2><a class="anchor" name="a15" doxytag="ftpc.h::FtpcInit" ></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 FtpcInit </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="struct_task_data.html">Task</a> </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> </td> <td class="mdname" nowrap> <em>priority</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Initialise the FTPC 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> </td><td>The current application task.</td></tr> <tr><td></td><td valign=top><em>priority</em> </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>FTPC_INIT_CFM message will be received by the application. </td> </tr></table><a class="anchor" name="a16" doxytag="ftpc.h::FtpcConnect" ></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 FtpcConnect </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="ftpc_8h.html#a1">FTPC</a> * </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="structbdaddr.html">bdaddr</a> * </td> <td class="mdname" nowrap> <em>bdAddr</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> </td> <td class="mdname" nowrap> <em>maxPacketSize</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -