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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>scim: scim::SocketClient Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.0 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="a00157.html">scim</a>::<a class="el" href="a00106.html">SocketClient</a></div>
<h1>scim::SocketClient Class Reference<br>
<small>
[<a class="el" href="a00165.html">SocketCommunication</a>]</small>
</h1><!-- doxytag: class="scim::SocketClient" --><!-- doxytag: inherits="scim::Socket" --><a class="el" href="a00104.html">Socket</a> client class.
<a href="#_details">More...</a>
<p>
<code>#include <scim_socket.h></code>
<p>
Inheritance diagram for scim::SocketClient:<p><center><img src="a00665.png" border="0" usemap="#a00666" alt="Inheritance graph"></center>
<map name="a00666">
<area href="a00104.html" shape="rect" coords="27,8,128,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for scim::SocketClient:<p><center><img src="a00667.png" border="0" usemap="#a00668" alt="Collaboration graph"></center>
<map name="a00668">
<area href="a00104.html" shape="rect" coords="27,8,128,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="a00669.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#da4519fe4fddb428a0d8b9ad3b1d7265">SocketClient</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#da4519fe4fddb428a0d8b9ad3b1d7265"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#22ff8de009fc770657367d4b2d71c687">SocketClient</a> (const <a class="el" href="a00105.html">SocketAddress</a> &address)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#22ff8de009fc770657367d4b2d71c687"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#a4d2dec65e43c0605156de4666ff7bb5">~SocketClient</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a4d2dec65e43c0605156de4666ff7bb5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#d50a0272ef6c493d507bb6fc1b04c6a3">is_connected</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the socket is connected. <a href="#d50a0272ef6c493d507bb6fc1b04c6a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#cf0418f59afc17341a63b6f8f30930da">connect</a> (const <a class="el" href="a00105.html">SocketAddress</a> &address)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect to a server. <a href="#cf0418f59afc17341a63b6f8f30930da"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html#e68a5465561791f1e0ae1319e16a4e3d">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the client. <a href="#e68a5465561791f1e0ae1319e16a4e3d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="a00104.html">Socket</a> client class.
<p>
Class <a class="el" href="a00106.html">SocketClient</a> provides basic operations to create a <a class="el" href="a00104.html">Socket</a> Client, such as connect, read, write, etc.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="da4519fe4fddb428a0d8b9ad3b1d7265"></a><!-- doxytag: member="scim::SocketClient::SocketClient" ref="da4519fe4fddb428a0d8b9ad3b1d7265" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::SocketClient::SocketClient </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
</div>
</div><p>
<a class="anchor" name="22ff8de009fc770657367d4b2d71c687"></a><!-- doxytag: member="scim::SocketClient::SocketClient" ref="22ff8de009fc770657367d4b2d71c687" args="(const SocketAddress &address)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::SocketClient::SocketClient </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00105.html">SocketAddress</a> & </td>
<td class="paramname"> <em>address</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>the server address to be connected. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a4d2dec65e43c0605156de4666ff7bb5"></a><!-- doxytag: member="scim::SocketClient::~SocketClient" ref="a4d2dec65e43c0605156de4666ff7bb5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::SocketClient::~SocketClient </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d50a0272ef6c493d507bb6fc1b04c6a3"></a><!-- doxytag: member="scim::SocketClient::is_connected" ref="d50a0272ef6c493d507bb6fc1b04c6a3" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::SocketClient::is_connected </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the socket is connected.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the socket client is connected to a server. </dd></dl>
</div>
</div><p>
<a class="anchor" name="cf0418f59afc17341a63b6f8f30930da"></a><!-- doxytag: member="scim::SocketClient::connect" ref="cf0418f59afc17341a63b6f8f30930da" args="(const SocketAddress &address)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::SocketClient::connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00105.html">SocketAddress</a> & </td>
<td class="paramname"> <em>address</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect to a server.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>the server socket address to be connected to.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if connected successfully. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e68a5465561791f1e0ae1319e16a4e3d"></a><!-- doxytag: member="scim::SocketClient::close" ref="e68a5465561791f1e0ae1319e16a4e3d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::SocketClient::close </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close the client.
<p>
<p>
Reimplemented from <a class="el" href="a00104.html#5dddb2638795e45a6cc34e2d6be565c0">scim::Socket</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00151.html">scim_socket.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:52 2007 for scim by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>
|
