📄 oppc_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: oppc.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>oppc.h File Reference</h1>Interface to the OPP Client library. <a href="#_details">More...</a><p><h2>Data Structures</h2><ul><li>struct <a class="el" href="struct_o_p_p_c___i_n_i_t___c_f_m___t.html">OPPC_INIT_CFM_T</a><dl class="el"><dd class="mdescRight">This message returns the result of an OppcInit attempt. <a href="struct_o_p_p_c___i_n_i_t___c_f_m___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_o_p_p_c___c_o_n_n_e_c_t___c_f_m___t.html">OPPC_CONNECT_CFM_T</a><dl class="el"><dd class="mdescRight">This message returns the result of an OppcConnect attempt. <a href="struct_o_p_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_o_p_p_c___a_u_t_h___r_e_q_u_e_s_t___i_n_d___t.html">OPPC_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_o_p_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_o_p_p_c___d_i_s_c_o_n_n_e_c_t___i_n_d___t.html">OPPC_DISCONNECT_IND_T</a><dl class="el"><dd class="mdescRight">This message returns the result of an OppcDisconnect attempt. <a href="struct_o_p_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_o_p_p_c___p_u_s_h___c_o_m_p_l_e_t_e___i_n_d___t.html">OPPC_PUSH_COMPLETE_IND_T</a><dl class="el"><dd class="mdescRight">This message returns when the push operation is complete. <a href="struct_o_p_p_c___p_u_s_h___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_o_p_p_c___p_u_s_h___m_o_r_e___d_a_t_a___i_n_d___t.html">OPPC_PUSH_MORE_DATA_IND_T</a><dl class="el"><dd class="mdescRight">This message returns when the push operation is ready for more data. <a href="struct_o_p_p_c___p_u_s_h___m_o_r_e___d_a_t_a___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_o_p_p_c___p_u_l_l___b_c___s_t_a_r_t___i_n_d___t.html">OPPC_PULL_BC_START_IND_T</a><dl class="el"><dd class="mdescRight">This message returns when a pull business card operation has started. <a href="struct_o_p_p_c___p_u_l_l___b_c___s_t_a_r_t___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_o_p_p_c___p_u_l_l___b_c___d_a_t_a___i_n_d___t.html">OPPC_PULL_BC_DATA_IND_T</a><dl class="el"><dd class="mdescRight">This message returns when pulled business card data has arrived. <a href="struct_o_p_p_c___p_u_l_l___b_c___d_a_t_a___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_o_p_p_c___p_u_l_l___b_c___c_o_m_p_l_e_t_e___i_n_d___t.html">OPPC_PULL_BC_COMPLETE_IND_T</a><dl class="el"><dd class="mdescRight">This message returns when pull business card operation is complete. <a href="struct_o_p_p_c___p_u_l_l___b_c___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="oppc_8h.html#a0">OPPC_MESSAGE_BASE</a> 0x6700</ul><h2>Typedefs</h2><ul><li>typedef __oppcState <a class="el" href="oppc_8h.html#a1">OPPC</a></ul><h2>Enumerations</h2><ul><li>enum <a class="el" href="oppc_8h.html#a26">oppc_lib_status</a> { <br> <a class="el" href="oppc_8h.html#a26a2">oppc_success</a>, <br> <a class="el" href="oppc_8h.html#a26a3">oppc_failure</a>, <br> <a class="el" href="oppc_8h.html#a26a4">oppc_not_idle</a>, <br> <a class="el" href="oppc_8h.html#a26a5">oppc_wrong_command</a>, <br> <a class="el" href="oppc_8h.html#a26a6">oppc_wrong_state</a>, <br> <a class="el" href="oppc_8h.html#a26a7">oppc_badrequest</a>, <br> <a class="el" href="oppc_8h.html#a26a8">oppc_forbidden</a>, <br> <a class="el" href="oppc_8h.html#a26a9">oppc_notfound</a>, <br> <a class="el" href="oppc_8h.html#a26a10">oppc_aborted</a>, <br> <a class="el" href="oppc_8h.html#a26a11">oppc_end_of_status_list</a><br> }<dl class="el"><dd class="mdescRight">FTP status. <a href="#a26">More...</a><br></dl></ul><h2>Functions</h2><ul><li>void <a class="el" href="oppc_8h.html#a12">OppcInit</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 OPPC Library. <a href="#a12"></a><br></dl><li>void <a class="el" href="oppc_8h.html#a13">OppcConnect</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc, 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 OPPC Connection with a server. <a href="#a13"></a><br></dl><li>void <a class="el" href="oppc_8h.html#a14">oppcConnectAuthResponse</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc, 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="oppc_8h.html#a15">OppcDisconnect</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc)<dl class="el"><dd class="mdescRight">Disconnect from an server. <a href="#a15"></a><br></dl><li>void <a class="el" href="oppc_8h.html#a16">OppcAbort</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc, const <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_description, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *description)<dl class="el"><dd class="mdescRight">Abort the current multi-packet operation. <a href="#a16"></a><br></dl><li>void <a class="el" href="oppc_8h.html#a17">OppcPushObject</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc, 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="#a17"></a><br></dl><li>void <a class="el" href="oppc_8h.html#a18">OppcPushNextPacket</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc, 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="#a18"></a><br></dl><li>void <a class="el" href="oppc_8h.html#a19">OppcPushObjectSource</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc, 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="#a19"></a><br></dl><li>void <a class="el" href="oppc_8h.html#a20">OppcPushNextPacketSource</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc, 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="#a20"></a><br></dl><li>void <a class="el" href="oppc_8h.html#a21">OppcPushBusinessCard</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc, 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_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 a vCard (business card) to the server. <a href="#a21"></a><br></dl><li>void <a class="el" href="oppc_8h.html#a22">OppcPushBusinessCardSource</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc, 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_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 a vCard (business card) to the server. <a href="#a22"></a><br></dl><li>void <a class="el" href="oppc_8h.html#a23">OppcPullBusinessCard</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc)<dl class="el"><dd class="mdescRight">Request the owner's business card from the OPP Server. <a href="#a23"></a><br></dl><li>void <a class="el" href="oppc_8h.html#a24">OppcPullNextBcPacket</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc)<dl class="el"><dd class="mdescRight">Pull the next packet of the current object from the server. <a href="#a24"></a><br></dl><li>void <a class="el" href="oppc_8h.html#a25">OppcPacketComplete</a> (<a class="el" href="oppc_8h.html#a1">OPPC</a> *oppc)<dl class="el"><dd class="mdescRight">The packet received has been processed and is no longer needed. <a href="#a25"></a><br></dl></ul><hr><a name="_details"></a><h2>Detailed Description</h2>Interface to the OPP Client library. <p>Library Dependecies : connection,region,service, goep, bdaddr<p>Library variants:- oppc - oppc with no debug oppc_debug - oppc with debug checks oppc_debug_print - oppc with debug checks and print output<hr><h2>Define Documentation</h2><a class="anchor" name="a0" doxytag="oppc.h::OPPC_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 OPPC_MESSAGE_BASE 0x6700 </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="oppc.h::OPPC" ></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 __oppcState <a class="el" href="oppc_8h.html#a1">OPPC</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="a26" doxytag="oppc.h::oppc_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="oppc_8h.html#a26">oppc_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="a26a2" doxytag="oppc_success" ></a>oppc_success</em> </td><td>Last operation was successful. </td></tr><tr><td valign=top><em><a class="anchor" name="a26a3" doxytag="oppc_failure" ></a>oppc_failure</em> </td><td>Last operation failed. </td></tr><tr><td valign=top><em><a class="anchor" name="a26a4" doxytag="oppc_not_idle" ></a>oppc_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="a26a5" doxytag="oppc_wrong_command" ></a>oppc_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="a26a6" doxytag="oppc_wrong_state" ></a>oppc_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="a26a7" doxytag="oppc_badrequest" ></a>oppc_badrequest</em> </td><td></td></tr><tr><td valign=top><em><a class="anchor" name="a26a8" doxytag="oppc_forbidden" ></a>oppc_forbidden</em> </td><td></td></tr><tr><td valign=top><em><a class="anchor" name="a26a9" doxytag="oppc_notfound" ></a>oppc_notfound</em> </td><td></td></tr><tr><td valign=top><em><a class="anchor" name="a26a10" doxytag="oppc_aborted" ></a>oppc_aborted</em> </td><td></td></tr><tr><td valign=top><em><a class="anchor" name="a26a11" doxytag="oppc_end_of_status_list" ></a>oppc_end_of_status_list</em> </td><td></td></tr></table></dl> </td> </tr></table><hr><h2>Function Documentation</h2><a class="anchor" name="a12" doxytag="oppc.h::OppcInit" ></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 OppcInit </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 OPPC 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>OPPC_INIT_CFM message will be received by the application. </td> </tr></table><a class="anchor" name="a13" doxytag="oppc.h::OppcConnect" ></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 OppcConnect </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="oppc_8h.html#a1">OPPC</a> * </td> <td class="mdname" nowrap> <em>oppc</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> </table> </td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -