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>OsclDNSMethod 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>OsclDNSMethod Class Reference</h1><code>#include &lt;<a class="el" href="oscl__dns__method_8h-source.html">oscl_dns_method.h</a>&gt;</code>
     10 <p>
     11 <p>Inheritance diagram for OsclDNSMethod:
     12 <p><center><img src="classOsclDNSMethod.png" usemap="#OsclDNSMethod_map" border="0" alt=""></center>
     13 <map name="OsclDNSMethod_map">
     14 <area href="classOsclTimerObject.html" alt="OsclTimerObject" shape="rect" coords="90,112,261,136">
     15 <area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="0,56,171,80">
     16 <area href="classPVActiveBase.html" alt="PVActiveBase" shape="rect" coords="181,56,352,80">
     17 <area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="0,0,171,24">
     18 <area href="classOsclGetHostByNameMethod.html" alt="OsclGetHostByNameMethod" shape="rect" coords="90,224,261,248">
     19 </map>
     20 <table border=0 cellpadding=0 cellspacing=0>
     21 <tr><td></td></tr>
     22 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
     23 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#a0">OsclDNSMethod</a> (<a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> &amp;a, const char *name, <a class="el" href="group__osclio.html#a24">TPVDNSFxn</a> fxn)</td></tr>
     24 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#a1">Abort</a> ()</td></tr>
     25 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#a2">AbortAll</a> ()</td></tr>
     26 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#a3">CancelMethod</a> ()</td></tr>
     27 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#a4">Run</a> ()</td></tr>
     28 <tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
     29 <tr><td nowrap align=right valign=top><a class="el" href="classOsclDNSObserver.html">OsclDNSObserver</a> *&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#m0">iDNSObserver</a></td></tr>
     30 <tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#m1">iId</a></td></tr>
     31 <tr><td nowrap align=right valign=top><a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> &amp;&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#m2">iAlloc</a></td></tr>
     32 <tr><td nowrap align=right valign=top><a class="el" href="group__osclio.html#a24">TPVDNSFxn</a>&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#m3">iDNSFxn</a></td></tr>
     33 <tr><td nowrap align=right valign=top><a class="el" href="classPVLogger.html">PVLogger</a> *&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#m4">iLogger</a></td></tr>
     34 <tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
     35 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#b0">ConstructL</a> (<a class="el" href="classOsclDNSObserver.html">OsclDNSObserver</a> *aObserver, <a class="el" href="classOsclDNSRequestAO.html">OsclDNSRequestAO</a> *aAO, uint32 aId)</td></tr>
     36 <tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#b1">StartMethod</a> (int32 aTimeoutMsec)</td></tr>
     37 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#b2">MethodDone</a> ()</td></tr>
     38 <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
     39 <tr><td nowrap align=right valign=top><a class="el" href="classOsclDNSRequestAO.html">OsclDNSRequestAO</a> *&nbsp;</td><td valign=bottom><a class="el" href="classOsclDNSMethod.html#n0">iDNSRequestAO</a></td></tr>
     40 </table>
     41 <hr><a name="_details"></a><h2>Detailed Description</h2>
     42 This is the base class for all socket methods. It provides the timeout on socket requests. 
     43 <p>
     44 <hr><h2>Constructor &amp; Destructor Documentation</h2>
     45 <a name="a0" doxytag="OsclDNSMethod::OsclDNSMethod"></a><p>
     46 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     47   <tr>
     48     <td class="md">
     49       <table cellpadding="0" cellspacing="0" border="0">
     50         <tr>
     51           <td class="md" nowrap valign="top"> OsclDNSMethod::OsclDNSMethod </td>
     52           <td class="md" valign="top">(&nbsp;</td>
     53           <td class="md" nowrap valign="top"><a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> &amp;&nbsp;</td>
     54           <td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
     55         </tr>
     56         <tr>
     57           <td></td>
     58           <td></td>
     59           <td class="md" nowrap>const char *&nbsp;</td>
     60           <td class="mdname" nowrap>&nbsp; <em>name</em>, </td>
     61         </tr>
     62         <tr>
     63           <td></td>
     64           <td></td>
     65           <td class="md" nowrap><a class="el" href="group__osclio.html#a24">TPVDNSFxn</a>&nbsp;</td>
     66           <td class="mdname" nowrap>&nbsp; <em>fxn</em></td>
     67         </tr>
     68         <tr>
     69           <td></td>
     70           <td class="md">)&nbsp;</td>
     71           <td class="md" colspan="2"><code> [inline]</code></td>
     72         </tr>
     73 
     74       </table>
     75     </td>
     76   </tr>
     77 </table>
     78 <table cellspacing=5 cellpadding=0 border=0>
     79   <tr>
     80     <td>
     81       &nbsp;
     82     </td>
     83     <td>
     84 
     85 <p>
     86     </td>
     87   </tr>
     88 </table>
     89 <hr><h2>Member Function Documentation</h2>
     90 <a name="a1" doxytag="OsclDNSMethod::Abort"></a><p>
     91 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     92   <tr>
     93     <td class="md">
     94       <table cellpadding="0" cellspacing="0" border="0">
     95         <tr>
     96           <td class="md" nowrap valign="top"> void OsclDNSMethod::Abort </td>
     97           <td class="md" valign="top">(&nbsp;</td>
     98           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     99           <td class="md" valign="top">)&nbsp;</td>
    100           <td class="md" nowrap></td>
    101         </tr>
    102 
    103       </table>
    104     </td>
    105   </tr>
    106 </table>
    107 <table cellspacing=5 cellpadding=0 border=0>
    108   <tr>
    109     <td>
    110       &nbsp;
    111     </td>
    112     <td>
    113 
    114 <p>
    115     </td>
    116   </tr>
    117 </table>
    118 <a name="a2" doxytag="OsclDNSMethod::AbortAll"></a><p>
    119 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    120   <tr>
    121     <td class="md">
    122       <table cellpadding="0" cellspacing="0" border="0">
    123         <tr>
    124           <td class="md" nowrap valign="top"> void OsclDNSMethod::AbortAll </td>
    125           <td class="md" valign="top">(&nbsp;</td>
    126           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    127           <td class="md" valign="top">)&nbsp;</td>
    128           <td class="md" nowrap></td>
    129         </tr>
    130 
    131       </table>
    132     </td>
    133   </tr>
    134 </table>
    135 <table cellspacing=5 cellpadding=0 border=0>
    136   <tr>
    137     <td>
    138       &nbsp;
    139     </td>
    140     <td>
    141 
    142 <p>
    143     </td>
    144   </tr>
    145 </table>
    146 <a name="a3" doxytag="OsclDNSMethod::CancelMethod"></a><p>
    147 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    148   <tr>
    149     <td class="md">
    150       <table cellpadding="0" cellspacing="0" border="0">
    151         <tr>
    152           <td class="md" nowrap valign="top"> void OsclDNSMethod::CancelMethod </td>
    153           <td class="md" valign="top">(&nbsp;</td>
    154           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    155           <td class="md" valign="top">)&nbsp;</td>
    156           <td class="md" nowrap></td>
    157         </tr>
    158 
    159       </table>
    160     </td>
    161   </tr>
    162 </table>
    163 <table cellspacing=5 cellpadding=0 border=0>
    164   <tr>
    165     <td>
    166       &nbsp;
    167     </td>
    168     <td>
    169 
    170 <p>
    171     </td>
    172   </tr>
    173 </table>
    174 <a name="b0" doxytag="OsclDNSMethod::ConstructL"></a><p>
    175 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    176   <tr>
    177     <td class="md">
    178       <table cellpadding="0" cellspacing="0" border="0">
    179         <tr>
    180           <td class="md" nowrap valign="top"> void OsclDNSMethod::ConstructL </td>
    181           <td class="md" valign="top">(&nbsp;</td>
    182           <td class="md" nowrap valign="top"><a class="el" href="classOsclDNSObserver.html">OsclDNSObserver</a> *&nbsp;</td>
    183           <td class="mdname" nowrap>&nbsp; <em>aObserver</em>, </td>
    184         </tr>
    185         <tr>
    186           <td></td>
    187           <td></td>
    188           <td class="md" nowrap><a class="el" href="classOsclDNSRequestAO.html">OsclDNSRequestAO</a> *&nbsp;</td>
    189           <td class="mdname" nowrap>&nbsp; <em>aAO</em>, </td>
    190         </tr>
    191         <tr>
    192           <td></td>
    193           <td></td>
    194           <td class="md" nowrap>uint32&nbsp;</td>
    195           <td class="mdname" nowrap>&nbsp; <em>aId</em></td>
    196         </tr>
    197         <tr>
    198           <td></td>
    199           <td class="md">)&nbsp;</td>
    200           <td class="md" colspan="2"><code> [protected]</code></td>
    201         </tr>
    202 
    203       </table>
    204     </td>
    205   </tr>
    206 </table>
    207 <table cellspacing=5 cellpadding=0 border=0>
    208   <tr>
    209     <td>
    210       &nbsp;
    211     </td>
    212     <td>
    213 
    214 <p>
    215     </td>
    216   </tr>
    217 </table>
    218 <a name="b2" doxytag="OsclDNSMethod::MethodDone"></a><p>
    219 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    220   <tr>
    221     <td class="md">
    222       <table cellpadding="0" cellspacing="0" border="0">
    223         <tr>
    224           <td class="md" nowrap valign="top"> void OsclDNSMethod::MethodDone </td>
    225           <td class="md" valign="top">(&nbsp;</td>
    226           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    227           <td class="md" valign="top">)&nbsp;</td>
    228           <td class="md" nowrap><code> [protected]</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     </td>
    244   </tr>
    245 </table>
    246 <a name="a4" doxytag="OsclDNSMethod::Run"></a><p>
    247 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    248   <tr>
    249     <td class="md">
    250       <table cellpadding="0" cellspacing="0" border="0">
    251         <tr>
    252           <td class="md" nowrap valign="top"> void OsclDNSMethod::Run </td>
    253           <td class="md" valign="top">(&nbsp;</td>
    254           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    255           <td class="md" valign="top">)&nbsp;</td>
    256           <td class="md" nowrap><code> [virtual]</code></td>
    257         </tr>
    258 
    259       </table>
    260     </td>
    261   </tr>
    262 </table>
    263 <table cellspacing=5 cellpadding=0 border=0>
    264   <tr>
    265     <td>
    266       &nbsp;
    267     </td>
    268     <td>
    269 
    270 <p>
    271 Handles an active object's request completion event.
    272 <p>
    273 A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.
    274 <p>
    275 The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.
    276 <p>
    277 Before calling this active object's <a class="el" href="classOsclDNSMethod.html#a4">Run()</a> function, the active scheduler has:
    278 <p>
    279 1. decided that this is the highest priority active object with a completed request
    280 <p>
    281 2. marked this active object's request as complete (i.e. the request is no longer outstanding)
    282 <p>
    283 <a class="el" href="classOsclDNSMethod.html#a4">Run()</a> runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls ExecError() to handle the leave.
    284 <p>
    285 Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's <a class="el" href="classOsclDNSMethod.html#a4">Run()</a> or <a class="el" href="classOsclTimerObject.html#b1">RunError()</a> functions. 
    286 <p>
    287 Implements <a class="el" href="classPVActiveBase.html#a4">PVActiveBase</a>.    </td>
    288   </tr>
    289 </table>
    290 <a name="b1" doxytag="OsclDNSMethod::StartMethod"></a><p>
    291 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    292   <tr>
    293     <td class="md">
    294       <table cellpadding="0" cellspacing="0" border="0">
    295         <tr>
    296           <td class="md" nowrap valign="top"> bool OsclDNSMethod::StartMethod </td>
    297           <td class="md" valign="top">(&nbsp;</td>
    298           <td class="md" nowrap valign="top">int32&nbsp;</td>
    299           <td class="mdname1" valign="top" nowrap>&nbsp; <em>aTimeoutMsec</em>          </td>
    300           <td class="md" valign="top">)&nbsp;</td>
    301           <td class="md" nowrap><code> [protected]</code></td>
    302         </tr>
    303 
    304       </table>
    305     </td>
    306   </tr>
    307 </table>
    308 <table cellspacing=5 cellpadding=0 border=0>
    309   <tr>
    310     <td>
    311       &nbsp;
    312     </td>
    313     <td>
    314 
    315 <p>
    316     </td>
    317   </tr>
    318 </table>
    319 <hr><h2>Field Documentation</h2>
    320 <a name="m2" doxytag="OsclDNSMethod::iAlloc"></a><p>
    321 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    322   <tr>
    323     <td class="md">
    324       <table cellpadding="0" cellspacing="0" border="0">
    325         <tr>
    326           <td class="md" nowrap valign="top"> <a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a>&amp; OsclDNSMethod::iAlloc
    327       </table>
    328     </td>
    329   </tr>
    330 </table>
    331 <table cellspacing=5 cellpadding=0 border=0>
    332   <tr>
    333     <td>
    334       &nbsp;
    335     </td>
    336     <td>
    337 
    338 <p>
    339     </td>
    340   </tr>
    341 </table>
    342 <a name="m3" doxytag="OsclDNSMethod::iDNSFxn"></a><p>
    343 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    344   <tr>
    345     <td class="md">
    346       <table cellpadding="0" cellspacing="0" border="0">
    347         <tr>
    348           <td class="md" nowrap valign="top"> <a class="el" href="group__osclio.html#a24">TPVDNSFxn</a> OsclDNSMethod::iDNSFxn
    349       </table>
    350     </td>
    351   </tr>
    352 </table>
    353 <table cellspacing=5 cellpadding=0 border=0>
    354   <tr>
    355     <td>
    356       &nbsp;
    357     </td>
    358     <td>
    359 
    360 <p>
    361     </td>
    362   </tr>
    363 </table>
    364 <a name="m0" doxytag="OsclDNSMethod::iDNSObserver"></a><p>
    365 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    366   <tr>
    367     <td class="md">
    368       <table cellpadding="0" cellspacing="0" border="0">
    369         <tr>
    370           <td class="md" nowrap valign="top"> <a class="el" href="classOsclDNSObserver.html">OsclDNSObserver</a>* OsclDNSMethod::iDNSObserver
    371       </table>
    372     </td>
    373   </tr>
    374 </table>
    375 <table cellspacing=5 cellpadding=0 border=0>
    376   <tr>
    377     <td>
    378       &nbsp;
    379     </td>
    380     <td>
    381 
    382 <p>
    383     </td>
    384   </tr>
    385 </table>
    386 <a name="n0" doxytag="OsclDNSMethod::iDNSRequestAO"></a><p>
    387 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    388   <tr>
    389     <td class="md">
    390       <table cellpadding="0" cellspacing="0" border="0">
    391         <tr>
    392           <td class="md" nowrap valign="top"> <a class="el" href="classOsclDNSRequestAO.html">OsclDNSRequestAO</a>* OsclDNSMethod::iDNSRequestAO<code> [protected]</code>
    393       </table>
    394     </td>
    395   </tr>
    396 </table>
    397 <table cellspacing=5 cellpadding=0 border=0>
    398   <tr>
    399     <td>
    400       &nbsp;
    401     </td>
    402     <td>
    403 
    404 <p>
    405     </td>
    406   </tr>
    407 </table>
    408 <a name="m1" doxytag="OsclDNSMethod::iId"></a><p>
    409 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    410   <tr>
    411     <td class="md">
    412       <table cellpadding="0" cellspacing="0" border="0">
    413         <tr>
    414           <td class="md" nowrap valign="top"> uint32 OsclDNSMethod::iId
    415       </table>
    416     </td>
    417   </tr>
    418 </table>
    419 <table cellspacing=5 cellpadding=0 border=0>
    420   <tr>
    421     <td>
    422       &nbsp;
    423     </td>
    424     <td>
    425 
    426 <p>
    427     </td>
    428   </tr>
    429 </table>
    430 <a name="m4" doxytag="OsclDNSMethod::iLogger"></a><p>
    431 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    432   <tr>
    433     <td class="md">
    434       <table cellpadding="0" cellspacing="0" border="0">
    435         <tr>
    436           <td class="md" nowrap valign="top"> <a class="el" href="classPVLogger.html">PVLogger</a>* OsclDNSMethod::iLogger
    437       </table>
    438     </td>
    439   </tr>
    440 </table>
    441 <table cellspacing=5 cellpadding=0 border=0>
    442   <tr>
    443     <td>
    444       &nbsp;
    445     </td>
    446     <td>
    447 
    448 <p>
    449     </td>
    450   </tr>
    451 </table>
    452 <hr>The documentation for this class was generated from the following file:<ul>
    453 <li><a class="el" href="oscl__dns__method_8h-source.html">oscl_dns_method.h</a></ul>
    454 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
    455 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
    456 </small></address>
    457 </body>
    458 </html>
    459