ti/runtime/netapi/docs/doxygen/html/group___external_callbacks.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\r
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">\r
   3 <title>NETAPI: External Callbacks provides by Module</title>\r
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">\r
   5 <link href="tabs.css" rel="stylesheet" type="text/css">\r
   6 </head><body>\r
   7 <table width=100%>\r
   8 <tr>\r
   9   <td bgcolor="black" width="1"><a href="http://www.ti.com"><img border=0 src="../../tilogo.gif"></a></td>\r
  10   <td bgcolor="red"><img src="../../titagline.gif"></td>\r
  11 </tr>\r
  12 </table>\r
  13 <!-- Generated by Doxygen 1.5.1-p1 -->\r
  14 <div class="tabs">\r
  15   <ul>\r
  16     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>\r
  17     <li><a href="modules.html"><span>Modules</span></a></li>\r
  18     <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>\r
  19     <li><a href="files.html"><span>Files</span></a></li>\r
  20   </ul></div>\r
  21 <h1>External Callbacks provides by Module<br>\r
  22 <small>\r
  23 [<a class="el" href="group__nwal__module.html">NWAL Module API</a>]</small>\r
  24 </h1><table border="0" cellpadding="0" cellspacing="0">\r
  25 <tr><td></td></tr>\r
  26 <tr><td colspan="2"><br><h2>NWAL Packet meta data information for outgoing packet</h2></td></tr>\r
  27 <tr><td colspan="2">NWAL Packet meta data information for outgoing packet<p>\r
  28 The parameters in this structure are used to provide additional details for the outgoing packet. In the case of NWAL updating the packet header structure content will be modified internally within NWAL to reflect correct offset of the packet headers <br><br></td></tr>\r
  29 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack</a> (<a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> appId, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, <a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> ret)</td></tr>\r
  30 \r
  31 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">nwal_CmdCallBack Callback function for non blocking configuration request  <a href="#ge4dcadda117ac3ccb8fc937665c0d683"></a><br></td></tr>\r
  32 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___external_callbacks.html#g202f54ea7a87c9c1059266d19ef988d5">nwal_rxPktCallBack</a> (uint32_t appCookie, uint16_t numPkts, <a class="el" href="structnwal_rx_pkt_info__t.html">nwalRxPktInfo_t</a> *pPktInfo, uint64_t timestamp, <a class="el" href="group__nwal___bool__t.html#g22f7bb9de5cfd60d26dfd51aef438962">nwal_Bool_t</a> *pFreePkt)</td></tr>\r
  33 \r
  34 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">nwal_rxPktCallBack Callback function for incoming packets from NWAL  <a href="#g202f54ea7a87c9c1059266d19ef988d5"></a><br></td></tr>\r
  35 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___external_callbacks.html#g7a490e5146f40d17de861888dcc3ed12">nwal_CmdPaStatsReply</a> (<a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> appId, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, paSysStats_t *stats)</td></tr>\r
  36 \r
  37 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">nwal_CmdPaStatsReply Callback function for statistics response  <a href="#g7a490e5146f40d17de861888dcc3ed12"></a><br></td></tr>\r
  38 </table>\r
  39 <hr><h2>Typedef Documentation</h2>\r
  40 <a class="anchor" name="ge4dcadda117ac3ccb8fc937665c0d683"></a><!-- doxytag: member="nwal.h::nwal_CmdCallBack" ref="ge4dcadda117ac3ccb8fc937665c0d683" args="(nwal_AppId appId, nwal_TransID_t transId, nwal_RetValue ret)" -->\r
  41 <div class="memitem">\r
  42 <div class="memproto">\r
  43       <table class="memname">\r
  44         <tr>\r
  45           <td class="memname">typedef void <a class="el" href="group___external_callbacks.html#ge4dcadda117ac3ccb8fc937665c0d683">nwal_CmdCallBack</a>(<a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> appId, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, <a class="el" href="group__nwal___ret_value.html#g637bd1a265e777278081b477f4175250">nwal_RetValue</a> ret)          </td>\r
  46         </tr>\r
  47       </table>\r
  48 </div>\r
  49 <div class="memdoc">\r
  50 \r
  51 <p>\r
  52 nwal_CmdCallBack Callback function for non blocking configuration request \r
  53 <p>\r
  54 The call back function need to be registered by application in the case of all asynchronous configuration command request to NetCP. Call back is initiated after results for configuration request is available from NetCP module. \r
  55 </div>\r
  56 </div><p>\r
  57 <a class="anchor" name="g7a490e5146f40d17de861888dcc3ed12"></a><!-- doxytag: member="nwal.h::nwal_CmdPaStatsReply" ref="g7a490e5146f40d17de861888dcc3ed12" args="(nwal_AppId appId, nwal_TransID_t transId, paSysStats_t *stats)" -->\r
  58 <div class="memitem">\r
  59 <div class="memproto">\r
  60       <table class="memname">\r
  61         <tr>\r
  62           <td class="memname">typedef void <a class="el" href="group___external_callbacks.html#g7a490e5146f40d17de861888dcc3ed12">nwal_CmdPaStatsReply</a>(<a class="el" href="nwal_8h.html#750f9d1913f0f88bb78b3a2c63889b61">nwal_AppId</a> appId, <a class="el" href="nwal_8h.html#27c4142f7d360e967a0ffdf941d93097">nwal_TransID_t</a> transId, paSysStats_t *stats)          </td>\r
  63         </tr>\r
  64       </table>\r
  65 </div>\r
  66 <div class="memdoc">\r
  67 \r
  68 <p>\r
  69 nwal_CmdPaStatsReply Callback function for statistics response \r
  70 <p>\r
  71 The call back function will be called in the case of all asynchronous stats command request to NetCP. NWAL will call call back to provide the result for configuration request to application. \r
  72 </div>\r
  73 </div><p>\r
  74 <a class="anchor" name="g202f54ea7a87c9c1059266d19ef988d5"></a><!-- doxytag: member="nwal.h::nwal_rxPktCallBack" ref="g202f54ea7a87c9c1059266d19ef988d5" args="(uint32_t appCookie, uint16_t numPkts, nwalRxPktInfo_t *pPktInfo, uint64_t timestamp, nwal_Bool_t *pFreePkt)" -->\r
  75 <div class="memitem">\r
  76 <div class="memproto">\r
  77       <table class="memname">\r
  78         <tr>\r
  79           <td class="memname">typedef void <a class="el" href="group___external_callbacks.html#g202f54ea7a87c9c1059266d19ef988d5">nwal_rxPktCallBack</a>(uint32_t appCookie, uint16_t numPkts, <a class="el" href="structnwal_rx_pkt_info__t.html">nwalRxPktInfo_t</a> *pPktInfo, uint64_t timestamp, <a class="el" href="group__nwal___bool__t.html#g22f7bb9de5cfd60d26dfd51aef438962">nwal_Bool_t</a> *pFreePkt)          </td>\r
  80         </tr>\r
  81       </table>\r
  82 </div>\r
  83 <div class="memdoc">\r
  84 \r
  85 <p>\r
  86 nwal_rxPktCallBack Callback function for incoming packets from NWAL \r
  87 <p>\r
  88 The call back function need to be registered by application <dl compact><dt><b>Parameters:</b></dt><dd>\r
  89   <table border="0" cellspacing="2" cellpadding="0">\r
  90     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>appCookie</em>&nbsp;</td><td>Application cookie passed per poll API call. </td></tr>\r
  91     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>numPkts</em>&nbsp;</td><td>Number of Packets. Max Value NWAL_MAX_RX_PKT_THRESHOLD </td></tr>\r
  92     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>pPktInfo</em>&nbsp;</td><td>Array of packets with meta information </td></tr>\r
  93     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>timestamp</em>&nbsp;</td><td>Timestamp for incoming packet when callback is initiated </td></tr>\r
  94     <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>pFreePkt</em>&nbsp;</td><td>Array per packet. To be set by application to indicate if packet needs to be freed by NWAL after callback returns. Set to nwal_TRUE if packet needs to be freed by NWAL </td></tr>\r
  95   </table>\r
  96 </dl>\r
  97 \r
  98 </div>\r
  99 </div><p>\r
 100 <hr size="1"><small>\r
 101 Copyright  2012, Texas Instruments Incorporated</small>\r
 102 </body>\r
 103 </html>\r