blob: 37d982afe1ab9f2fec8e7a388496423f1edffab3 [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>oscl_socket_imp_base.h Source File</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>oscl_socket_imp_base.h</h1><a href="oscl__socket__imp__base_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001
00002
00003 <span class="preprocessor">#ifndef OSCL_SOCKET_IMP_BASE_H_INCLUDED</span>
00004 <span class="preprocessor"></span><span class="preprocessor">#define OSCL_SOCKET_IMP_BASE_H_INCLUDED</span>
00005 <span class="preprocessor"></span>
00006 <span class="preprocessor">#include "<a class="code" href="oscl__socket__types_8h.html">oscl_socket_types.h</a>"</span>
00007 <span class="preprocessor">#include "<a class="code" href="oscl__socket__request_8h.html">oscl_socket_request.h</a>"</span>
00008 <span class="preprocessor">#include "<a class="code" href="oscl__defalloc_8h.html">oscl_defalloc.h</a>"</span>
00009 <span class="preprocessor">#include "<a class="code" href="oscl__mutex_8h.html">oscl_mutex.h</a>"</span>
00010 <span class="preprocessor">#include "<a class="code" href="oscl__socket__stats_8h.html">oscl_socket_stats.h</a>"</span>
00011 <span class="preprocessor">#include "<a class="code" href="oscl__base_8h.html">oscl_base.h</a>"</span>
00012
00013 <span class="keyword">class </span><a class="code" href="classOsclSocketServI.html">OsclSocketServI</a>;
00014
<a name="l00017"></a><a class="code" href="classOsclSocketIBase.html">00017</a> <span class="keyword">class </span><a class="code" href="classOsclSocketIBase.html">OsclSocketIBase</a>
00018 {
00019 <span class="keyword">public</span>:
00020 <span class="keyword">virtual</span> <a class="code" href="classOsclSocketIBase.html#a0">~OsclSocketIBase</a>();
00021
00022 <span class="comment">//synchronous methods</span>
00023 <span class="keyword">virtual</span> int32 <a class="code" href="classOsclSocketIBase.html#a1">Open</a>(<a class="code" href="classOsclSocketServI.html">OsclSocketServI</a>&amp; aServer, uint32 addrFamily, uint32 sockType, uint32 protocol) = 0;
00024 <span class="keyword">virtual</span> int32 <a class="code" href="classOsclSocketIBase.html#a1">Open</a>(<a class="code" href="classOsclSocketServI.html">OsclSocketServI</a>&amp; aServer) = 0;
00025 <span class="keyword">virtual</span> int32 <a class="code" href="classOsclSocketIBase.html#a3">Bind</a>(<a class="code" href="classOsclNetworkAddress.html">OsclNetworkAddress</a>&amp; anAddr) = 0;
00026 <span class="keyword">virtual</span> int32 <a class="code" href="classOsclSocketIBase.html#a4">Join</a>(<a class="code" href="classOsclNetworkAddress.html">OsclNetworkAddress</a>&amp; anAddr) = 0;
00027 <span class="keyword">virtual</span> int32 <a class="code" href="classOsclSocketIBase.html#a5">Close</a>() = 0;
00028 <span class="keyword">virtual</span> int32 <a class="code" href="classOsclSocketIBase.html#a6">Listen</a>(uint32 qSize) = 0;
00029
00030 <span class="comment">//asynchronous methods.</span>
00031 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a7">Connect</a>(<a class="code" href="classConnectParam.html">ConnectParam</a>&amp; , <a class="code" href="classOsclSocketRequestAO.html">OsclSocketRequestAO</a>&amp;) = 0;
00032
00033 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a8">Accept</a>(<a class="code" href="classAcceptParam.html">AcceptParam</a> &amp;, <a class="code" href="classOsclSocketRequestAO.html">OsclSocketRequestAO</a>&amp;) = 0;
00034
00035 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a9">Shutdown</a>(<a class="code" href="classShutdownParam.html">ShutdownParam</a> &amp;, <a class="code" href="classOsclSocketRequestAO.html">OsclSocketRequestAO</a>&amp;) = 0;
00036
00037 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a10">Send</a>(<a class="code" href="classSendParam.html">SendParam</a> &amp;, <a class="code" href="classOsclSocketRequestAO.html">OsclSocketRequestAO</a>&amp;) = 0;
00038 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a11">SendSuccess</a>(<a class="code" href="classSendParam.html">SendParam</a> &amp;) = 0;
00039
00040 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a12">SendTo</a>(<a class="code" href="classSendToParam.html">SendToParam</a> &amp; , <a class="code" href="classOsclSocketRequestAO.html">OsclSocketRequestAO</a>&amp;) = 0;
00041 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a13">SendToSuccess</a>(<a class="code" href="classSendToParam.html">SendToParam</a> &amp;) = 0;
00042
00043 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a14">Recv</a>(<a class="code" href="classRecvParam.html">RecvParam</a> &amp;, <a class="code" href="classOsclSocketRequestAO.html">OsclSocketRequestAO</a>&amp;) = 0;
00044 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a15">RecvSuccess</a>(<a class="code" href="classRecvParam.html">RecvParam</a> &amp;) = 0;
00045
00046 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a16">RecvFrom</a>(<a class="code" href="classRecvFromParam.html">RecvFromParam</a> &amp;, <a class="code" href="classOsclSocketRequestAO.html">OsclSocketRequestAO</a>&amp;) = 0;
00047 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a17">RecvFromSuccess</a>(<a class="code" href="classRecvFromParam.html">RecvFromParam</a> &amp;) = 0;
00048
00049 <span class="comment">//optional async methods</span>
<a name="l00050"></a><a class="code" href="classOsclSocketIBase.html#a18">00050</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a18">BindAsync</a>(<a class="code" href="classBindParam.html">BindParam</a>&amp;, <a class="code" href="classOsclSocketRequestAO.html">OsclSocketRequestAO</a>&amp;)
00051 {}
<a name="l00052"></a><a class="code" href="classOsclSocketIBase.html#a19">00052</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a19">ListenAsync</a>(<a class="code" href="classListenParam.html">ListenParam</a>&amp;, <a class="code" href="classOsclSocketRequestAO.html">OsclSocketRequestAO</a>&amp;)
00053 {}
00054 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclSocketIBase.html#d0">HasAsyncBind</a>() ;
00055 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclSocketIBase.html#d1">HasAsyncListen</a>() ;
00056
00057 <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#a20">CancelFxn</a>(<a class="code" href="oscl__socket__types_8h.html#a19">TPVSocketFxn</a>);
00058
00059 <span class="keyword">protected</span>:
00060 <a class="code" href="classOsclSocketIBase.html#b0">OsclSocketIBase</a>(<a class="code" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> &amp;a);
00061
00062 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#b1">CancelConnect</a>() = 0;
00063 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#b2">CancelAccept</a>() = 0;
00064 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#b3">CancelShutdown</a>() = 0;
00065 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#b4">CancelSend</a>() = 0;
00066 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#b5">CancelSendTo</a>() = 0;
00067 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#b6">CancelRecv</a>() = 0;
00068 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#b7">CancelRecvFrom</a>() = 0;
00069
00070 <span class="comment">//optional methods, for async bind/listen</span>
<a name="l00071"></a><a class="code" href="classOsclSocketIBase.html#b8">00071</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#b8">CancelBind</a>()
00072 {}
<a name="l00073"></a><a class="code" href="classOsclSocketIBase.html#b9">00073</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOsclSocketIBase.html#b9">CancelListen</a>()
00074 {}
00075
<a name="l00076"></a><a class="code" href="classOsclSocketIBase.html#n0">00076</a> <a class="code" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> &amp;<a class="code" href="classOsclSocketIBase.html#n0">iAlloc</a>;
00077
00078 <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="classOsclSocketIBase.html#e0">GetShutdown</a>(<a class="code" href="oscl__socket__types_8h.html#a21">TPVSocketShutdown</a> aOsclVal);
00079
00080 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classOsclSocketIBase.html#b10">IsOpen</a>() = 0;
00081
00082 <span class="comment">//link to socket server.</span>
<a name="l00083"></a><a class="code" href="classOsclSocketIBase.html#n1">00083</a> <a class="code" href="classOsclSocketServI.html">OsclSocketServI</a> *<a class="code" href="classOsclSocketIBase.html#n1">iSocketServ</a>;
<a name="l00084"></a><a class="code" href="classOsclSocketIBase.html#l0">00084</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOsclSocketRequest.html">OsclSocketRequest</a>;
<a name="l00085"></a><a class="code" href="classOsclSocketIBase.html#l1">00085</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOsclSocketMethod.html">OsclSocketMethod</a>;
<a name="l00086"></a><a class="code" href="classOsclSocketIBase.html#l2">00086</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOsclSocketRequestAO.html">OsclSocketRequestAO</a>;
00087
00088 <span class="preprocessor">#if(PV_OSCL_SOCKET_STATS_LOGGING)</span>
00089 <span class="preprocessor"></span> OsclSocketStats iStats;
00090 <span class="preprocessor">#endif</span>
00091 <span class="preprocessor"></span>
<a name="l00092"></a><a class="code" href="classOsclSocketIBase.html#l3">00092</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOsclUDPSocket.html">OsclUDPSocket</a>;
<a name="l00093"></a><a class="code" href="classOsclSocketIBase.html#l4">00093</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOsclTCPSocket.html">OsclTCPSocket</a>;
00094 };
00095
00096 <span class="preprocessor">#endif</span>
00097 <span class="preprocessor"></span>
00098
00099
</pre></div><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>