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>OsclDNS 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> <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> 9<hr><h1>OsclDNS Class Reference<br> 10<small> 11[<a class="el" href="group__osclio.html">OSCL IO</a>]</small> 12</h1><code>#include <<a class="el" href="oscl__dns_8h-source.html">oscl_dns.h</a>></code> 13<p> 14<p>Inheritance diagram for OsclDNS: 15<p><center><img src="classOsclDNS.png" usemap="#OsclDNS_map" border="0" alt=""></center> 16<map name="OsclDNS_map"> 17<area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="0,56,103,80"> 18<area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="0,0,103,24"> 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>OSCL_IMPORT_REF </td><td valign=bottom><a class="el" href="classOsclDNS.html#a0">~OsclDNS</a> ()</td></tr> 24<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a25">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> 25<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> 26<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> 27<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> 28<tr><td colspan=2><br><h2>Friends</h2></td></tr> 29<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclDNS.html#l0">OsclDNSRequestAO</a></td></tr> 30</table> 31<hr><a name="_details"></a><h2>Detailed Description</h2> 32The DNS class 33<p> 34<hr><h2>Constructor & Destructor Documentation</h2> 35<a name="a0" doxytag="OsclDNS::~OsclDNS"></a><p> 36<table width="100%" cellpadding="2" cellspacing="0" border="0"> 37 <tr> 38 <td class="md"> 39 <table cellpadding="0" cellspacing="0" border="0"> 40 <tr> 41 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OsclDNS::~OsclDNS </td> 42 <td class="md" valign="top">( </td> 43 <td class="mdname1" valign="top" nowrap> </td> 44 <td class="md" valign="top">) </td> 45 <td class="md" nowrap></td> 46 </tr> 47 48 </table> 49 </td> 50 </tr> 51</table> 52<table cellspacing=5 cellpadding=0 border=0> 53 <tr> 54 <td> 55 56 </td> 57 <td> 58 59<p> 60Destructor. 61<p> 62Note: the application must de-allocate the DNS object using the same allocator that was passed in the NewL object creation call. </td> 63 </tr> 64</table> 65<hr><h2>Member Function Documentation</h2> 66<a name="a2" doxytag="OsclDNS::CancelGetHostByName"></a><p> 67<table width="100%" cellpadding="2" cellspacing="0" border="0"> 68 <tr> 69 <td class="md"> 70 <table cellpadding="0" cellspacing="0" border="0"> 71 <tr> 72 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclDNS::CancelGetHostByName </td> 73 <td class="md" valign="top">( </td> 74 <td class="mdname1" valign="top" nowrap> </td> 75 <td class="md" valign="top">) </td> 76 <td class="md" nowrap></td> 77 </tr> 78 79 </table> 80 </td> 81 </tr> 82</table> 83<table cellspacing=5 cellpadding=0 border=0> 84 <tr> 85 <td> 86 87 </td> 88 <td> 89 90<p> 91Cancel GetHostByName 92<p> 93This 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> 94 </tr> 95</table> 96<a name="a1" doxytag="OsclDNS::GetHostByName"></a><p> 97<table width="100%" cellpadding="2" cellspacing="0" border="0"> 98 <tr> 99 <td class="md"> 100 <table cellpadding="0" cellspacing="0" border="0"> 101 <tr> 102 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="group__osclio.html#a25">TPVDNSEvent</a> OsclDNS::GetHostByName </td> 103 <td class="md" valign="top">( </td> 104 <td class="md" nowrap valign="top">char * </td> 105 <td class="mdname" nowrap> <em>name</em>, </td> 106 </tr> 107 <tr> 108 <td></td> 109 <td></td> 110 <td class="md" nowrap><a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> & </td> 111 <td class="mdname" nowrap> <em>addr</em>, </td> 112 </tr> 113 <tr> 114 <td></td> 115 <td></td> 116 <td class="md" nowrap>int32 </td> 117 <td class="mdname" nowrap> <em>aTimeoutMsec</em> = -1</td> 118 </tr> 119 <tr> 120 <td></td> 121 <td class="md">) </td> 122 <td class="md" colspan="2"></td> 123 </tr> 124 125 </table> 126 </td> 127 </tr> 128</table> 129<table cellspacing=5 cellpadding=0 border=0> 130 <tr> 131 <td> 132 133 </td> 134 <td> 135 136<p> 137GetHostByName. This is an asynchronous method.<dl compact><dt><b>Parameters: </b></dt><dd> 138<table border=0 cellspacing=2 cellpadding=0> 139<tr><td valign=top><em>name:</em> </td><td> 140Null-terminated string containing the host name. </td></tr> 141<tr><td valign=top><em>addr:</em> </td><td> 142The output address. The ipAddr field will contain the network address of the host in dotted decimal notation. </td></tr> 143<tr><td valign=top><em>aTimeoutMsec:</em> </td><td> 144A timeout for the request in milliseconds, or (-1) to indicate infinite wait. @returns: EPVDNSPending for success, EPVDNSFailure for failure. </td></tr> 145</table> 146</dl> </td> 147 </tr> 148</table> 149<a name="d0" doxytag="OsclDNS::NewL"></a><p> 150<table width="100%" cellpadding="2" cellspacing="0" border="0"> 151 <tr> 152 <td class="md"> 153 <table cellpadding="0" cellspacing="0" border="0"> 154 <tr> 155 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OsclDNS* OsclDNS::NewL </td> 156 <td class="md" valign="top">( </td> 157 <td class="md" nowrap valign="top"><a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> & </td> 158 <td class="mdname" nowrap> <em>alloc</em>, </td> 159 </tr> 160 <tr> 161 <td></td> 162 <td></td> 163 <td class="md" nowrap><a class="el" href="classOsclSocketServ.html">OsclSocketServ</a> & </td> 164 <td class="mdname" nowrap> <em>aServ</em>, </td> 165 </tr> 166 <tr> 167 <td></td> 168 <td></td> 169 <td class="md" nowrap><a class="el" href="classOsclDNSObserver.html">OsclDNSObserver</a> & </td> 170 <td class="mdname" nowrap> <em>aObserver</em>, </td> 171 </tr> 172 <tr> 173 <td></td> 174 <td></td> 175 <td class="md" nowrap>uint32 </td> 176 <td class="mdname" nowrap> <em>aId</em></td> 177 </tr> 178 <tr> 179 <td></td> 180 <td class="md">) </td> 181 <td class="md" colspan="2"><code> [static]</code></td> 182 </tr> 183 184 </table> 185 </td> 186 </tr> 187</table> 188<table cellspacing=5 cellpadding=0 border=0> 189 <tr> 190 <td> 191 192 </td> 193 <td> 194 195<p> 196DNS object creation.<dl compact><dt><b>Parameters: </b></dt><dd> 197<table border=0 cellspacing=2 cellpadding=0> 198<tr><td valign=top><em>alloc:</em> </td><td> 199Memory allocator </td></tr> 200<tr><td valign=top><em>aServ:</em> </td><td> 201Socket server. </td></tr> 202<tr><td valign=top><em>aObserver:</em> </td><td> 203DNS Event observer </td></tr> 204<tr><td valign=top><em>aId:</em> </td><td> 205Unique ID for this DNS object. This ID will be included in all callbacks associated with this DNS object. </td></tr> 206</table> 207</dl> </td> 208 </tr> 209</table> 210<hr><h2>Friends And Related Function Documentation</h2> 211<a name="l0" doxytag="OsclDNS::OsclDNSRequestAO"></a><p> 212<table width="100%" cellpadding="2" cellspacing="0" border="0"> 213 <tr> 214 <td class="md"> 215 <table cellpadding="0" cellspacing="0" border="0"> 216 <tr> 217 <td class="md" nowrap valign="top"> friend class OsclDNSRequestAO<code> [friend]</code> 218 </table> 219 </td> 220 </tr> 221</table> 222<table cellspacing=5 cellpadding=0 border=0> 223 <tr> 224 <td> 225 226 </td> 227 <td> 228 229<p> 230 </td> 231 </tr> 232</table> 233<hr>The documentation for this class was generated from the following file:<ul> 234<li><a class="el" href="oscl__dns_8h-source.html">oscl_dns.h</a></ul> 235<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small> 236<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 237</small></address> 238</body> 239</html> 240
