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>OsclSocketServ 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>OsclSocketServ 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__socket_8h-source.html">oscl_socket.h</a>></code> 13<p> 14<p>Inheritance diagram for OsclSocketServ: 15<p><center><img src="classOsclSocketServ.png" usemap="#OsclSocketServ_map" border="0" alt=""></center> 16<map name="OsclSocketServ_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="classOsclSocketServ.html#a0">~OsclSocketServ</a> ()</td></tr> 24<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF int32 </td><td valign=bottom><a class="el" href="classOsclSocketServ.html#a1">Connect</a> (uint32 aMessageSlots=8)</td></tr> 25<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclSocketServ.html#a2">Close</a> (bool aCleanup=true)</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 OsclSocketServ * </td><td valign=bottom><a class="el" href="classOsclSocketServ.html#d0">NewL</a> (<a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> &alloc)</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="classOsclSocketServ.html#l0">OsclTCPSocket</a></td></tr> 30<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclSocketServ.html#l1">OsclUDPSocket</a></td></tr> 31<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclSocketServ.html#l2">OsclDNS</a></td></tr> 32</table> 33<hr><h2>Constructor & Destructor Documentation</h2> 34<a name="a0" doxytag="OsclSocketServ::~OsclSocketServ"></a><p> 35<table width="100%" cellpadding="2" cellspacing="0" border="0"> 36 <tr> 37 <td class="md"> 38 <table cellpadding="0" cellspacing="0" border="0"> 39 <tr> 40 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OsclSocketServ::~OsclSocketServ </td> 41 <td class="md" valign="top">( </td> 42 <td class="mdname1" valign="top" nowrap> </td> 43 <td class="md" valign="top">) </td> 44 <td class="md" nowrap></td> 45 </tr> 46 47 </table> 48 </td> 49 </tr> 50</table> 51<table cellspacing=5 cellpadding=0 border=0> 52 <tr> 53 <td> 54 55 </td> 56 <td> 57 58<p> 59Destructor. The server object must be deleted using the same allocator used in the NewL call. </td> 60 </tr> 61</table> 62<hr><h2>Member Function Documentation</h2> 63<a name="a2" doxytag="OsclSocketServ::Close"></a><p> 64<table width="100%" cellpadding="2" cellspacing="0" border="0"> 65 <tr> 66 <td class="md"> 67 <table cellpadding="0" cellspacing="0" border="0"> 68 <tr> 69 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclSocketServ::Close </td> 70 <td class="md" valign="top">( </td> 71 <td class="md" nowrap valign="top">bool </td> 72 <td class="mdname1" valign="top" nowrap> <em>aCleanup</em> = true </td> 73 <td class="md" valign="top">) </td> 74 <td class="md" nowrap></td> 75 </tr> 76 77 </table> 78 </td> 79 </tr> 80</table> 81<table cellspacing=5 cellpadding=0 border=0> 82 <tr> 83 <td> 84 85 </td> 86 <td> 87 88<p> 89Close socket server. This is a synchronous method. <dl compact><dt><b>Parameters: </b></dt><dd> 90<table border=0 cellspacing=2 cellpadding=0> 91<tr><td valign=top><em>aCleanup:</em> </td><td> 92cleanup the socket system? the socket cleanup should only be done when all parts of the application are done using sockets. </td></tr> 93</table> 94</dl> </td> 95 </tr> 96</table> 97<a name="a1" doxytag="OsclSocketServ::Connect"></a><p> 98<table width="100%" cellpadding="2" cellspacing="0" border="0"> 99 <tr> 100 <td class="md"> 101 <table cellpadding="0" cellspacing="0" border="0"> 102 <tr> 103 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF int32 OsclSocketServ::Connect </td> 104 <td class="md" valign="top">( </td> 105 <td class="md" nowrap valign="top">uint32 </td> 106 <td class="mdname1" valign="top" nowrap> <em>aMessageSlots</em> = 8 </td> 107 <td class="md" valign="top">) </td> 108 <td class="md" nowrap></td> 109 </tr> 110 111 </table> 112 </td> 113 </tr> 114</table> 115<table cellspacing=5 cellpadding=0 border=0> 116 <tr> 117 <td> 118 119 </td> 120 <td> 121 122<p> 123Connect to socket server. This is a synchronous method.<dl compact><dt><b>Parameters: </b></dt><dd> 124<table border=0 cellspacing=2 cellpadding=0> 125<tr><td valign=top><em>Number</em> </td><td> 126of message slots. </td></tr> 127</table> 128</dl><dl compact><dt><b>Returns: </b></dt><dd> 129Returns OsclErrNone for success, or a platform-specific code. </dl> </td> 130 </tr> 131</table> 132<a name="d0" doxytag="OsclSocketServ::NewL"></a><p> 133<table width="100%" cellpadding="2" cellspacing="0" border="0"> 134 <tr> 135 <td class="md"> 136 <table cellpadding="0" cellspacing="0" border="0"> 137 <tr> 138 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OsclSocketServ* OsclSocketServ::NewL </td> 139 <td class="md" valign="top">( </td> 140 <td class="md" nowrap valign="top"><a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> & </td> 141 <td class="mdname1" valign="top" nowrap> <em>alloc</em> </td> 142 <td class="md" valign="top">) </td> 143 <td class="md" nowrap><code> [static]</code></td> 144 </tr> 145 146 </table> 147 </td> 148 </tr> 149</table> 150<table cellspacing=5 cellpadding=0 border=0> 151 <tr> 152 <td> 153 154 </td> 155 <td> 156 157<p> 158Create a socket server. May leave if failure.<dl compact><dt><b>Parameters: </b></dt><dd> 159<table border=0 cellspacing=2 cellpadding=0> 160<tr><td valign=top><em>alloc:</em> </td><td> 161Memory allocator. </td></tr> 162</table> 163</dl><dl compact><dt><b>Returns: </b></dt><dd> 164Returns pointer to socket server </dl> </td> 165 </tr> 166</table> 167<hr><h2>Friends And Related Function Documentation</h2> 168<a name="l2" doxytag="OsclSocketServ::OsclDNS"></a><p> 169<table width="100%" cellpadding="2" cellspacing="0" border="0"> 170 <tr> 171 <td class="md"> 172 <table cellpadding="0" cellspacing="0" border="0"> 173 <tr> 174 <td class="md" nowrap valign="top"> friend class OsclDNS<code> [friend]</code> 175 </table> 176 </td> 177 </tr> 178</table> 179<table cellspacing=5 cellpadding=0 border=0> 180 <tr> 181 <td> 182 183 </td> 184 <td> 185 186<p> 187 </td> 188 </tr> 189</table> 190<a name="l0" doxytag="OsclSocketServ::OsclTCPSocket"></a><p> 191<table width="100%" cellpadding="2" cellspacing="0" border="0"> 192 <tr> 193 <td class="md"> 194 <table cellpadding="0" cellspacing="0" border="0"> 195 <tr> 196 <td class="md" nowrap valign="top"> friend class OsclTCPSocket<code> [friend]</code> 197 </table> 198 </td> 199 </tr> 200</table> 201<table cellspacing=5 cellpadding=0 border=0> 202 <tr> 203 <td> 204 205 </td> 206 <td> 207 208<p> 209 </td> 210 </tr> 211</table> 212<a name="l1" doxytag="OsclSocketServ::OsclUDPSocket"></a><p> 213<table width="100%" cellpadding="2" cellspacing="0" border="0"> 214 <tr> 215 <td class="md"> 216 <table cellpadding="0" cellspacing="0" border="0"> 217 <tr> 218 <td class="md" nowrap valign="top"> friend class OsclUDPSocket<code> [friend]</code> 219 </table> 220 </td> 221 </tr> 222</table> 223<table cellspacing=5 cellpadding=0 border=0> 224 <tr> 225 <td> 226 227 </td> 228 <td> 229 230<p> 231 </td> 232 </tr> 233</table> 234<hr>The documentation for this class was generated from the following file:<ul> 235<li><a class="el" href="oscl__socket_8h-source.html">oscl_socket.h</a></ul> 236<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small> 237<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 238</small></address> 239</body> 240</html> 241
