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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Passenger: Client 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.5.8 -->
<div class="navigation" id="top">
<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 class="current"><a href="annotated.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="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>
<div class="contents">
<h1>Client Class Reference</h1><!-- doxytag: class="Client" -->A representation of a <a class="el" href="classClient.html" title="A representation of a Client from the Server's point of view.">Client</a> from the Server's point of view.
<a href="#_details">More...</a>
<p>
<p>
<a href="classClient-members.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="classClient.html#975a3a3d2a4fa5fcf320be38581e99a7">Client</a> (unsigned int number, ApplicationPool::Ptr pool, const string &password, const string &defaultUser, const string &defaultGroup, int serverSocket, const AnalyticsLoggerPtr &logger)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a client handler for the server with the given arguments and runs it in its own thread. <a href="#975a3a3d2a4fa5fcf320be38581e99a7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="840e519ca781888cbd54181572ebe3a7"></a><!-- doxytag: member="Client::~Client" ref="840e519ca781888cbd54181572ebe3a7" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classClient.html#840e519ca781888cbd54181572ebe3a7">~Client</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys this client and its thread. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A representation of a <a class="el" href="classClient.html" title="A representation of a Client from the Server's point of view.">Client</a> from the Server's point of view.
<p>
This class contains the methods used to communicate from a server to a connected client, i.e. it is a client handler. These <a class="el" href="classClient.html" title="A representation of a Client from the Server's point of view.">Client</a> instances will communicate concurrently with the server through threads. Considering the overhead of these threads, i.e. setup and teardown costs and the volatility of client requests, these client instances will be pooled. It is for this reason that the State design pattern has been applied: this class can be considered as being a skeleton implemention whose state --e.g. the client file descriptor-- needs to be provided in order to function properly. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="975a3a3d2a4fa5fcf320be38581e99a7"></a><!-- doxytag: member="Client::Client" ref="975a3a3d2a4fa5fcf320be38581e99a7" args="(unsigned int number, ApplicationPool::Ptr pool, const string &password, const string &defaultUser, const string &defaultGroup, int serverSocket, const AnalyticsLoggerPtr &logger)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Client::Client </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>number</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ApplicationPool::Ptr </td>
<td class="paramname"> <em>pool</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>password</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>defaultUser</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>defaultGroup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>serverSocket</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const AnalyticsLoggerPtr & </td>
<td class="paramname"> <em>logger</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs a client handler for the server with the given arguments and runs it in its own thread.
<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>number</em> </td><td>The id assigned by the server to identify this client by. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The application pool where this client belongs to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>password</em> </td><td>The password that is required to connect to this client handler. This value is determined and assigned by the server. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>serverSocket</em> </td><td>The server socket to accept this clients connection from. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>nginx/HelperAgent.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
|
