📄 opps_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: opps.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>opps.h File Reference</h1>Interface to the OPP Server library. <a href="#_details">More...</a><p><h2>Data Structures</h2><ul><li>struct <a class="el" href="struct_o_p_p_s___i_n_i_t___c_f_m___t.html">OPPS_INIT_CFM_T</a><dl class="el"><dd class="mdescRight">This message returns the result of an OppsInit attempt. <a href="struct_o_p_p_s___i_n_i_t___c_f_m___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_o_p_p_s___c_o_n_n_e_c_t___i_n_d___t.html">OPPS_CONNECT_IND_T</a><dl class="el"><dd class="mdescRight">This message is sent when an remote client attempts to make a connection. <a href="struct_o_p_p_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_s___c_o_n_n_e_c_t___c_f_m___t.html">OPPS_CONNECT_CFM_T</a><dl class="el"><dd class="mdescRight">This message is sent when a remote connection completes. <a href="struct_o_p_p_s___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_s___a_u_t_h___r_e_s_u_l_t___i_n_d___t.html">OPPS_AUTH_RESULT_IND_T</a><dl class="el"><dd class="mdescRight">This message is sent when an authentication challenge completes during a connect. <a href="struct_o_p_p_s___a_u_t_h___r_e_s_u_l_t___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_o_p_p_s___d_i_s_c_o_n_n_e_c_t___i_n_d___t.html">OPPS_DISCONNECT_IND_T</a><dl class="el"><dd class="mdescRight">This message indicates that a disconnect operation has completed. <a href="struct_o_p_p_s___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_s___p_u_s_h___o_b_j___s_t_a_r_t___i_n_d___t.html">OPPS_PUSH_OBJ_START_IND_T</a><dl class="el"><dd class="mdescRight">This message is sent when a remote object push starts. <a href="struct_o_p_p_s___p_u_s_h___o_b_j___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_s___p_u_s_h___b_c___s_t_a_r_t___i_n_d___t.html">OPPS_PUSH_BC_START_IND_T</a><dl class="el"><dd class="mdescRight">This message is sent when a remote business card push starts. <a href="struct_o_p_p_s___p_u_s_h___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_s___p_u_s_h___o_b_j___c_o_m_p_l_e_t_e___i_n_d___t.html">OPPS_PUSH_OBJ_COMPLETE_IND_T</a><dl class="el"><dd class="mdescRight">This message is sent when a remote object push completes. <a href="struct_o_p_p_s___p_u_s_h___o_b_j___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_s___p_u_s_h___b_c___c_o_m_p_l_e_t_e___i_n_d___t.html">OPPS_PUSH_BC_COMPLETE_IND_T</a><dl class="el"><dd class="mdescRight">This message is sent when a remote object push completes. <a href="struct_o_p_p_s___p_u_s_h___b_c___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_s___p_u_s_h___o_b_j___d_a_t_a___i_n_d___t.html">OPPS_PUSH_OBJ_DATA_IND_T</a><dl class="el"><dd class="mdescRight">This message is sent when data associated with a remote object push arrives. <a href="struct_o_p_p_s___p_u_s_h___o_b_j___d_a_t_a___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_o_p_p_s___p_u_s_h___b_c___d_a_t_a___i_n_d___t.html">OPPS_PUSH_BC_DATA_IND_T</a><dl class="el"><dd class="mdescRight">This message is sent when data associated with a remote business card push arrives. <a href="struct_o_p_p_s___p_u_s_h___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_s___p_u_l_l___b_c___s_t_a_r_t___i_n_d___t.html">OPPS_PULL_BC_START_IND_T</a><dl class="el"><dd class="mdescRight">This message indicates that a pull business card operation has started. <a href="struct_o_p_p_s___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_s___p_u_l_l___b_c___m_o_r_e_d_a_t_a___i_n_d___t.html">OPPS_PULL_BC_MOREDATA_IND_T</a><dl class="el"><dd class="mdescRight">This message indicates that a pull business card operation needs more data. <a href="struct_o_p_p_s___p_u_l_l___b_c___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_s___p_u_l_l___b_c___c_o_m_p_l_e_t_e___i_n_d___t.html">OPPS_PULL_BC_COMPLETE_IND_T</a><dl class="el"><dd class="mdescRight">This message is sent when a PULL Business Card request completes. <a href="struct_o_p_p_s___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="opps_8h.html#a0">OPPS_MESSAGE_BASE</a> 0x6600</ul><h2>Typedefs</h2><ul><li>typedef __oppsState <a class="el" href="opps_8h.html#a1">OPPS</a></ul><h2>Enumerations</h2><ul><li>enum <a class="el" href="opps_8h.html#a24">opps_lib_status</a> { <br> <a class="el" href="opps_8h.html#a24a2">opps_success</a>, <br> <a class="el" href="opps_8h.html#a24a3">opps_failure</a>, <br> <a class="el" href="opps_8h.html#a24a4">opps_maxsessions</a>, <br> <a class="el" href="opps_8h.html#a24a5">opps_not_idle</a>, <br> <a class="el" href="opps_8h.html#a24a6">opps_wrong_command</a>, <br> <a class="el" href="opps_8h.html#a24a7">opps_wrong_state</a>, <br> <a class="el" href="opps_8h.html#a24a8">opps_invalid_sdp</a>, <br> <a class="el" href="opps_8h.html#a24a9">opps_badrequest</a>, <br> <a class="el" href="opps_8h.html#a24a10">opps_forbidden</a>, <br> <a class="el" href="opps_8h.html#a24a11">opps_notfound</a>, <br> <a class="el" href="opps_8h.html#a24a12">opps_aborted</a>, <br> <a class="el" href="opps_8h.html#a24a13">opps_end_of_status_list</a><br> }<dl class="el"><dd class="mdescRight">FTP status. <a href="#a24">More...</a><br></dl></ul><h2>Functions</h2><ul><li>void <a class="el" href="opps_8h.html#a14">OppsInit</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 OPPS Library. <a href="#a14"></a><br></dl><li>void <a class="el" href="opps_8h.html#a15">OppsConnectResponse</a> (<a class="el" href="opps_8h.html#a1">OPPS</a> *opps, <a class="el" href="csrtypes_8h.html#a9">bool</a> accept, <a class="el" href="csrtypes_8h.html#a4">uint16</a> pktSize)<dl class="el"><dd class="mdescRight">Accept or refuse a connection. <a href="#a15"></a><br></dl><li>void <a class="el" href="opps_8h.html#a16">OppsConnectAuthChallenge</a> (<a class="el" href="opps_8h.html#a1">OPPS</a> *opps, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *nonce, <a class="el" href="csrtypes_8h.html#a8">uint8</a> options, <a class="el" href="csrtypes_8h.html#a4">uint16</a> size_realm, const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *realm)<li>void <a class="el" href="opps_8h.html#a17">OppsAbort</a> (<a class="el" href="opps_8h.html#a1">OPPS</a> *opps)<dl class="el"><dd class="mdescRight">Abort the current multi-packet operation. <a href="#a17"></a><br></dl><li>void <a class="el" href="opps_8h.html#a18">OppsGetNextPutPacket</a> (<a class="el" href="opps_8h.html#a1">OPPS</a> *opps, <a class="el" href="csrtypes_8h.html#a9">bool</a> moreData)<dl class="el"><dd class="mdescRight">Request the next packet during a Remote PUT operation. <a href="#a18"></a><br></dl><li>void <a class="el" href="opps_8h.html#a19">OppsPushBusinessCardStart</a> (<a class="el" href="opps_8h.html#a1">OPPS</a> *opps, 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="#a19"></a><br></dl><li>void <a class="el" href="opps_8h.html#a20">OppsPushBusinessCardNext</a> (<a class="el" href="opps_8h.html#a1">OPPS</a> *opps, 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 vCard to the server. <a href="#a20"></a><br></dl><li>void <a class="el" href="opps_8h.html#a21">OppsPushBusinessCardStartSource</a> (<a class="el" href="opps_8h.html#a1">OPPS</a> *opps, 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="#a21"></a><br></dl><li>void <a class="el" href="opps_8h.html#a22">OppsPushBusinessCardNextSource</a> (<a class="el" href="opps_8h.html#a1">OPPS</a> *opps, 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 vCard to the server. <a href="#a22"></a><br></dl><li>void <a class="el" href="opps_8h.html#a23">OppsPacketComplete</a> (<a class="el" href="opps_8h.html#a1">OPPS</a> *opps)<dl class="el"><dd class="mdescRight">The packet received has been processed and is no longer needed. <a href="#a23"></a><br></dl></ul><hr><a name="_details"></a><h2>Detailed Description</h2>Interface to the OPP Server library. <p>Library Dependecies : connection,region,service, goep, bdaddr<p>Library variants:- opps - opps with no debug opps_debug - opps with debug checks opps_debug_print - opps with debug checks and print output<hr><h2>Define Documentation</h2><a class="anchor" name="a0" doxytag="opps.h::OPPS_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 OPPS_MESSAGE_BASE 0x6600 </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="opps.h::OPPS" ></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 __oppsState <a class="el" href="opps_8h.html#a1">OPPS</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="a24" doxytag="opps.h::opps_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="opps_8h.html#a24">opps_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="a24a2" doxytag="opps_success" ></a>opps_success</em> </td><td>Last operation was successful. </td></tr><tr><td valign=top><em><a class="anchor" name="a24a3" doxytag="opps_failure" ></a>opps_failure</em> </td><td>Last operation failed. </td></tr><tr><td valign=top><em><a class="anchor" name="a24a4" doxytag="opps_maxsessions" ></a>opps_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="a24a5" doxytag="opps_not_idle" ></a>opps_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="a24a6" doxytag="opps_wrong_command" ></a>opps_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="a24a7" doxytag="opps_wrong_state" ></a>opps_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="a24a8" doxytag="opps_invalid_sdp" ></a>opps_invalid_sdp</em> </td><td></td></tr><tr><td valign=top><em><a class="anchor" name="a24a9" doxytag="opps_badrequest" ></a>opps_badrequest</em> </td><td></td></tr><tr><td valign=top><em><a class="anchor" name="a24a10" doxytag="opps_forbidden" ></a>opps_forbidden</em> </td><td></td></tr><tr><td valign=top><em><a class="anchor" name="a24a11" doxytag="opps_notfound" ></a>opps_notfound</em> </td><td></td></tr><tr><td valign=top><em><a class="anchor" name="a24a12" doxytag="opps_aborted" ></a>opps_aborted</em> </td><td></td></tr><tr><td valign=top><em><a class="anchor" name="a24a13" doxytag="opps_end_of_status_list" ></a>opps_end_of_status_list</em> </td><td></td></tr></table></dl> </td> </tr></table><hr><h2>Function Documentation</h2><a class="anchor" name="a14" doxytag="opps.h::OppsInit" ></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 OppsInit </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 OPPS 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>OPPS_INIT_CFM message will be received by the application. </td> </tr></table><a class="anchor" name="a15" doxytag="opps.h::OppsConnectResponse" ></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 OppsConnectResponse </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="opps_8h.html#a1">OPPS</a> * </td> <td class="mdname" nowrap> <em>opps</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> </td> <td class="mdname" nowrap> <em>accept</em>, </td> </tr> <tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -