-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathBase--Server--Client.html
209 lines (168 loc) · 6.93 KB
/
Base--Server--Client.html
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Base::Server::Client - A client within a Base::Server : OpenKore source code documentation</title>
<link rel="stylesheet" type="text/css" href="openkore.css">
<link rel="stylesheet" type="text/css" href="highlight.css">
<!-- Fix broken PNG transparency for IE/Win5-6+ -->
<!--[if gte IE 5.5000]>
<script type="text/javascript" src="pngfix.js"></script>
<![endif]-->
</head>
<body>
<div id="title">OpenKore source code documentation</div>
<div id="navigation">
<ul>
<li><a href="http://www.openkore.com/">Main website</a></li>
<li><a href="index.html">Table of contents</a></li>
<li><b>Base::Server::Client</b></li>
</ul>
</div>
<div id="main">
<h1>Base::Server::Client - A client within a Base::Server</h1>
The three abstract functions in <a href="Base--Server.html"><code>Base::Server</code></a> all have
an <code>$client</code> object as parameter, which is of this type.
This class represents a client which the server handles.
<p><table class="functionIndex">
<tr><th colspan="3">Functions in this module</th></tr><tr onclick="location.href='#$BaseServerClient->close';">
<td class="return-type">void</td>
<td class="func"><a href="#$BaseServerClient->close">$BaseServerClient->close</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$BaseServerClient->getFD';">
<td class="return-type">int</td>
<td class="func"><a href="#$BaseServerClient->getFD">$BaseServerClient->getFD</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$BaseServerClient->getIP';">
<td class="return-type">String</td>
<td class="func"><a href="#$BaseServerClient->getIP">$BaseServerClient->getIP</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$BaseServerClient->getIndex';">
<td class="return-type">int</td>
<td class="func"><a href="#$BaseServerClient->getIndex">$BaseServerClient->getIndex</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$BaseServerClient->getSocket';">
<td class="return-type">IO::Socket::INET</td>
<td class="func"><a href="#$BaseServerClient->getSocket">$BaseServerClient->getSocket</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$BaseServerClient->send';">
<td class="return-type">boolean</td>
<td class="func"><a href="#$BaseServerClient->send">$BaseServerClient->send</a></td>
<td class="decl">(<span class="type">Bytes</span> data)</td>
</tr>
</table>
<p><hr class="details_sep">
<h2>Details</h2>
<div class="details">
<p>
<div class="function"><a name="$BaseServerClient->close"></a>
<h3>$BaseServerClient->close</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$BaseServerClient->close</strong>()
</dt>
<dd>
<div class="desc">Disconnect this client. In the next <a href="Base--Server.html#$BaseServer->iterate"><code>$BaseServer->iterate()</code></a> call, this Base::Server::Client
object will be removed from the <a href="Base--Server.html"><code>Base::Server</code></a> object's internal list.
<p>
You must not call <a href="Base--Server--Client.html#$BaseServerClient->send"><code>$BaseServerClient->send()</code></a> anymore after having called this function.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$BaseServerClient->getFD"></a>
<h3>$BaseServerClient->getFD</h3>
<dl>
<dt class="decl">
<span class="return-type"> int</span> <strong>$BaseServerClient->getFD</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures">defined(result)</dd>
</dl><p>
<div class="desc">Returns the client's file descriptor.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$BaseServerClient->getIP"></a>
<h3>$BaseServerClient->getIP</h3>
<dl>
<dt class="decl">
<span class="return-type"> String</span> <strong>$BaseServerClient->getIP</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures">result ne ''</dd>
</dl><p>
<div class="desc">Returns the client's IP address in text form.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$BaseServerClient->getIndex"></a>
<h3>$BaseServerClient->getIndex</h3>
<dl>
<dt class="decl">
<span class="return-type"> int</span> <strong>$BaseServerClient->getIndex</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures">defined(result)</dd>
</dl><p>
<div class="desc">Returns the index of this object in the <a href="Base--Server.html"><code>Base::Server</code></a> object's internal list.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$BaseServerClient->getSocket"></a>
<h3>$BaseServerClient->getSocket</h3>
<dl>
<dt class="decl">
<span class="return-type"> IO::Socket::INET</span> <strong>$BaseServerClient->getSocket</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures">defined(result)</dd>
</dl><p>
<div class="desc">Return the client's socket.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$BaseServerClient->send"></a>
<h3>$BaseServerClient->send</h3>
<dl>
<dt class="decl">
<span class="return-type"> boolean</span> <strong>$BaseServerClient->send</strong>(<span class="type">Bytes</span> data)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>data</code> : The data to send.</dd>
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">defined($data)</dd>
<dt class="returns"><strong>Returns:</strong></dt>
<dd class="returns">1 on success, 0 on failure.</dd>
</dl><p>
<div class="desc">Send data to the client.</div>
</dd>
</dl>
</div>
</div>
<p><hr><p>
<div id="footer">
<ul>
<li><a href="http://validator.w3.org/check?uri=referer" title="Valid HTML 4.01!"><img src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" height="31" width="88"></a></li>
<li><a href="http://www.mozilla.com/" title="Get Firefox - Take Back the Web"><img width="104" height="32" src="http://www.mozilla.org/products/firefox/buttons/getfirefox_small.png" alt="Get Firefox - Take Back the Web"></a></li>
<li><a href="http://www.mozilla.com/" title="If you were looking at this page in any browser but Microsoft Internet Explorer, it would look and run better and faster"><img width="45" height="45" src="http://linuxart.com/img/noIE-small.png" alt="If you were looking at this page in any browser but Microsoft Internet Explorer, it would look and run better and faster"></a></li>
</ul>
Last modified: Fri Nov 16 10:05:11 2012
</div>
</div>
</body>
</html>