| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
| <title>OsclDNS class Reference</title> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"> |
| </head><body> |
| <!-- Generated by Doxygen 1.2.18 --> |
| <center> |
| <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</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> </center> |
| <hr><h1>OsclDNS Class Reference<br> |
| <small> |
| [<a class="el" href="group__osclio.html">OSCL IO</a>]</small> |
| </h1><code>#include <<a class="el" href="oscl__dns_8h-source.html">oscl_dns.h</a>></code> |
| <p> |
| <p>Inheritance diagram for OsclDNS: |
| <p><center><img src="classOsclDNS.png" usemap="#OsclDNS_map" border="0" alt=""></center> |
| <map name="OsclDNS_map"> |
| <area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="0,56,103,80"> |
| <area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="0,0,103,24"> |
| </map> |
| <table border=0 cellpadding=0 cellspacing=0> |
| <tr><td></td></tr> |
| <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> |
| <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF </td><td valign=bottom><a class="el" href="classOsclDNS.html#a0">~OsclDNS</a> ()</td></tr> |
| <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a24">TPVDNSEvent</a> </td><td valign=bottom><a class="el" href="classOsclDNS.html#a1">GetHostByName</a> (char *name, <a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &addr, int32 aTimeoutMsec=-1)</td></tr> |
| <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclDNS.html#a2">CancelGetHostByName</a> ()</td></tr> |
| <tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> |
| <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF OsclDNS * </td><td valign=bottom><a class="el" href="classOsclDNS.html#d0">NewL</a> (<a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> &alloc, <a class="el" href="classOsclSocketServ.html">OsclSocketServ</a> &aServ, <a class="el" href="classOsclDNSObserver.html">OsclDNSObserver</a> &aObserver, uint32 aId)</td></tr> |
| <tr><td colspan=2><br><h2>Friends</h2></td></tr> |
| <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclDNS.html#l0">OsclDNSRequestAO</a></td></tr> |
| </table> |
| <hr><a name="_details"></a><h2>Detailed Description</h2> |
| The DNS class |
| <p> |
| <hr><h2>Constructor & Destructor Documentation</h2> |
| <a name="a0" doxytag="OsclDNS::~OsclDNS"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OsclDNS::~OsclDNS </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top">) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Destructor. |
| <p> |
| Note: the application must de-allocate the DNS object using the same allocator that was passed in the NewL object creation call. </td> |
| </tr> |
| </table> |
| <hr><h2>Member Function Documentation</h2> |
| <a name="a2" doxytag="OsclDNS::CancelGetHostByName"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclDNS::CancelGetHostByName </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top">) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Cancel GetHostByName |
| <p> |
| This method will cancel any pending GetHostByName operation on the current object, causing the GetHostByName to complete with error EPVDNSCancel. If there is no pending GetHostByName operation, this method will have no effect. </td> |
| </tr> |
| </table> |
| <a name="a1" doxytag="OsclDNS::GetHostByName"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a24">TPVDNSEvent</a> OsclDNS::GetHostByName </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">char * </td> |
| <td class="mdname" nowrap> <em>name</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap><a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> & </td> |
| <td class="mdname" nowrap> <em>addr</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>int32 </td> |
| <td class="mdname" nowrap> <em>aTimeoutMsec</em> = -1</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> |
| GetHostByName. This is an asynchronous method.<dl compact><dt><b>Parameters: </b></dt><dd> |
| <table border=0 cellspacing=2 cellpadding=0> |
| <tr><td valign=top><em>name:</em> </td><td> |
| Null-terminated string containing the host name. </td></tr> |
| <tr><td valign=top><em>addr:</em> </td><td> |
| The output address. The ipAddr field will contain the network address of the host in dotted decimal notation. </td></tr> |
| <tr><td valign=top><em>aTimeoutMsec:</em> </td><td> |
| A timeout for the request in milliseconds, or (-1) to indicate infinite wait. @returns: EPVDNSPending for success, EPVDNSFailure for failure. </td></tr> |
| </table> |
| </dl> </td> |
| </tr> |
| </table> |
| <a name="d0" doxytag="OsclDNS::NewL"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OsclDNS* OsclDNS::NewL </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top"><a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> & </td> |
| <td class="mdname" nowrap> <em>alloc</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap><a class="el" href="classOsclSocketServ.html">OsclSocketServ</a> & </td> |
| <td class="mdname" nowrap> <em>aServ</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap><a class="el" href="classOsclDNSObserver.html">OsclDNSObserver</a> & </td> |
| <td class="mdname" nowrap> <em>aObserver</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>uint32 </td> |
| <td class="mdname" nowrap> <em>aId</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"><code> [static]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| DNS object creation.<dl compact><dt><b>Parameters: </b></dt><dd> |
| <table border=0 cellspacing=2 cellpadding=0> |
| <tr><td valign=top><em>alloc:</em> </td><td> |
| Memory allocator </td></tr> |
| <tr><td valign=top><em>aServ:</em> </td><td> |
| Socket server. </td></tr> |
| <tr><td valign=top><em>aObserver:</em> </td><td> |
| DNS Event observer </td></tr> |
| <tr><td valign=top><em>aId:</em> </td><td> |
| Unique ID for this DNS object. This ID will be included in all callbacks associated with this DNS object. </td></tr> |
| </table> |
| </dl> </td> |
| </tr> |
| </table> |
| <hr><h2>Friends And Related Function Documentation</h2> |
| <a name="l0" doxytag="OsclDNS::OsclDNSRequestAO"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> friend class OsclDNSRequestAO<code> [friend]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| </td> |
| </tr> |
| </table> |
| <hr>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="oscl__dns_8h-source.html">oscl_dns.h</a></ul> |
| <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small> |
| <address style="align: left;"><small>Posting Version: OPENCORE_20090120 </small> |
| </small></address> |
| </body> |
| </html> |
