blob: ba9c8b0ae0522dec70e85977151458724d44adda [file] [log] [blame]
<!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>OsclIPSocketI 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> &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>
<hr><h1>OsclIPSocketI Class Reference</h1><code>#include &lt;<a class="el" href="oscl__ip__socket_8h-source.html">oscl_ip_socket.h</a>&gt;</code>
<p>
<p>Inheritance diagram for OsclIPSocketI:
<p><center><img src="classOsclIPSocketI.png" usemap="#OsclIPSocketI_map" border="0" alt=""></center>
<map name="OsclIPSocketI_map">
<area href="classOsclTCPSocketI.html" alt="OsclTCPSocketI" shape="rect" coords="0,56,104,80">
<area href="classOsclUDPSocketI.html" alt="OsclUDPSocketI" shape="rect" coords="114,56,218,80">
</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>int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#a0">Bind</a> (<a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &amp;aAddress)</td></tr>
<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#a1">Join</a> (<a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &amp;aAddress)</td></tr>
<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#a2">SetRecvBufferSize</a> (uint32 size)</td></tr>
<tr><td nowrap align=right valign=top>virtual int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#a3">Close</a> ()=0</td></tr>
<tr><td nowrap align=right valign=top>virtual uint8 *&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#a4">GetRecvData</a> (int32 *aLength)=0</td></tr>
<tr><td nowrap align=right valign=top>virtual uint8 *&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#a5">GetSendData</a> (int32 *aLength)=0</td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#a6">~OsclIPSocketI</a> ()</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOsclSocketServI.html">OsclSocketServI</a> *&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#a7">SocketServ</a> ()</td></tr>
<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="classOsclIPSocketI.html#a8">Alloc</a> ()</td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#b0">OsclIPSocketI</a> (<a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> &amp;a)</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#b1">ConstructL</a> (<a class="el" href="classOsclSocketObserver.html">OsclSocketObserver</a> *aObs, <a class="el" href="classOsclSocketI.html">OsclSocketI</a> *aSock, <a class="el" href="classOsclSocketServI.html">OsclSocketServI</a> *aServ, uint32 aId)</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<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="classOsclIPSocketI.html#n0">iAlloc</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a>&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#n1">iAddress</a></td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#n2">iId</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOsclSocketObserver.html">OsclSocketObserver</a> *&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#n3">iObserver</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOsclSocketI.html">OsclSocketI</a> *&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#n4">iSocket</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOsclSocketServI.html">OsclSocketServI</a> *&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#n5">iSocketServ</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classPVLogger.html">PVLogger</a> *&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#n6">iLogger</a></td></tr>
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td nowrap align=right valign=top>class&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#l0">OsclSocketRequestAO</a></td></tr>
<tr><td nowrap align=right valign=top>class&nbsp;</td><td valign=bottom><a class="el" href="classOsclIPSocketI.html#l1">OsclSocketMethod</a></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a6" doxytag="OsclIPSocketI::~OsclIPSocketI"></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"> virtual OsclIPSocketI::~OsclIPSocketI </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="b0" doxytag="OsclIPSocketI::OsclIPSocketI"></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"> OsclIPSocketI::OsclIPSocketI </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>a</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a8" doxytag="OsclIPSocketI::Alloc"></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"> <a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a>&amp; OsclIPSocketI::Alloc </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a0" doxytag="OsclIPSocketI::Bind"></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"> int32 OsclIPSocketI::Bind </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>aAddress</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="OsclIPSocketI::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"> virtual int32 OsclIPSocketI::Close </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Implemented in <a class="el" href="classOsclTCPSocketI.html#a1">OsclTCPSocketI</a>, and <a class="el" href="classOsclUDPSocketI.html#a1">OsclUDPSocketI</a>. </td>
</tr>
</table>
<a name="b1" doxytag="OsclIPSocketI::ConstructL"></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"> void OsclIPSocketI::ConstructL </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classOsclSocketObserver.html">OsclSocketObserver</a> *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aObs</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classOsclSocketI.html">OsclSocketI</a> *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aSock</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classOsclSocketServI.html">OsclSocketServI</a> *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aServ</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>uint32&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aId</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a4" doxytag="OsclIPSocketI::GetRecvData"></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"> virtual uint8* OsclIPSocketI::GetRecvData </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int32 *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>aLength</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Implemented in <a class="el" href="classOsclTCPSocketI.html#a4">OsclTCPSocketI</a>, and <a class="el" href="classOsclUDPSocketI.html#a2">OsclUDPSocketI</a>. </td>
</tr>
</table>
<a name="a5" doxytag="OsclIPSocketI::GetSendData"></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"> virtual uint8* OsclIPSocketI::GetSendData </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int32 *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>aLength</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Implemented in <a class="el" href="classOsclTCPSocketI.html#a5">OsclTCPSocketI</a>, and <a class="el" href="classOsclUDPSocketI.html#a3">OsclUDPSocketI</a>. </td>
</tr>
</table>
<a name="a1" doxytag="OsclIPSocketI::Join"></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"> int32 OsclIPSocketI::Join </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>aAddress</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a2" doxytag="OsclIPSocketI::SetRecvBufferSize"></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"> int32 OsclIPSocketI::SetRecvBufferSize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">uint32&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>size</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a7" doxytag="OsclIPSocketI::SocketServ"></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"> <a class="el" href="classOsclSocketServI.html">OsclSocketServI</a>* OsclIPSocketI::SocketServ </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="l1" doxytag="OsclIPSocketI::OsclSocketMethod"></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 OsclSocketMethod<code> [friend]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="l0" doxytag="OsclIPSocketI::OsclSocketRequestAO"></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 OsclSocketRequestAO<code> [friend]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Field Documentation</h2>
<a name="n1" doxytag="OsclIPSocketI::iAddress"></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"> <a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> OsclIPSocketI::iAddress<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n0" doxytag="OsclIPSocketI::iAlloc"></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"> <a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a>&amp; OsclIPSocketI::iAlloc<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n2" doxytag="OsclIPSocketI::iId"></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"> uint32 OsclIPSocketI::iId<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n6" doxytag="OsclIPSocketI::iLogger"></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"> <a class="el" href="classPVLogger.html">PVLogger</a>* OsclIPSocketI::iLogger<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n3" doxytag="OsclIPSocketI::iObserver"></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"> <a class="el" href="classOsclSocketObserver.html">OsclSocketObserver</a>* OsclIPSocketI::iObserver<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n4" doxytag="OsclIPSocketI::iSocket"></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"> <a class="el" href="classOsclSocketI.html">OsclSocketI</a>* OsclIPSocketI::iSocket<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n5" doxytag="OsclIPSocketI::iSocketServ"></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"> <a class="el" href="classOsclSocketServI.html">OsclSocketServI</a>* OsclIPSocketI::iSocketServ<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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__ip__socket_8h-source.html">oscl_ip_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>