📄 dun_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: dun.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>dun.h File Reference</h1>Header file for the Dial Up Networking library. <a href="#_details">More...</a><p><h2>Data Structures</h2><ul><li>struct <a class="el" href="struct_d_u_n___i_n_i_t___c_f_m___t.html">DUN_INIT_CFM_T</a><dl class="el"><dd class="mdescRight">An initialise confirmation message from the DUN library. <a href="struct_d_u_n___i_n_i_t___c_f_m___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_d_u_n___c_o_n_n_e_c_t___c_f_m___t.html">DUN_CONNECT_CFM_T</a><dl class="el"><dd class="mdescRight">A connection confirmation message from the DUN library. <a href="struct_d_u_n___c_o_n_n_e_c_t___c_f_m___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_d_u_n___c_o_n_n_e_c_t___i_n_d___t.html">DUN_CONNECT_IND_T</a><dl class="el"><dd class="mdescRight">A connection indication message from the DUN library. <a href="struct_d_u_n___c_o_n_n_e_c_t___i_n_d___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_d_u_n___d_i_s_c_o_n_n_e_c_t___i_n_d___t.html">DUN_DISCONNECT_IND_T</a><dl class="el"><dd class="mdescRight">A disconnection indication message from the DUN library. <a href="struct_d_u_n___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_d_u_n___m_e_s_s_a_g_e___m_o_r_e___d_a_t_a___t.html">DUN_MESSAGE_MORE_DATA_T</a><dl class="el"><dd class="mdescRight">A source associated with a DUN task has more data. <a href="struct_d_u_n___m_e_s_s_a_g_e___m_o_r_e___d_a_t_a___t.html#_details">More...</a><br></dl><li>struct <a class="el" href="struct_d_u_n___m_e_s_s_a_g_e___m_o_r_e___s_p_a_c_e___t.html">DUN_MESSAGE_MORE_SPACE_T</a><dl class="el"><dd class="mdescRight">A sink associated with a DUN task has more space. <a href="struct_d_u_n___m_e_s_s_a_g_e___m_o_r_e___s_p_a_c_e___t.html#_details">More...</a><br></dl></ul><h2>Defines</h2><ul><li>#define <a class="el" href="dun_8h.html#a0">DUN_NO_PIN</a> 0xffff<dl class="el"><dd class="mdescRight">The Modem signalling line is not connected to a PIO Pin. <a href="#a0"></a><br></dl><li>#define <a class="el" href="dun_8h.html#a1">DUN_MESSAGE_BASE</a> 0x5f00<dl class="el"><dd class="mdescRight">Base message number for this library. <a href="#a1"></a><br></dl></ul><h2>Typedefs</h2><ul><li>typedef __DUN <a class="el" href="dun_8h.html#a2">DUN</a><dl class="el"><dd class="mdescRight">The Dial Up Networking Profile structure. <a href="#a2"></a><br></dl></ul><h2>Enumerations</h2><ul><li>enum <a class="el" href="dun_8h.html#a36">DunMessageId</a> { <br> <a class="el" href="dun_8h.html#a36a3">DUN_INIT_CFM</a> = DUN_MESSAGE_BASE, <br> <a class="el" href="dun_8h.html#a36a4">DUN_CONNECT_CFM</a>, <br> <a class="el" href="dun_8h.html#a36a5">DUN_CONNECT_IND</a>, <br> <a class="el" href="dun_8h.html#a36a6">DUN_DISCONNECT_IND</a>, <br> <a class="el" href="dun_8h.html#a36a7">DUN_MESSAGE_MORE_DATA</a>, <br> <a class="el" href="dun_8h.html#a36a8">DUN_MESSAGE_MORE_SPACE</a>, <br> <a class="el" href="dun_8h.html#a36a9">DUN_MESSAGE_TOP</a><br> }<dl class="el"><dd class="mdescRight">The main app messages sent by the DUN library. <a href="#a36">More...</a><br></dl><li>enum <a class="el" href="dun_8h.html#a37">dun_device_type</a> { <br> <a class="el" href="dun_8h.html#a37a10">dunlibDCE</a>, <br> <a class="el" href="dun_8h.html#a37a11">dunlibDTE</a><br> }<dl class="el"><dd class="mdescRight">The type of device. <a href="#a37">More...</a><br></dl><li>enum <a class="el" href="dun_8h.html#a38">dun_init_status</a> { <br> <a class="el" href="dun_8h.html#a38a12">dun_init_success</a>, <br> <a class="el" href="dun_8h.html#a38a13">dun_init_rfc_chan_fail</a>, <br> <a class="el" href="dun_8h.html#a38a14">dun_init_sdp_reg_fail</a>, <br> <a class="el" href="dun_8h.html#a38a15">dun_init_fail</a><br> }<dl class="el"><dd class="mdescRight">Possible status codes for the init cfm message. <a href="#a38">More...</a><br></dl><li>enum <a class="el" href="dun_8h.html#a39">dun_connect_status</a> { <br> <a class="el" href="dun_8h.html#a39a16">dun_connect_success</a>, <br> <a class="el" href="dun_8h.html#a39a17">dun_connect_sdp_fail</a>, <br> <a class="el" href="dun_8h.html#a39a18">dun_connect_slc_failed</a>, <br> <a class="el" href="dun_8h.html#a39a19">dun_connect_failed_busy</a>, <br> <a class="el" href="dun_8h.html#a39a20">dun_connect_failed</a>, <br> <a class="el" href="dun_8h.html#a39a21">dun_connect_server_channel_not_registered</a>, <br> <a class="el" href="dun_8h.html#a39a22">dun_connect_timeout</a>, <br> <a class="el" href="dun_8h.html#a39a23">dun_connect_rejected</a>, <br> <a class="el" href="dun_8h.html#a39a24">dun_connect_normal_disconnect</a>, <br> <a class="el" href="dun_8h.html#a39a25">dun_connect_abnormal_disconnect</a>, <br> <a class="el" href="dun_8h.html#a39a26">dun_connect_invalid</a><br> }<dl class="el"><dd class="mdescRight">Return status for the DUN_CONNECT_CFM message. <a href="#a39">More...</a><br></dl><li>enum <a class="el" href="dun_8h.html#a40">dun_disconnect_status</a> { <br> <a class="el" href="dun_8h.html#a40a27">dun_disconnect_success</a>, <br> <a class="el" href="dun_8h.html#a40a28">dun_disconnect_link_loss</a>, <br> <a class="el" href="dun_8h.html#a40a29">dun_disconnect_no_slc</a>, <br> <a class="el" href="dun_8h.html#a40a30">dun_disconnect_timeout</a>, <br> <a class="el" href="dun_8h.html#a40a31">dun_disconnect_error</a><br> }<dl class="el"><dd class="mdescRight">Possible status codes for the disconnect message. <a href="#a40">More...</a><br></dl></ul><h2>Functions</h2><ul><li>void <a class="el" href="dun_8h.html#a32">DunInit</a> (<a class="el" href="struct_task_data.html">Task</a> theAppTask, <a class="el" href="dun_8h.html#a37">dun_device_type</a> type_of_device, <a class="el" href="csrtypes_8h.html#a4">uint16</a> RI, <a class="el" href="csrtypes_8h.html#a4">uint16</a> DTR, <a class="el" href="csrtypes_8h.html#a4">uint16</a> DCD, <a class="el" href="csrtypes_8h.html#a4">uint16</a> DSR, <a class="el" href="csrtypes_8h.html#a4">uint16</a> priority)<dl class="el"><dd class="mdescRight">Initialise the DUN library. <a href="#a32"></a><br></dl><li>void <a class="el" href="dun_8h.html#a33">DunConnect</a> (<a class="el" href="dun_8h.html#a2">DUN</a> *dun, const <a class="el" href="structbdaddr.html">bdaddr</a> *bd_addr)<dl class="el"><dd class="mdescRight">Handle Connect request by sending an internal message. <a href="#a33"></a><br></dl><li>void <a class="el" href="dun_8h.html#a34">DunConnectResponse</a> (<a class="el" href="dun_8h.html#a2">DUN</a> *dun, <a class="el" href="csrtypes_8h.html#a9">bool</a> response, const <a class="el" href="structbdaddr.html">bdaddr</a> *bd_addr)<dl class="el"><dd class="mdescRight">Handle response to a connection request by sending an internal message. <a href="#a34"></a><br></dl><li>void <a class="el" href="dun_8h.html#a35">DunDisconnect</a> (<a class="el" href="dun_8h.html#a2">DUN</a> *dun)<dl class="el"><dd class="mdescRight">Disconnect the service level connection for the supported profile. <a href="#a35"></a><br></dl></ul><hr><a name="_details"></a><h2>Detailed Description</h2>Header file for the Dial Up Networking library. <p>This library implements the Dial Up Networking Profile Specification. The Dial Up Networking Profile Specification (hereafter referred to as DUN) is used to set up an emulated serial moden connection using RFCOMM between two peer devices. The RFCOMM session exists on an L2CAP channel.<p>As well as handling the RFCOMM link, the DUN library handles the registration of a service record with the SDP database, so that the service/applications can be reached via RFCOMM.<p>The library exposes a functional downstream API and an upstream message based API.<p>The DUN library is dependant on the SPP Library and the PIO Library. The PIO Library must have been initialised before initialising the DUN Library. The application is responsible for initialising Pio Debouncing (using PioDebounce) for all input pins.<p>Library variants:- dun - DUN with no debug output dun_print - DUN with debug output<hr><h2>Define Documentation</h2><a class="anchor" name="a0" doxytag="dun.h::DUN_NO_PIN" ></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 DUN_NO_PIN 0xffff </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>The Modem signalling line is not connected to a PIO Pin. <p> </td> </tr></table><a class="anchor" name="a1" doxytag="dun.h::DUN_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 DUN_MESSAGE_BASE 0x5f00 </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Base message number for this library. <p> </td> </tr></table><hr><h2>Typedef Documentation</h2><a class="anchor" name="a2" doxytag="dun.h::DUN" ></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 __DUN <a class="el" href="dun_8h.html#a2">DUN</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>The Dial Up Networking Profile structure. <p> </td> </tr></table><hr><h2>Enumeration Type Documentation</h2><a class="anchor" name="a36" doxytag="dun.h::DunMessageId" ></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="dun_8h.html#a36">DunMessageId</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>The main app messages sent by the DUN library. <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="a36a3" doxytag="DUN_INIT_CFM" ></a>DUN_INIT_CFM</em> </td><td>This message indicates the result of a initialisation attempt. </td></tr><tr><td valign=top><em><a class="anchor" name="a36a4" doxytag="DUN_CONNECT_CFM" ></a>DUN_CONNECT_CFM</em> </td><td>This message indicates the result of a connection attempt. </td></tr><tr><td valign=top><em><a class="anchor" name="a36a5" doxytag="DUN_CONNECT_IND" ></a>DUN_CONNECT_IND</em> </td><td>This message indicates that another device is trying to connect. This message must be responded to using DunConnectResponse. </td></tr><tr><td valign=top><em><a class="anchor" name="a36a6" doxytag="DUN_DISCONNECT_IND" ></a>DUN_DISCONNECT_IND</em> </td><td>This message indicates the result of a disconnect attempt. </td></tr><tr><td valign=top><em><a class="anchor" name="a36a7" doxytag="DUN_MESSAGE_MORE_DATA" ></a>DUN_MESSAGE_MORE_DATA</em> </td><td>This message indicates that a source associated with a DUN profile task has received more data. </td></tr><tr><td valign=top><em><a class="anchor" name="a36a8" doxytag="DUN_MESSAGE_MORE_SPACE" ></a>DUN_MESSAGE_MORE_SPACE</em> </td><td>This message indicates that a sink associated with a DUN profile task has more space. </td></tr><tr><td valign=top><em><a class="anchor" name="a36a9" doxytag="DUN_MESSAGE_TOP" ></a>DUN_MESSAGE_TOP</em> </td><td></td></tr></table></dl> </td> </tr></table><a class="anchor" name="a37" doxytag="dun.h::dun_device_type" ></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="dun_8h.html#a37">dun_device_type</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>The type of device. <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="a37a10" doxytag="dunlibDCE" ></a>dunlibDCE</em> </td><td>DUN Data Circuit Equipment - DUN Master. </td></tr><tr><td valign=top><em><a class="anchor" name="a37a11" doxytag="dunlibDTE" ></a>dunlibDTE</em> </td><td>DUN Data Terminal Endpoint - DUN Slave. </td></tr></table></dl> </td> </tr></table><a class="anchor" name="a38" doxytag="dun.h::dun_init_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="dun_8h.html#a38">dun_init_status</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Possible status codes for the init cfm message. <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="a38a12" doxytag="dun_init_success" ></a>dun_init_success</em> </td><td>Successful initialisation. </td></tr><tr><td valign=top><em><a class="anchor" name="a38a13" doxytag="dun_init_rfc_chan_fail" ></a>dun_init_rfc_chan_fail</em> </td><td>Unsuccessful due to an RFCOMM channel failure. </td></tr><tr><td valign=top><em><a class="anchor" name="a38a14" doxytag="dun_init_sdp_reg_fail" ></a>dun_init_sdp_reg_fail</em> </td><td>Unsuccessful due to a service record registration failure. </td></tr><tr><td valign=top><em><a class="anchor" name="a38a15" doxytag="dun_init_fail" ></a>dun_init_fail</em> </td><td>Unsuccessful for some other reason. </td></tr></table></dl> </td> </tr></table><a class="anchor" name="a39" doxytag="dun.h::dun_connect_status" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -