class_server.tex
12.4 KB
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
219
220
221
222
223
224
225
\hypertarget{class_server}{\section{Referencia de la Clase Server}
\label{class_server}\index{Server@{Server}}
}
Clase de aplicación servidor.
{\ttfamily \#include $<$server.\-h$>$}
\subsection*{Métodos públicos}
\begin{DoxyCompactItemize}
\item
\hyperlink{class_server_ad5ec9462b520e59f7ea831e157ee5e59}{Server} ()
\begin{DoxyCompactList}\small\item\em Constructor de la clase \hyperlink{class_server}{Server}. \end{DoxyCompactList}\item
int \hyperlink{class_server_acf13ac1f7fc49f28c1b1fa76eab209ab}{get\-N\-Workers} ()
\begin{DoxyCompactList}\small\item\em Getter del número de threads activos. \end{DoxyCompactList}\item
void \hyperlink{class_server_a0090663c66f1f371f8b1aa87c5f49623}{set\-N\-Workers} (int n)
\begin{DoxyCompactList}\small\item\em Setter del número de threads activos. \end{DoxyCompactList}\item
list$<$ pthread\-\_\-t $\ast$ $>$ $\ast$ \hyperlink{class_server_aea36a7c64710f7d6e852a72a124b61bb}{get\-Started\-Threads} ()
\begin{DoxyCompactList}\small\item\em Getter de la pila de threads activos. \end{DoxyCompactList}\item
list$<$ pthread\-\_\-t $\ast$ $>$ $\ast$ \hyperlink{class_server_a266d431df0fc72ae28a9a865e4d0aa5d}{get\-Stopped\-Threads} ()
\begin{DoxyCompactList}\small\item\em Getter de la pila de threads terminados. \end{DoxyCompactList}\item
void \hyperlink{class_server_aef89851f83a9bbe4459c46b6c7906e1f}{start\-Server} (string i, int p)
\begin{DoxyCompactList}\small\item\em Método de inicialización del servidor. \end{DoxyCompactList}\item
void \hyperlink{class_server_a018bee9f1e342d9f349765187d89becd}{free\-R\-A\-M} (list$<$ pthread\-\_\-t $\ast$ $>$ $\ast$thread\-List)
\begin{DoxyCompactList}\small\item\em Método para liberar memória de threads. \end{DoxyCompactList}\item
void \hyperlink{class_server_a74769349252c1ad61717b156e42d61d3}{request\-Exit} ()
\begin{DoxyCompactList}\small\item\em Método para terminar el servidor. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Atributos privados}
\begin{DoxyCompactItemize}
\item
int \hyperlink{class_server_a690955b1e335072c061df67014a6e698}{n\-Workers}
\begin{DoxyCompactList}\small\item\em Contador de threads. \end{DoxyCompactList}\item
bool \hyperlink{class_server_aa9231b38adc787954a13f04372de8ed2}{shutdown\-Server}
\begin{DoxyCompactList}\small\item\em Variable de apagado. \end{DoxyCompactList}\item
int \hyperlink{class_server_ae10d91b60157ccfcc06cc463e8443007}{worker\-I\-D}
\begin{DoxyCompactList}\small\item\em Contador de I\-D de thread. \end{DoxyCompactList}\item
list$<$ pthread\-\_\-t $\ast$ $>$ \hyperlink{class_server_a36a18616b526f3053a1036641a62cb0a}{stopped\-Threads}
\begin{DoxyCompactList}\small\item\em Pila de threads terminados. \end{DoxyCompactList}\item
list$<$ pthread\-\_\-t $\ast$ $>$ \hyperlink{class_server_a40fdc13e227f651943e0aa3757824396}{started\-Threads}
\begin{DoxyCompactList}\small\item\em Pila de threads empezados. \end{DoxyCompactList}\item
\hyperlink{class_socket}{Socket} \hyperlink{class_server_af9e1a6848bdd627741b85e75777e3b45}{ss}
\begin{DoxyCompactList}\small\item\em \hyperlink{class_socket}{Socket} de comunicación. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection{Descripción detallada}
Clase de aplicación servidor.
Esta clase define un objeto con los métodos y atributos necesarios para lanzar una aplicación servidor y atender las conexiones. Para realizar la comunicación con el cliente, usa un objeto de la clase \hyperlink{class_socket}{Socket}
\subsection{Documentación del constructor y destructor}
\hypertarget{class_server_ad5ec9462b520e59f7ea831e157ee5e59}{\index{Server@{Server}!Server@{Server}}
\index{Server@{Server}!Server@{Server}}
\subsubsection[{Server}]{\setlength{\rightskip}{0pt plus 5cm}Server\-::\-Server (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{class_server_ad5ec9462b520e59f7ea831e157ee5e59}
Constructor de la clase \hyperlink{class_server}{Server}.
Incializa los argumentos inciales del servidor
\subsection{Documentación de las funciones miembro}
\hypertarget{class_server_a018bee9f1e342d9f349765187d89becd}{\index{Server@{Server}!free\-R\-A\-M@{free\-R\-A\-M}}
\index{free\-R\-A\-M@{free\-R\-A\-M}!Server@{Server}}
\subsubsection[{free\-R\-A\-M}]{\setlength{\rightskip}{0pt plus 5cm}void Server\-::free\-R\-A\-M (
\begin{DoxyParamCaption}
\item[{list$<$ pthread\-\_\-t $\ast$ $>$ $\ast$}]{thread\-List}
\end{DoxyParamCaption}
)}}\label{class_server_a018bee9f1e342d9f349765187d89becd}
Método para liberar memória de threads.
Este método se llama para que libere la memoria de todos los threads que se le proporcionan por argumento
\begin{DoxyParams}{Parámetros}
{\em thread\-List} & Contenedor con los threads a liberar \\
\hline
\end{DoxyParams}
\hypertarget{class_server_acf13ac1f7fc49f28c1b1fa76eab209ab}{\index{Server@{Server}!get\-N\-Workers@{get\-N\-Workers}}
\index{get\-N\-Workers@{get\-N\-Workers}!Server@{Server}}
\subsubsection[{get\-N\-Workers}]{\setlength{\rightskip}{0pt plus 5cm}int Server\-::get\-N\-Workers (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{class_server_acf13ac1f7fc49f28c1b1fa76eab209ab}
Getter del número de threads activos.
Devuelve el número de threads activos en ese instante, por tanto, del número de conexiones que están siendo atendidas. \hypertarget{class_server_aea36a7c64710f7d6e852a72a124b61bb}{\index{Server@{Server}!get\-Started\-Threads@{get\-Started\-Threads}}
\index{get\-Started\-Threads@{get\-Started\-Threads}!Server@{Server}}
\subsubsection[{get\-Started\-Threads}]{\setlength{\rightskip}{0pt plus 5cm}list$<$pthread\-\_\-t$\ast$$>$$\ast$ Server\-::get\-Started\-Threads (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{class_server_aea36a7c64710f7d6e852a72a124b61bb}
Getter de la pila de threads activos.
Devuelve un contenedor con la lista de threads que estan activos, para terminarlos en caso de que el programa finalice prematuramente \hypertarget{class_server_a266d431df0fc72ae28a9a865e4d0aa5d}{\index{Server@{Server}!get\-Stopped\-Threads@{get\-Stopped\-Threads}}
\index{get\-Stopped\-Threads@{get\-Stopped\-Threads}!Server@{Server}}
\subsubsection[{get\-Stopped\-Threads}]{\setlength{\rightskip}{0pt plus 5cm}list$<$pthread\-\_\-t$\ast$$>$$\ast$ Server\-::get\-Stopped\-Threads (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{class_server_a266d431df0fc72ae28a9a865e4d0aa5d}
Getter de la pila de threads terminados.
Devuelve un contenedor con la lista de threads que han terminado, para poder liberar la memoria que se le ha asignado \hypertarget{class_server_a74769349252c1ad61717b156e42d61d3}{\index{Server@{Server}!request\-Exit@{request\-Exit}}
\index{request\-Exit@{request\-Exit}!Server@{Server}}
\subsubsection[{request\-Exit}]{\setlength{\rightskip}{0pt plus 5cm}void Server\-::request\-Exit (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{class_server_a74769349252c1ad61717b156e42d61d3}
Método para terminar el servidor.
Este método inicia la secuencia de finalización del servidor \hypertarget{class_server_a0090663c66f1f371f8b1aa87c5f49623}{\index{Server@{Server}!set\-N\-Workers@{set\-N\-Workers}}
\index{set\-N\-Workers@{set\-N\-Workers}!Server@{Server}}
\subsubsection[{set\-N\-Workers}]{\setlength{\rightskip}{0pt plus 5cm}void Server\-::set\-N\-Workers (
\begin{DoxyParamCaption}
\item[{int}]{n}
\end{DoxyParamCaption}
)}}\label{class_server_a0090663c66f1f371f8b1aa87c5f49623}
Setter del número de threads activos.
Establece el número de threads activos, para poder cambiarlo cuando alguno de los threads activos finaliza
\begin{DoxyParams}{Parámetros}
{\em n} & Nuevo número de threads activos \\
\hline
\end{DoxyParams}
\hypertarget{class_server_aef89851f83a9bbe4459c46b6c7906e1f}{\index{Server@{Server}!start\-Server@{start\-Server}}
\index{start\-Server@{start\-Server}!Server@{Server}}
\subsubsection[{start\-Server}]{\setlength{\rightskip}{0pt plus 5cm}void Server\-::start\-Server (
\begin{DoxyParamCaption}
\item[{string}]{i, }
\item[{int}]{p}
\end{DoxyParamCaption}
)}}\label{class_server_aef89851f83a9bbe4459c46b6c7906e1f}
Método de inicialización del servidor.
Incializa el servidor en el puerto e I\-P especificados para empezar a recibir conexiones entrantes
\begin{DoxyParams}{Parámetros}
{\em i} & I\-P donde se aceptan las conexiones \\
\hline
{\em p} & Puerto donde se aceptan las conexiones \\
\hline
\end{DoxyParams}
\subsection{Documentación de los datos miembro}
\hypertarget{class_server_a690955b1e335072c061df67014a6e698}{\index{Server@{Server}!n\-Workers@{n\-Workers}}
\index{n\-Workers@{n\-Workers}!Server@{Server}}
\subsubsection[{n\-Workers}]{\setlength{\rightskip}{0pt plus 5cm}int Server\-::n\-Workers\hspace{0.3cm}{\ttfamily [private]}}}\label{class_server_a690955b1e335072c061df67014a6e698}
Contador de threads.
\begin{DoxyVerb}Esta variable se encarga de mantener la cuenta de threads activos, por tanto, el número de conexiones que estan siendo antendidas
\end{DoxyVerb}
simultáneamente. \hypertarget{class_server_aa9231b38adc787954a13f04372de8ed2}{\index{Server@{Server}!shutdown\-Server@{shutdown\-Server}}
\index{shutdown\-Server@{shutdown\-Server}!Server@{Server}}
\subsubsection[{shutdown\-Server}]{\setlength{\rightskip}{0pt plus 5cm}bool Server\-::shutdown\-Server\hspace{0.3cm}{\ttfamily [private]}}}\label{class_server_aa9231b38adc787954a13f04372de8ed2}
Variable de apagado.
\begin{DoxyVerb}Esta variable controla el apagado del servidor, al ponerla a true, la siguiente iteración del bucle que atiende las conexiones
\end{DoxyVerb}
no se producirá y el programa terminará. \hypertarget{class_server_af9e1a6848bdd627741b85e75777e3b45}{\index{Server@{Server}!ss@{ss}}
\index{ss@{ss}!Server@{Server}}
\subsubsection[{ss}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Socket} Server\-::ss\hspace{0.3cm}{\ttfamily [private]}}}\label{class_server_af9e1a6848bdd627741b85e75777e3b45}
\hyperlink{class_socket}{Socket} de comunicación.
\begin{DoxyVerb}Esta variable contiene el objeto de la clase Socket que la aplicación servidor usa para poder atender las peticiones. Su función
\end{DoxyVerb}
es quedarse escuchando el el puerto e I\-P introducidas en el fichero de configuración y crear un objeto de la clase \hyperlink{class_socket}{Socket} para cada petición de cada cliente nuevo, siendo este último objeto creado el que se usa para la comuncación. \hypertarget{class_server_a40fdc13e227f651943e0aa3757824396}{\index{Server@{Server}!started\-Threads@{started\-Threads}}
\index{started\-Threads@{started\-Threads}!Server@{Server}}
\subsubsection[{started\-Threads}]{\setlength{\rightskip}{0pt plus 5cm}list$<$pthread\-\_\-t$\ast$$>$ Server\-::started\-Threads\hspace{0.3cm}{\ttfamily [private]}}}\label{class_server_a40fdc13e227f651943e0aa3757824396}
Pila de threads empezados.
Esta variable contiene una lista de threads que han empezado su ejecución. Si el programa finalizara prematuramente, se liberarían los punteros de los threads almacenados en esta pila.
{\bfseries N\-O\-T\-A\-: No se liberará la memoria asignada a los argumentos de los threads, dando lugar a memory leaks; sin embargo, esto se produciria al finalizar el programa, por tanto no es relevante.} \hypertarget{class_server_a36a18616b526f3053a1036641a62cb0a}{\index{Server@{Server}!stopped\-Threads@{stopped\-Threads}}
\index{stopped\-Threads@{stopped\-Threads}!Server@{Server}}
\subsubsection[{stopped\-Threads}]{\setlength{\rightskip}{0pt plus 5cm}list$<$pthread\-\_\-t$\ast$$>$ Server\-::stopped\-Threads\hspace{0.3cm}{\ttfamily [private]}}}\label{class_server_a36a18616b526f3053a1036641a62cb0a}
Pila de threads terminados.
\begin{DoxyVerb}Esta variable contiene una lista de threads que han finalizado su ejecución. A cada iteración del bucle que atiende conexiones,
\end{DoxyVerb}
se libera toda la memoria de los threads que hay almacenados aquí. \hypertarget{class_server_ae10d91b60157ccfcc06cc463e8443007}{\index{Server@{Server}!worker\-I\-D@{worker\-I\-D}}
\index{worker\-I\-D@{worker\-I\-D}!Server@{Server}}
\subsubsection[{worker\-I\-D}]{\setlength{\rightskip}{0pt plus 5cm}int Server\-::worker\-I\-D\hspace{0.3cm}{\ttfamily [private]}}}\label{class_server_ae10d91b60157ccfcc06cc463e8443007}
Contador de I\-D de thread.
\begin{DoxyVerb}Esta variable contiene el ID del próximo thread que se creará, por tanto, indica el número de conexiones que han sido atendidas desde
\end{DoxyVerb}
el inicio del servidor
La documentación para esta clase fue generada a partir del siguiente fichero\-:\begin{DoxyCompactItemize}
\item
/home/imanol/devel/eclipse/\-P\-A\-D/\-J\-Chat\-Client/src/include/\hyperlink{server_8h}{server.\-h}\end{DoxyCompactItemize}