Home | History | Annotate | Download | only in oscl_html
      1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
      2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
      3 <title>OsclUDPSocketI class Reference</title>
      4 <link href="doxygen.css" rel="stylesheet" type="text/css">
      5 </head><body>
      6 <!-- Generated by Doxygen 1.2.18 -->
      7 <center>
      8 <a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
      9 <hr><h1>OsclUDPSocketI Class Reference</h1><code>#include &lt;<a class="el" href="oscl__udp__socket_8h-source.html">oscl_udp_socket.h</a>&gt;</code>
     10 <p>
     11 <p>Inheritance diagram for OsclUDPSocketI:
     12 <p><center><img src="classOsclUDPSocketI.png" usemap="#OsclUDPSocketI_map" border="0" alt=""></center>
     13 <map name="OsclUDPSocketI_map">
     14 <area href="classOsclIPSocketI.html" alt="OsclIPSocketI" shape="rect" coords="0,0,104,24">
     15 </map>
     16 <table border=0 cellpadding=0 cellspacing=0>
     17 <tr><td></td></tr>
     18 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
     19 <tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classOsclUDPSocketI.html#a0">~OsclUDPSocketI</a> ()</td></tr>
     20 <tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclUDPSocketI.html#a1">Close</a> ()</td></tr>
     21 <tr><td nowrap align=right valign=top>uint8 *&nbsp;</td><td valign=bottom><a class="el" href="classOsclUDPSocketI.html#a2">GetRecvData</a> (int32 *aLength)</td></tr>
     22 <tr><td nowrap align=right valign=top>uint8 *&nbsp;</td><td valign=bottom><a class="el" href="classOsclUDPSocketI.html#a3">GetSendData</a> (int32 *aLength)</td></tr>
     23 <tr><td nowrap align=right valign=top><a class="el" href="oscl__socket__types_8h.html#a20">TPVSocketEvent</a>&nbsp;</td><td valign=bottom><a class="el" href="classOsclUDPSocketI.html#a4">BindAsync</a> (<a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &amp;aAddress, int32 aTimeoutMsec=-1)</td></tr>
     24 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclUDPSocketI.html#a5">CancelBind</a> ()</td></tr>
     25 <tr><td nowrap align=right valign=top><a class="el" href="oscl__socket__types_8h.html#a20">TPVSocketEvent</a>&nbsp;</td><td valign=bottom><a class="el" href="classOsclUDPSocketI.html#a6">SendTo</a> (const uint8 *&amp;aPtr, uint32 aLen, <a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &amp;aAddress, int32 aTimeoutMsec=-1)</td></tr>
     26 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclUDPSocketI.html#a7">CancelSendTo</a> ()</td></tr>
     27 <tr><td nowrap align=right valign=top><a class="el" href="oscl__socket__types_8h.html#a20">TPVSocketEvent</a>&nbsp;</td><td valign=bottom><a class="el" href="classOsclUDPSocketI.html#a8">RecvFrom</a> (uint8 *&amp;aPtr, uint32 aMaxLen, <a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &amp;aAddress, int32 aTimeoutMsec=-1, uint32 aMultiMaxLen=0, <a class="el" href="classOscl__Vector.html">Oscl_Vector</a>&lt; uint32, <a class="el" href="classOsclMemAllocator.html">OsclMemAllocator</a> &gt; *aPacketLen=NULL, <a class="el" href="classOscl__Vector.html">Oscl_Vector</a>&lt; <a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a>, <a class="el" href="classOsclMemAllocator.html">OsclMemAllocator</a> &gt; *aPacketSource=NULL)</td></tr>
     28 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclUDPSocketI.html#a9">CancelRecvFrom</a> ()</td></tr>
     29 <tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
     30 <tr><td nowrap align=right valign=top>OsclUDPSocketI *&nbsp;</td><td valign=bottom><a class="el" href="classOsclUDPSocketI.html#d0">NewL</a> (<a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> &amp;a, <a class="el" href="classOsclSocketServI.html">OsclSocketServI</a> *aServ, <a class="el" href="classOsclSocketObserver.html">OsclSocketObserver</a> *aObserver, uint32 aId)</td></tr>
     31 </table>
     32 <hr><a name="_details"></a><h2>Detailed Description</h2>
     33 Internal implementation class for <a class="el" href="classOsclUDPSocket.html">OsclUDPSocket</a> 
     34 <p>
     35 <hr><h2>Constructor &amp; Destructor Documentation</h2>
     36 <a name="a0" doxytag="OsclUDPSocketI::~OsclUDPSocketI"></a><p>
     37 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     38   <tr>
     39     <td class="md">
     40       <table cellpadding="0" cellspacing="0" border="0">
     41         <tr>
     42           <td class="md" nowrap valign="top"> virtual OsclUDPSocketI::~OsclUDPSocketI </td>
     43           <td class="md" valign="top">(&nbsp;</td>
     44           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     45           <td class="md" valign="top">)&nbsp;</td>
     46           <td class="md" nowrap><code> [virtual]</code></td>
     47         </tr>
     48 
     49       </table>
     50     </td>
     51   </tr>
     52 </table>
     53 <table cellspacing=5 cellpadding=0 border=0>
     54   <tr>
     55     <td>
     56       &nbsp;
     57     </td>
     58     <td>
     59 
     60 <p>
     61     </td>
     62   </tr>
     63 </table>
     64 <hr><h2>Member Function Documentation</h2>
     65 <a name="a4" doxytag="OsclUDPSocketI::BindAsync"></a><p>
     66 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     67   <tr>
     68     <td class="md">
     69       <table cellpadding="0" cellspacing="0" border="0">
     70         <tr>
     71           <td class="md" nowrap valign="top"> <a class="el" href="oscl__socket__types_8h.html#a20">TPVSocketEvent</a> OsclUDPSocketI::BindAsync </td>
     72           <td class="md" valign="top">(&nbsp;</td>
     73           <td class="md" nowrap valign="top"><a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &amp;&nbsp;</td>
     74           <td class="mdname" nowrap>&nbsp; <em>aAddress</em>, </td>
     75         </tr>
     76         <tr>
     77           <td></td>
     78           <td></td>
     79           <td class="md" nowrap>int32&nbsp;</td>
     80           <td class="mdname" nowrap>&nbsp; <em>aTimeoutMsec</em> = -1</td>
     81         </tr>
     82         <tr>
     83           <td></td>
     84           <td class="md">)&nbsp;</td>
     85           <td class="md" colspan="2"><code> [inline]</code></td>
     86         </tr>
     87 
     88       </table>
     89     </td>
     90   </tr>
     91 </table>
     92 <table cellspacing=5 cellpadding=0 border=0>
     93   <tr>
     94     <td>
     95       &nbsp;
     96     </td>
     97     <td>
     98 
     99 <p>
    100     </td>
    101   </tr>
    102 </table>
    103 <a name="a5" doxytag="OsclUDPSocketI::CancelBind"></a><p>
    104 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    105   <tr>
    106     <td class="md">
    107       <table cellpadding="0" cellspacing="0" border="0">
    108         <tr>
    109           <td class="md" nowrap valign="top"> void OsclUDPSocketI::CancelBind </td>
    110           <td class="md" valign="top">(&nbsp;</td>
    111           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    112           <td class="md" valign="top">)&nbsp;</td>
    113           <td class="md" nowrap><code> [inline]</code></td>
    114         </tr>
    115 
    116       </table>
    117     </td>
    118   </tr>
    119 </table>
    120 <table cellspacing=5 cellpadding=0 border=0>
    121   <tr>
    122     <td>
    123       &nbsp;
    124     </td>
    125     <td>
    126 
    127 <p>
    128     </td>
    129   </tr>
    130 </table>
    131 <a name="a9" doxytag="OsclUDPSocketI::CancelRecvFrom"></a><p>
    132 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    133   <tr>
    134     <td class="md">
    135       <table cellpadding="0" cellspacing="0" border="0">
    136         <tr>
    137           <td class="md" nowrap valign="top"> void OsclUDPSocketI::CancelRecvFrom </td>
    138           <td class="md" valign="top">(&nbsp;</td>
    139           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    140           <td class="md" valign="top">)&nbsp;</td>
    141           <td class="md" nowrap><code> [inline]</code></td>
    142         </tr>
    143 
    144       </table>
    145     </td>
    146   </tr>
    147 </table>
    148 <table cellspacing=5 cellpadding=0 border=0>
    149   <tr>
    150     <td>
    151       &nbsp;
    152     </td>
    153     <td>
    154 
    155 <p>
    156     </td>
    157   </tr>
    158 </table>
    159 <a name="a7" doxytag="OsclUDPSocketI::CancelSendTo"></a><p>
    160 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    161   <tr>
    162     <td class="md">
    163       <table cellpadding="0" cellspacing="0" border="0">
    164         <tr>
    165           <td class="md" nowrap valign="top"> void OsclUDPSocketI::CancelSendTo </td>
    166           <td class="md" valign="top">(&nbsp;</td>
    167           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    168           <td class="md" valign="top">)&nbsp;</td>
    169           <td class="md" nowrap><code> [inline]</code></td>
    170         </tr>
    171 
    172       </table>
    173     </td>
    174   </tr>
    175 </table>
    176 <table cellspacing=5 cellpadding=0 border=0>
    177   <tr>
    178     <td>
    179       &nbsp;
    180     </td>
    181     <td>
    182 
    183 <p>
    184     </td>
    185   </tr>
    186 </table>
    187 <a name="a1" doxytag="OsclUDPSocketI::Close"></a><p>
    188 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    189   <tr>
    190     <td class="md">
    191       <table cellpadding="0" cellspacing="0" border="0">
    192         <tr>
    193           <td class="md" nowrap valign="top"> int32 OsclUDPSocketI::Close </td>
    194           <td class="md" valign="top">(&nbsp;</td>
    195           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    196           <td class="md" valign="top">)&nbsp;</td>
    197           <td class="md" nowrap><code> [virtual]</code></td>
    198         </tr>
    199 
    200       </table>
    201     </td>
    202   </tr>
    203 </table>
    204 <table cellspacing=5 cellpadding=0 border=0>
    205   <tr>
    206     <td>
    207       &nbsp;
    208     </td>
    209     <td>
    210 
    211 <p>
    212 
    213 <p>
    214 Implements <a class="el" href="classOsclIPSocketI.html#a3">OsclIPSocketI</a>.    </td>
    215   </tr>
    216 </table>
    217 <a name="a2" doxytag="OsclUDPSocketI::GetRecvData"></a><p>
    218 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    219   <tr>
    220     <td class="md">
    221       <table cellpadding="0" cellspacing="0" border="0">
    222         <tr>
    223           <td class="md" nowrap valign="top"> uint8 * OsclUDPSocketI::GetRecvData </td>
    224           <td class="md" valign="top">(&nbsp;</td>
    225           <td class="md" nowrap valign="top">int32 *&nbsp;</td>
    226           <td class="mdname1" valign="top" nowrap>&nbsp; <em>aLength</em>          </td>
    227           <td class="md" valign="top">)&nbsp;</td>
    228           <td class="md" nowrap><code> [inline, virtual]</code></td>
    229         </tr>
    230 
    231       </table>
    232     </td>
    233   </tr>
    234 </table>
    235 <table cellspacing=5 cellpadding=0 border=0>
    236   <tr>
    237     <td>
    238       &nbsp;
    239     </td>
    240     <td>
    241 
    242 <p>
    243 
    244 <p>
    245 Implements <a class="el" href="classOsclIPSocketI.html#a4">OsclIPSocketI</a>.    </td>
    246   </tr>
    247 </table>
    248 <a name="a3" doxytag="OsclUDPSocketI::GetSendData"></a><p>
    249 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    250   <tr>
    251     <td class="md">
    252       <table cellpadding="0" cellspacing="0" border="0">
    253         <tr>
    254           <td class="md" nowrap valign="top"> uint8 * OsclUDPSocketI::GetSendData </td>
    255           <td class="md" valign="top">(&nbsp;</td>
    256           <td class="md" nowrap valign="top">int32 *&nbsp;</td>
    257           <td class="mdname1" valign="top" nowrap>&nbsp; <em>aLength</em>          </td>
    258           <td class="md" valign="top">)&nbsp;</td>
    259           <td class="md" nowrap><code> [inline, virtual]</code></td>
    260         </tr>
    261 
    262       </table>
    263     </td>
    264   </tr>
    265 </table>
    266 <table cellspacing=5 cellpadding=0 border=0>
    267   <tr>
    268     <td>
    269       &nbsp;
    270     </td>
    271     <td>
    272 
    273 <p>
    274 
    275 <p>
    276 Implements <a class="el" href="classOsclIPSocketI.html#a5">OsclIPSocketI</a>.    </td>
    277   </tr>
    278 </table>
    279 <a name="d0" doxytag="OsclUDPSocketI::NewL"></a><p>
    280 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    281   <tr>
    282     <td class="md">
    283       <table cellpadding="0" cellspacing="0" border="0">
    284         <tr>
    285           <td class="md" nowrap valign="top"> OsclUDPSocketI* OsclUDPSocketI::NewL </td>
    286           <td class="md" valign="top">(&nbsp;</td>
    287           <td class="md" nowrap valign="top"><a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> &amp;&nbsp;</td>
    288           <td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
    289         </tr>
    290         <tr>
    291           <td></td>
    292           <td></td>
    293           <td class="md" nowrap><a class="el" href="classOsclSocketServI.html">OsclSocketServI</a> *&nbsp;</td>
    294           <td class="mdname" nowrap>&nbsp; <em>aServ</em>, </td>
    295         </tr>
    296         <tr>
    297           <td></td>
    298           <td></td>
    299           <td class="md" nowrap><a class="el" href="classOsclSocketObserver.html">OsclSocketObserver</a> *&nbsp;</td>
    300           <td class="mdname" nowrap>&nbsp; <em>aObserver</em>, </td>
    301         </tr>
    302         <tr>
    303           <td></td>
    304           <td></td>
    305           <td class="md" nowrap>uint32&nbsp;</td>
    306           <td class="mdname" nowrap>&nbsp; <em>aId</em></td>
    307         </tr>
    308         <tr>
    309           <td></td>
    310           <td class="md">)&nbsp;</td>
    311           <td class="md" colspan="2"><code> [static]</code></td>
    312         </tr>
    313 
    314       </table>
    315     </td>
    316   </tr>
    317 </table>
    318 <table cellspacing=5 cellpadding=0 border=0>
    319   <tr>
    320     <td>
    321       &nbsp;
    322     </td>
    323     <td>
    324 
    325 <p>
    326     </td>
    327   </tr>
    328 </table>
    329 <a name="a8" doxytag="OsclUDPSocketI::RecvFrom"></a><p>
    330 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    331   <tr>
    332     <td class="md">
    333       <table cellpadding="0" cellspacing="0" border="0">
    334         <tr>
    335           <td class="md" nowrap valign="top"> <a class="el" href="oscl__socket__types_8h.html#a20">TPVSocketEvent</a> OsclUDPSocketI::RecvFrom </td>
    336           <td class="md" valign="top">(&nbsp;</td>
    337           <td class="md" nowrap valign="top">uint8 *&amp;&nbsp;</td>
    338           <td class="mdname" nowrap>&nbsp; <em>aPtr</em>, </td>
    339         </tr>
    340         <tr>
    341           <td></td>
    342           <td></td>
    343           <td class="md" nowrap>uint32&nbsp;</td>
    344           <td class="mdname" nowrap>&nbsp; <em>aMaxLen</em>, </td>
    345         </tr>
    346         <tr>
    347           <td></td>
    348           <td></td>
    349           <td class="md" nowrap><a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &amp;&nbsp;</td>
    350           <td class="mdname" nowrap>&nbsp; <em>aAddress</em>, </td>
    351         </tr>
    352         <tr>
    353           <td></td>
    354           <td></td>
    355           <td class="md" nowrap>int32&nbsp;</td>
    356           <td class="mdname" nowrap>&nbsp; <em>aTimeoutMsec</em> = -1, </td>
    357         </tr>
    358         <tr>
    359           <td></td>
    360           <td></td>
    361           <td class="md" nowrap>uint32&nbsp;</td>
    362           <td class="mdname" nowrap>&nbsp; <em>aMultiMaxLen</em> = 0, </td>
    363         </tr>
    364         <tr>
    365           <td></td>
    366           <td></td>
    367           <td class="md" nowrap><a class="el" href="classOscl__Vector.html">Oscl_Vector</a>&lt; uint32, <a class="el" href="classOsclMemAllocator.html">OsclMemAllocator</a> &gt; *&nbsp;</td>
    368           <td class="mdname" nowrap>&nbsp; <em>aPacketLen</em> = NULL, </td>
    369         </tr>
    370         <tr>
    371           <td></td>
    372           <td></td>
    373           <td class="md" nowrap><a class="el" href="classOscl__Vector.html">Oscl_Vector</a>&lt; <a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a>, <a class="el" href="classOsclMemAllocator.html">OsclMemAllocator</a> &gt; *&nbsp;</td>
    374           <td class="mdname" nowrap>&nbsp; <em>aPacketSource</em> = NULL</td>
    375         </tr>
    376         <tr>
    377           <td></td>
    378           <td class="md">)&nbsp;</td>
    379           <td class="md" colspan="2"><code> [inline]</code></td>
    380         </tr>
    381 
    382       </table>
    383     </td>
    384   </tr>
    385 </table>
    386 <table cellspacing=5 cellpadding=0 border=0>
    387   <tr>
    388     <td>
    389       &nbsp;
    390     </td>
    391     <td>
    392 
    393 <p>
    394     </td>
    395   </tr>
    396 </table>
    397 <a name="a6" doxytag="OsclUDPSocketI::SendTo"></a><p>
    398 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    399   <tr>
    400     <td class="md">
    401       <table cellpadding="0" cellspacing="0" border="0">
    402         <tr>
    403           <td class="md" nowrap valign="top"> <a class="el" href="oscl__socket__types_8h.html#a20">TPVSocketEvent</a> OsclUDPSocketI::SendTo </td>
    404           <td class="md" valign="top">(&nbsp;</td>
    405           <td class="md" nowrap valign="top">const uint8 *&amp;&nbsp;</td>
    406           <td class="mdname" nowrap>&nbsp; <em>aPtr</em>, </td>
    407         </tr>
    408         <tr>
    409           <td></td>
    410           <td></td>
    411           <td class="md" nowrap>uint32&nbsp;</td>
    412           <td class="mdname" nowrap>&nbsp; <em>aLen</em>, </td>
    413         </tr>
    414         <tr>
    415           <td></td>
    416           <td></td>
    417           <td class="md" nowrap><a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &amp;&nbsp;</td>
    418           <td class="mdname" nowrap>&nbsp; <em>aAddress</em>, </td>
    419         </tr>
    420         <tr>
    421           <td></td>
    422           <td></td>
    423           <td class="md" nowrap>int32&nbsp;</td>
    424           <td class="mdname" nowrap>&nbsp; <em>aTimeoutMsec</em> = -1</td>
    425         </tr>
    426         <tr>
    427           <td></td>
    428           <td class="md">)&nbsp;</td>
    429           <td class="md" colspan="2"><code> [inline]</code></td>
    430         </tr>
    431 
    432       </table>
    433     </td>
    434   </tr>
    435 </table>
    436 <table cellspacing=5 cellpadding=0 border=0>
    437   <tr>
    438     <td>
    439       &nbsp;
    440     </td>
    441     <td>
    442 
    443 <p>
    444     </td>
    445   </tr>
    446 </table>
    447 <hr>The documentation for this class was generated from the following file:<ul>
    448 <li><a class="el" href="oscl__udp__socket_8h-source.html">oscl_udp_socket.h</a></ul>
    449 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
    450 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
    451 </small></address>
    452 </body>
    453 </html>
    454