Blame view

JChatClient/doc/html/client_8cpp.html 14.3 KB
1
2
3
4
5
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
<meta name="generator" content="Doxygen 1.8.3.1"/>
7
<title>Socket: Referencia del Archivo /home/imanol/devel/eclipse/PAD/JChatClient/src/client.cpp</title>
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
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Socket
   </div>
   <div id="projectbrief">Librería para comunicar via TCP/IP</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
34
<!-- Generado por Doxygen 1.8.3.1 -->
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
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Buscar');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Página&#160;principal</span></a></li>
      <li><a href="pages.html"><span>Páginas&#160;relacionadas</span></a></li>
      <li><a href="annotated.html"><span>Clases</span></a></li>
      <li class="current"><a href="files.html"><span>Archivos</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Buscar" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>Lista&#160;de&#160;archivos</span></a></li>
      <li><a href="globals.html"><span>Miembros&#160;de&#160;los&#160;ficheros</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
73
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>Todo</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Clases</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Archivos</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Funciones</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Páginas</a></div>
74
75
76
77
78
79
80
81
82
83

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
84
<li class="navelem"><a class="el" href="dir_75b82e7e4a5feb05200b9ad7adf06257.html">home</a></li><li class="navelem"><a class="el" href="dir_ade356989cf64bc7da597536eeab2615.html">imanol</a></li><li class="navelem"><a class="el" href="dir_8f7199732ad0be50edd1dbedbf9226de.html">devel</a></li><li class="navelem"><a class="el" href="dir_86dc413d07e0b16a37ceb0e2a17fed53.html">eclipse</a></li><li class="navelem"><a class="el" href="dir_c63cc34e984e21a69fd262eeef6a5cbb.html">PAD</a></li><li class="navelem"><a class="el" href="dir_74bdbd27aa6df54b6fb8f419761ac887.html">JChatClient</a></li><li class="navelem"><a class="el" href="dir_15c52bfb9a80984ec0ac7c94446ac4fc.html">src</a></li>  </ul>
85
86
87
88
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
89
90
<a href="#func-members">Funciones</a> &#124;
<a href="#var-members">Variables</a>  </div>
91
92
93
94
95
96
97
  <div class="headertitle">
<div class="title">Referencia del Archivo client.cpp</div>  </div>
</div><!--header-->
<div class="contents">

<p>Fichero de implementación de un cliente.  
<a href="#details">Más...</a></p>
98
<div class="textblock"><code>#include &quot;<a class="el" href="client_8h_source.html">client.h</a>&quot;</code><br/>
99
100
101
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Funciones</h2></td></tr>
102
103
104
<tr class="memitem:ab99831172d1d4bca2c79bb37c7c062df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="client_8cpp.html#ab99831172d1d4bca2c79bb37c7c062df">killThread</a> (<a class="el" href="structthread__args.html">thread_args</a> *t_arg)</td></tr>
<tr class="memdesc:ab99831172d1d4bca2c79bb37c7c062df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Método de liberación de los argumentos.  <a href="#ab99831172d1d4bca2c79bb37c7c062df">Más...</a><br/></td></tr>
<tr class="separator:ab99831172d1d4bca2c79bb37c7c062df"><td class="memSeparator" colspan="2">&#160;</td></tr>
105
<tr class="memitem:ab4a3d59d9d8c97b79cb3a6cb6a0e403c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="client_8cpp.html#ab4a3d59d9d8c97b79cb3a6cb6a0e403c">connect</a> (<a class="el" href="class_socket.html">Socket</a> &amp;s)</td></tr>
106
<tr class="memdesc:ab4a3d59d9d8c97b79cb3a6cb6a0e403c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Método de conexión.  <a href="#ab4a3d59d9d8c97b79cb3a6cb6a0e403c">Más...</a><br/></td></tr>
107
<tr class="separator:ab4a3d59d9d8c97b79cb3a6cb6a0e403c"><td class="memSeparator" colspan="2">&#160;</td></tr>
108
109
110
111
112
113
<tr class="memitem:a6511fc920cd92a0fe628df3f1a1f7e5a"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="client_8cpp.html#a6511fc920cd92a0fe628df3f1a1f7e5a">sendThread</a> (void *args)</td></tr>
<tr class="memdesc:a6511fc920cd92a0fe628df3f1a1f7e5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Thread de envío de mensajes.  <a href="#a6511fc920cd92a0fe628df3f1a1f7e5a">Más...</a><br/></td></tr>
<tr class="separator:a6511fc920cd92a0fe628df3f1a1f7e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbdd974364b0dba7bb0524ab8f115a03"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="client_8cpp.html#abbdd974364b0dba7bb0524ab8f115a03">recvThread</a> (void *args)</td></tr>
<tr class="memdesc:abbdd974364b0dba7bb0524ab8f115a03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Thread de recepción de mensajes.  <a href="#abbdd974364b0dba7bb0524ab8f115a03">Más...</a><br/></td></tr>
<tr class="separator:abbdd974364b0dba7bb0524ab8f115a03"><td class="memSeparator" colspan="2">&#160;</td></tr>
114
115
116
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="client_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Método principal del cliente.  <a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">Más...</a><br/></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
117
118
119
120
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ab36823025f12a809217f7771125658c2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="client_8cpp.html#ab36823025f12a809217f7771125658c2">connected</a></td></tr>
121
<tr class="memdesc:ab36823025f12a809217f7771125658c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Variable de estado del programa.  <a href="#ab36823025f12a809217f7771125658c2">Más...</a><br/></td></tr>
122
<tr class="separator:ab36823025f12a809217f7771125658c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
123
<tr class="memitem:a9324389a5cdc532c6417a87ccafe18ce"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="client_8cpp.html#a9324389a5cdc532c6417a87ccafe18ce">finished</a></td></tr>
124
<tr class="memdesc:a9324389a5cdc532c6417a87ccafe18ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Variable de estado del programa.  <a href="#a9324389a5cdc532c6417a87ccafe18ce">Más...</a><br/></td></tr>
125
<tr class="separator:a9324389a5cdc532c6417a87ccafe18ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
126
127
128
129
130
</table>
<a name="details" id="details"></a><h2 class="groupheader">Descripción detallada</h2>
<div class="textblock"><p>Fichero de implementación de un cliente. </p>
<dl class="section author"><dt>Autor</dt><dd>Imanol Barba Sabariego </dd></dl>
<dl class="section date"><dt>Fecha</dt><dd>13/06/2013</dd></dl>
131
<p>En este fichero se implementa un cliente para poder usar con el servidor creado, usando la clase <a class="el" href="class_socket.html" title="Clase del socket.">Socket</a>. REVISADO EL 10/12/2013 PARA LA APLIACIÓN JCHAT </p>
132
</div><h2 class="groupheader">Documentación de las funciones</h2>
133
134
135
136
137
138
139
140
<a class="anchor" id="ab4a3d59d9d8c97b79cb3a6cb6a0e403c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool connect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_socket.html">Socket</a> &amp;&#160;</td>
141
          <td class="paramname"><em>s</em></td><td>)</td>
142
143
144
145
146
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
147
148
149
<p>Método de conexión. </p>
<p>Este método conecta el cliente a una sala de chat. </p>
150
151
</div>
</div>
152
<a class="anchor" id="ab99831172d1d4bca2c79bb37c7c062df"></a>
153
154
155
156
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
157
          <td class="memname">void killThread </td>
158
          <td>(</td>
159
160
          <td class="paramtype"><a class="el" href="structthread__args.html">thread_args</a> *&#160;</td>
          <td class="paramname"><em>t_arg</em></td><td>)</td>
161
162
163
164
165
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
166
167
<p>Método de liberación de los argumentos. </p>
<p>Este método se encarga de liberar la memoria asignada a los argumentos pasados a los threads que ahora han terminado. </p>
168
169
170
171
172
173
174
175
176
177

</div>
</div>
<a class="anchor" id="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
178
          <td class="paramname"></td><td>)</td>
179
180
181
182
183
184
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Método principal del cliente. </p>
185
<p>Este método inicializa el <a class="el" href="class_socket.html" title="Clase del socket.">Socket</a>, establece la conexión y realiza las acciones que se le hayan programado para comunicarse con el servidor. </p>
186
187
188

</div>
</div>
189
<a class="anchor" id="abbdd974364b0dba7bb0524ab8f115a03"></a>
190
191
192
193
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
194
          <td class="memname">void* recvThread </td>
195
          <td>(</td>
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>args</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Thread de recepción de mensajes. </p>
<p>Este método es ejecutado por un thread con el objetivo de recibir los mensajes por el socket, gestionarlos e imprimirlos por pantalla o tomar las medidas necesarias . </p>

</div>
</div>
<a class="anchor" id="a6511fc920cd92a0fe628df3f1a1f7e5a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* sendThread </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>args</em></td><td>)</td>
217
218
219
220
221
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
222
223
224
<p>Thread de envío de mensajes. </p>
<p>Este método es ejecutado por un thread con el objetivo de enviar los mensajes y comandos que el usuario introduce por teclado. </p>
225
226
227
228
229
230
231
232
233
234
235
236
237
</div>
</div>
<h2 class="groupheader">Documentación de las variables</h2>
<a class="anchor" id="ab36823025f12a809217f7771125658c2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool connected</td>
        </tr>
      </table>
</div><div class="memdoc">
238
239
<p>Variable de estado del programa. </p>
240
241
</div>
</div>
242
243
244
245
246
247
248
249
250
251
<a class="anchor" id="a9324389a5cdc532c6417a87ccafe18ce"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool finished</td>
        </tr>
      </table>
</div><div class="memdoc">
252
253
<p>Variable de estado del programa. </p>
254
255
</div>
</div>
256
257
258
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
259
Generado el Martes, 10 de Diciembre de 2013 04:23:31 para Socket por &#160;<a href="http://www.doxygen.org/index.html">
260
<img class="footer" src="doxygen.png" alt="doxygen"/>
261
</a> 1.8.3.1
262
263
264
</small></address>
</body>
</html>