File: events.dox

package info (click to toggle)
libgadu 1:1.9.0-2+squeeze2
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 2,828 kB
  • ctags: 735
  • sloc: ansic: 10,507; sh: 10,195; perl: 320; makefile: 161
file content (346 lines) | stat: -rw-r--r-- 9,100 bytes parent folder | download
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
/**

\defgroup events Obsługa zdarzeń
\ingroup session

\details

Funkcje biblioteki zostały przygotowane w taki sposób, by móc z nich korzystać
zarówno w trybie synchronicznym (działanie programu jest blokowane do
zakończeniu operacji), jak i asynchroniczym (operacja jest rozpoczynana, a do
czasu jej zakończenia program może robić inne rzeczy). Wyjątkiem są \ref dcc
"połączenia bezpośrednie", które pozwalają jedynie na połączenia
asynchroniczne.

W trybie synchronicznym, po udanym zakończeniu funkcji \c gg_login(), należy
w pętli wywoływać funkcję \c gg_watch_fd(), która po odebraniu informacji od
serwera zwróci informację o zdarzeniu w strukturze \c gg_event lub \c NULL 
w przypadku błędu. Lista zdarzeń znajduje się poniżej.

Tryb asynchroniczny wymaga od programu obserwowania zmian na określonych
deskryptorach za pomocą funkcji systemowych \c select() czy \c poll(), lub za
pomocą mechanizmów pętli zdarzeń wbudowanych w wykorzystaną bibliotekę
interfejsu użytkownika. Interesujące z punktu widzeniu połączenia
asynchronicznego pola to \ref gg_session::fd "\c fd"
określające obserwowany deskryptor, pole \ref gg_session::check "\c check"
będące maską bitową typu \ref gg_check_t "\c gg_check_t"
, mówiącą czy obserwowana ma być możliwość odczytu i/lub zapisu oraz
\ref gg_session::timeout "\c timeout"
określające maksymalny czas wykonywania operacji. Gdy zaobserwuje
się zmianę na deskryptorze należy wywołać funkcję \c gg_watch_fd() i postępować
podobnie jak w trybie synchronicznym.

\note Po przekroczeniu czasu określonego w polu \c timeout, należy sprawdzić
wartość flagi \ref gg_session::soft_timeout "\c soft_timeout"
. Jeśli jest równa \c 0 (tj. \c FALSE), można przerwać
połączenie i zwolnić zasoby, a jeśli jest różna (tj. \c TRUE), należy
wywołać \c gg_watch_fd() ustawiając wcześniej
\ref gg_session::timeout "\c timeout"
na \c 0, by dać szansę bibliotece zareagować na przekroczenie
czasu operacji. Za pomocą mechanizmu \c soft_timeout są realizowane próby
połączenia z innymi portami, np. gdy domyślny port 8074 jest zablokowany oraz
zwrotne połączenia bezpośrednie (7.x), gdy jedna ze stron połączenia znajduje
się za routerem NAT lub firewallem.

\note Po zerwaniu połączenia lub nieudanym logowaniu pole \ref
gg_session::state "\c state"
przyjmuje wartość \c GG_STATE_IDLE. Przed dodaniem deskryptora \c fd do listy
obserwowanych, warto w ten sposób sprawdzić, czy dane połączenie nie jest już
nieaktywne.

\note Próba wysłania danych do zamkniętego połączenia (np. zerwanego przez
serwer) w systemach uniksowych powoduje wysłanie sygnału \c SIGPIPE, który
domyślnie powoduje unicestwienie procesu. Dlatego, aby pozwolić bibliotece
zareagować na zerwanie połączenia w sensowny sposób, należy ignorować sygnał
w aplikacji.

\section sync-example Przykład połączenia synchronicznego

\code
struct gg_session *sesja;
struct gg_login_params parametry;
struct gg_event *zdarzenie;

memset(&parametry, 0, sizeof(parametry));
parametry.uin = 12345;
parametry.password = "hasło";

sesja = gg_login(&parametry);

if (!sesja) {
    błąd("Nie można się połączyć");
    exit(1);
}

informacja("Połączono");

gg_send_message(sesja, 23456, "Cześć!");

while ((zdarzenie = gg_watch_fd(sesja))) {
    switch (zdarzenie->type) {
        // ...
    }

    gg_event_free(zdarzenie);
}

gg_logoff(sesja);
gg_free_session(sesja);
\endcode

\note Przykład jest niekompletny, ponieważ powinien wysłać listę kontaktów
i co minutę wywoływać funkcję \c gg_ping().

\section sync-example Przykład połączenia asynchronicznego

\code
struct gg_session *sesja;
struct gg_login_params parametry;
struct timeval tv;
fd_set rd, wd;
int wynik;

memset(&parametry, 0, sizeof(parametry));
parametry.uin = 12345;
parametry.password = "hasło";
parametry.async = 1;

sesja = gg_login(&parametry);

if (!sesja) {
    błąd("Nie można się połączyć");
    exit(1);
}

for (;;) {
    FD_ZERO(&rd);
    FD_ZERO(&wd);

    if ((sesja->check & GG_CHECK_READ))
        FD_SET(sesja->fd, &rd);

    if ((sesja->check & GG_CHECK_WRITE))
        FD_SET(sesja->fd, &wd);

    if (sesja->timeout) {
        tv.tv_sec = sesja->timeout;
        tv.tv_usec = 0;
    }

    wynik = select(sesja->fd + 1, &rd, &wd, NULL, (sesja->timeout) ? &tv : NULL);

    if (!wynik) {
        błąd("Przekroczono czas operacji");
	gg_free_session(sesja);
	exit(1);
    }

    if (wynik == -1) {
        if (errno != EINTR) {
	    błąd("Błąd funkcji select()");
	    gg_free_session(sesja);
	    exit(1);
	}
    }

    if (FD_ISSET(sesja->fd, &rd) || FD_ISSET(sesja->fd, &wd)) {
        struct gg_event *zdarzenie;

	zdarzenie = gg_watch_fd(sesja);

	if (!zdarzenie) {
	    błąd("Połączenie przerwane");
	    gg_free_session(sesja);
	    exit(1);
	}

	switch (zdarzenie->type) {
	    case GG_EVENT_CONN_SUCCESS:
	        informacja("Połączono");
		break;
	    case GG_EVENT_CONN_FAILED:
	        błąd("Nie można się połączyć");
		gg_event_free(zdarzenie);
		gg_free_session(sesja);
		exit(1);
	    // ...
	}

	gg_event_free(zdarzenie);
    }
}
\endcode

\note Przykład jest niekompletny, ponieważ powinien wysłać listę kontaktów
i co minutę wywoływać funkcję \c gg_ping().

\section events-list Zdarzenia

<table>
<tr>
<th>Typ zdarzenia</th>
<th>Pole \c gg_event</th>
<th>Typ pola</th>
<th>Opis</th>
</tr>
<tr>
<td>\c GG_EVENT_NONE</td>
<td>-</td>
<td>-</td>
<td>\copydoc gg_event_t::GG_EVENT_NONE</td>
</tr>
<tr>
<th colspan="4">Zdarzenia związane z połączeniem</th>
</tr>
<tr>
<td>\c GG_EVENT_CONN_SUCCESS</td>
<td>-</td>
<td>-</td>
<td>\copydoc gg_event_t::GG_EVENT_CONN_SUCCESS</td>
</tr>
<tr>
<td>\c GG_EVENT_CONN_FAILED</td>
<td>\c event.failure</td>
<td>\ref gg_failure_t "\c gg_failure_t"
</td>
<td>\copydoc gg_event_t::GG_EVENT_CONN_FAILED</td>
</tr>
<tr>
<td>\c GG_EVENT_PONG</td>
<td>-</td>
<td>-</td>
<td>\copydoc gg_event_t::GG_EVENT_PONG</td>
</tr>
<tr>
<td>\c GG_EVENT_DISCONNECT</td>
<td>-</td>
<td>-</td>
<td>\copydoc gg_event_t::GG_EVENT_DISCONNECT</td>
</tr>
<tr>
<th colspan="4">Wiadomości</th>
</tr>
<tr>
<td>\c GG_EVENT_XML_EVENT</td>
<td>\c event.xml_event</td>
<td>\c gg_event_xml_event</td>
<td>\copydoc gg_event_t::GG_EVENT_XML_EVENT</td>
</tr>
<tr>
<td>\c GG_EVENT_MSG</td>
<td>\c event.msg</td>
<td>\c gg_event_msg</td>
<td>\copydoc gg_event_t::GG_EVENT_MSG</td>
</tr>
<tr>
<td>\c GG_EVENT_ACK</td>
<td>\c event.ack</td>
<td>\c gg_event_ack</td>
<td>\copydoc gg_event_t::GG_EVENT_ACK</td>
</tr>
<tr>
<td>\c GG_EVENT_IMAGE_REQUEST</td>
<td>\c event.image_request</td>
<td>\c gg_event_image_request</td>
<td>\copydoc gg_event_t::GG_EVENT_IMAGE_REQUEST</td>
</tr>
<tr>
<td>\c GG_EVENT_IMAGE_REPLY</td>
<td>\c event.image_reply</td>
<td>\c gg_event_image_reply</td>
<td>\copydoc gg_event_t::GG_EVENT_IMAGE_REPLY</td>
</tr>
<tr>
<th colspan="4">Lista kontaktów</th>
</tr>
<tr>
<td>\c GG_EVENT_NOTIFY</td>
<td>\c event.notify[]</td>
<td>\c gg_notify_reply</td>
<td>\copydoc gg_event_t::GG_EVENT_NOTIFY</td>
</tr>
<tr>
<td>\c GG_EVENT_NOTIFY_DESCR</td>
<td>\c event.notify_descr</td>
<td>\c gg_event_notify_descr</td>
<td>\copydoc gg_event_t::GG_EVENT_NOTIFY_DESCR</td>
</tr>
<tr>
<td>\c GG_EVENT_STATUS</td>
<td>\c event.status</td>
<td>\c gg_event_status</td>
<td>\copydoc gg_event_t::GG_EVENT_STATUS</td>
</tr>
<tr>
<td>\c GG_EVENT_NOTIFY60</td>
<td>\c event.notify60[]</td>
<td>\c gg_event_notify60</td>
<td>\copydoc gg_event_t::GG_EVENT_NOTIFY60</td>
</tr>
<tr>
<td>\c GG_EVENT_STATUS60</td>
<td>\c event.status60</td>
<td>\c gg_event_status60</td>
<td>\copydoc gg_event_t::GG_EVENT_STATUS60</td>
</tr>
<tr>
<td>\c GG_EVENT_USERLIST</td>
<td>\c event.userlist</td>
<td>\c gg_event_userlist</td>
<td>\copydoc gg_event_t::GG_EVENT_USERLIST</td>
</tr>
<tr>
<th colspan="4">Katalog publiczny</th>
</tr>
<tr>
<td>\c GG_EVENT_PUBDIR50_SEARCH_REPLY</td>
<td>\c event.pubdir50</td>
<td>\ref pubdir50 "\c gg_pubdir50_t"
</td>
<td>\copydoc gg_event_t::GG_EVENT_PUBDIR50_SEARCH_REPLY</td>
</tr>
<tr>
<td>\c GG_EVENT_PUBDIR50_READ</td>
<td>\c event.pubdir50</td>
<td>\ref pubdir50 "\c gg_pubdir50_t"
</td>
<td>\copydoc gg_event_t::GG_EVENT_PUBDIR50_READ</td>
</tr>
<tr>
<td>\c GG_EVENT_PUBDIR50_WRITE</td>
<td>\c event.pubdir50</td>
<td>\ref pubdir50 "\c gg_pubdir50_t"
</td>
<td>\copydoc gg_event_t::GG_EVENT_PUBDIR50_WRITE</td>
</tr>
<tr>
<th colspan="4">Połączenia bezpośrednie</th>
</tr>
<tr>
<td>\c GG_EVENT_DCC7_NEW</td>
<td>\c event.dcc7_new</td>
<td>\c gg_dcc7</td>
<td>\copydoc gg_event_t::GG_EVENT_DCC7_NEW</td>
</tr>
<tr>
<td>\c GG_EVENT_DCC7_ACCEPT</td>
<td>\c event.dcc7_accept</td>
<td>\c gg_event_dcc7_accept</td>
<td>\copydoc gg_event_t::GG_EVENT_DCC7_ACCEPT</td>
</tr>
<tr>
<td>\c GG_EVENT_DCC7_REJECT</td>
<td>\c event.dcc7_reject</td>
<td>\c gg_event_dcc7_reject</td>
<td>\copydoc gg_event_t::GG_EVENT_DCC7_REJECT</td>
</tr>
<tr>
<td>\c GG_EVENT_DCC7_ERROR</td>
<td>\c event.dcc7_error</td>
<td>\ref gg_error_t "\c gg_error_t"
</td>
<td>\copydoc gg_event_t::GG_EVENT_DCC7_ERROR</td>
</tr>
</table>

*/