1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>oscl: OsclTCPSocket Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>OsclTCPSocket Class Reference<br/>
<small>
[<a class="el" href="group__osclio.html">OSCL IO</a>]</small>
</h1><!-- doxytag: class="OsclTCPSocket" --><!-- doxytag: inherits="HeapBase" -->
<p><code>#include <<a class="el" href="oscl__socket_8h_source.html">oscl_socket.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for OsclTCPSocket:</div>
<div class="dynsection">
<div class="center">
<img src="classOsclTCPSocket.png" usemap="#OsclTCPSocket_map" alt=""/>
<map id="OsclTCPSocket_map" name="OsclTCPSocket_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>
</div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga971547c10eb222fbb6c661b70bb90d49">~OsclTCPSocket</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="oscl__socket__types_8h.html#a4997c79c51d21741526e9c3890d2ddff">TPVSocketEvent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga7411e860564c17810ba143c3c5eebce6">ThreadLogoff</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="oscl__socket__types_8h.html#a4997c79c51d21741526e9c3890d2ddff">TPVSocketEvent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga1a5b3d96fe0aa38ce3187c646aef91c2">ThreadLogon</a> (<a class="el" href="classOsclSocketServ.html">OsclSocketServ</a> &aServ, <a class="el" href="classOsclSocketObserver.html">OsclSocketObserver</a> *aObserver)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#gaecf3d5024256b133eec7c6c646f6a5b7">Close</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga6487dfd0cae91eefe1324dc7d212b93b">Bind</a> (<a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &aAddress)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="oscl__socket__types_8h.html#a4997c79c51d21741526e9c3890d2ddff">TPVSocketEvent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga7c552f2030354da0af4cbe723b94a97d">BindAsync</a> (<a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &aAddress, int32 aTimeoutMsec=(-1))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga783aa02d66b4c669517250857f607a93">CancelBind</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga25bf7763e044061dae61dda892bcab13">SetOptionToReuseAddress</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#gad13742c2e7d4a661dee6d53327ed4d06">SetTOS</a> (const <a class="el" href="classOsclSocketTOS.html">OsclSocketTOS</a> &aTOS)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga0a4e9b6b31a160b3aa98a3ba3d01cdef">GetPeerName</a> (<a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &aPeerName)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#gaa3e01ad4324cb7f0a2923174dffc1bde">Listen</a> (int32 aQueueSize)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="oscl__socket__types_8h.html#a4997c79c51d21741526e9c3890d2ddff">TPVSocketEvent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#gacc374e8540b9e5519ef8a8b64f961667">ListenAsync</a> (int32 aQueueSize, int32 aTimeoutMsec=(-1))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#gaf0d3aa25c8c9601b27784040343a5018">CancelListen</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="classOsclTCPSocket.html">OsclTCPSocket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga6d58ae50931a3aed80f445c58c739f7f">GetAcceptedSocketL</a> (uint32 aId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF uint8 * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga96719357e7341f5a4cdae63f5c1d945b">GetRecvData</a> (int32 *aLength)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF uint8 * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#gaeb2599dba7f5c86d3e8884ea6ee4cc21">GetSendData</a> (int32 *aLength)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="oscl__socket__types_8h.html#a4997c79c51d21741526e9c3890d2ddff">TPVSocketEvent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga36cd52b387788080accc341a07e26cf8">Connect</a> (<a class="el" href="classOsclNetworkAddress.html">OsclNetworkAddress</a> &aAddress, int32 aTimeoutMsec=-1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga48723a7ca1a2986175c6f7b4981c90ec">CancelConnect</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="oscl__socket__types_8h.html#a4997c79c51d21741526e9c3890d2ddff">TPVSocketEvent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga5422dd9b0afc3e9070658b793bc54199">Shutdown</a> (<a class="el" href="oscl__socket__types_8h.html#a20988040ed0794b81547c60b5ffdde79">TPVSocketShutdown</a> aHow, int32 aTimeoutMsec=-1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#gaeb5d88816b37974ccb1dd8864c55bae2">CancelShutdown</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="oscl__socket__types_8h.html#a4997c79c51d21741526e9c3890d2ddff">TPVSocketEvent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga7a82d8b67880a7a586d29cb534e0fc1c">Accept</a> (int32 aTimeout=-1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga60fa6ddef4cc9436048a74a4f648c113">CancelAccept</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="oscl__socket__types_8h.html#a4997c79c51d21741526e9c3890d2ddff">TPVSocketEvent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#gac0a77f20541bcd56a7bb4dcf04338e89">Send</a> (const uint8 *aPtr, uint32 aLen, int32 aTimeoutMsec=-1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga8cd4c2f59b3c78530ef0819f52541fff">CancelSend</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="oscl__socket__types_8h.html#a4997c79c51d21741526e9c3890d2ddff">TPVSocketEvent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga3ec8732366c9de9a6c68be217e5b7252">Recv</a> (uint8 *aPtr, uint32 aMaxLen, int32 aTimeoutMsec=-1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclio.html#ga011c9afecbedc6a76ea9a57755a6fa3d">CancelRecv</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static OSCL_IMPORT_REF <br class="typebreak"/>
<a class="el" href="classOsclTCPSocket.html">OsclTCPSocket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclTCPSocket.html#a506e1973242fef636126ec9e4f146dd3">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="classOsclSocketObserver.html">OsclSocketObserver</a> *aObserver, uint32 aId)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The TCP Socket class </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a506e1973242fef636126ec9e4f146dd3"></a><!-- doxytag: member="OsclTCPSocket::NewL" ref="a506e1973242fef636126ec9e4f146dd3" args="(Oscl_DefAlloc &alloc, OsclSocketServ &aServ, OsclSocketObserver *aObserver, uint32 aId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static OSCL_IMPORT_REF <a class="el" href="classOsclTCPSocket.html">OsclTCPSocket</a>* OsclTCPSocket::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOscl__DefAlloc.html">Oscl_DefAlloc</a> & </td>
<td class="paramname"> <em>alloc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classOsclSocketServ.html">OsclSocketServ</a> & </td>
<td class="paramname"> <em>aServ</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classOsclSocketObserver.html">OsclSocketObserver</a> * </td>
<td class="paramname"> <em>aObserver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32 </td>
<td class="paramname"> <em>aId</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a TCP Socket. May leave if failure.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>alloc,:</em> </td><td>Memory allocator. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aServ,:</em> </td><td>Socket server. Must be connected. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aObserver,:</em> </td><td>Socket observer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aId,:</em> </td><td>Socket ID. The caller must assign an ID to each socket. The ID is used to identify the socket in observer callbacks. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns pointer to socket. </dd></dl>
</div>
</div>
<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></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: CORE_9.002.1.1 </small>
</small></address>
</body>
</html>
|
