| <!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>OsclSocketServ 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>OsclSocketServ Class Reference<br> |
| <small> |
| [<a class="el" href="group__osclio.html">OSCL IO</a>]</small> |
| </h1><code>#include <<a class="el" href="oscl__socket_8h-source.html">oscl_socket.h</a>></code> |
| <p> |
| <p>Inheritance diagram for OsclSocketServ: |
| <p><center><img src="classOsclSocketServ.png" usemap="#OsclSocketServ_map" border="0" alt=""></center> |
| <map name="OsclSocketServ_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="classOsclSocketServ.html#a0">~OsclSocketServ</a> ()</td></tr> |
| <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> |
| <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> |
| <tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> |
| <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> |
| <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="classOsclSocketServ.html#l0">OsclTCPSocket</a></td></tr> |
| <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclSocketServ.html#l1">OsclUDPSocket</a></td></tr> |
| <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOsclSocketServ.html#l2">OsclDNS</a></td></tr> |
| </table> |
| <hr><h2>Constructor & Destructor Documentation</h2> |
| <a name="a0" doxytag="OsclSocketServ::~OsclSocketServ"></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 OsclSocketServ::~OsclSocketServ </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. The server object must be deleted using the same allocator used in the NewL call. </td> |
| </tr> |
| </table> |
| <hr><h2>Member Function Documentation</h2> |
| <a name="a2" doxytag="OsclSocketServ::Close"></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 OsclSocketServ::Close </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">bool </td> |
| <td class="mdname1" valign="top" nowrap> <em>aCleanup</em> = true </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> |
| Close socket server. This is a synchronous method. <dl compact><dt><b>Parameters: </b></dt><dd> |
| <table border=0 cellspacing=2 cellpadding=0> |
| <tr><td valign=top><em>aCleanup:</em> </td><td> |
| cleanup the socket system? the socket cleanup should only be done when all parts of the application are done using sockets. </td></tr> |
| </table> |
| </dl> </td> |
| </tr> |
| </table> |
| <a name="a1" doxytag="OsclSocketServ::Connect"></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 int32 OsclSocketServ::Connect </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">uint32 </td> |
| <td class="mdname1" valign="top" nowrap> <em>aMessageSlots</em> = 8 </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> |
| Connect to socket server. This is a synchronous method.<dl compact><dt><b>Parameters: </b></dt><dd> |
| <table border=0 cellspacing=2 cellpadding=0> |
| <tr><td valign=top><em>Number</em> </td><td> |
| of message slots. </td></tr> |
| </table> |
| </dl><dl compact><dt><b>Returns: </b></dt><dd> |
| Returns OsclErrNone for success, or a platform-specific code. </dl> </td> |
| </tr> |
| </table> |
| <a name="d0" doxytag="OsclSocketServ::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 OsclSocketServ* OsclSocketServ::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="mdname1" valign="top" nowrap> <em>alloc</em> </td> |
| <td class="md" valign="top">) </td> |
| <td class="md" nowrap><code> [static]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Create a socket server. May leave if failure.<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> |
| </table> |
| </dl><dl compact><dt><b>Returns: </b></dt><dd> |
| Returns pointer to socket server </dl> </td> |
| </tr> |
| </table> |
| <hr><h2>Friends And Related Function Documentation</h2> |
| <a name="l2" doxytag="OsclSocketServ::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"> friend class OsclDNS<code> [friend]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| </td> |
| </tr> |
| </table> |
| <a name="l0" doxytag="OsclSocketServ::OsclTCPSocket"></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 OsclTCPSocket<code> [friend]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| </td> |
| </tr> |
| </table> |
| <a name="l1" doxytag="OsclSocketServ::OsclUDPSocket"></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 OsclUDPSocket<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__socket_8h-source.html">oscl_socket.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_20090310 </small> |
| </small></address> |
| </body> |
| </html> |
