libgadu
1.12.0-rc3
|
Struktury danych | |
union | gg_event_union |
Unia wszystkich zdarzeń zwracanych przez funkcje gg_watch_fd() , gg_dcc_watch_fd() i gg_dcc7_watch_fd() . Więcej... | |
struct | gg_event |
Opis zdarzenia. Więcej... | |
Funkcje | |
void | gg_event_free (struct gg_event *e) |
Zwalnia pamięć zajmowaną przez informację o zdarzeniu. Więcej... | |
struct gg_event * | gg_watch_fd (struct gg_session *sess) |
Funkcja wywoływana po zaobserwowaniu zmian na deskryptorze sesji. Więcej... | |
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ą połączenia bezpośrednie, które pozwalają jedynie na połączenia asynchroniczne.
W trybie synchronicznym, po udanym zakończeniu funkcji gg_login()
, należy w pętli wywoływać funkcję gg_watch_fd()
, która po odebraniu informacji od serwera zwróci informację o zdarzeniu w strukturze gg_event
lub 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 select()
czy 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 fd
określające obserwowany deskryptor, pole check
będące maską bitową typu gg_check_t
, mówiącą czy obserwowana ma być możliwość odczytu i/lub zapisu oraz timeout
określające maksymalny czas wykonywania operacji. Gdy zaobserwuje się zmianę na deskryptorze należy wywołać funkcję gg_watch_fd()
i postępować podobnie jak w trybie synchronicznym.
timeout
, należy sprawdzić wartość flagi soft_timeout
. Jeśli jest równa 0
(tj. FALSE
), można przerwać połączenie i zwolnić zasoby, a jeśli jest różna (tj. TRUE
), należy wywołać gg_watch_fd()
ustawiając wcześniej timeout
na 0
, by dać szansę bibliotece zareagować na przekroczenie czasu operacji. Za pomocą mechanizmu 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.state
przyjmuje wartość GG_STATE_IDLE
. Przed dodaniem deskryptora fd
do listy obserwowanych, warto w ten sposób sprawdzić, czy dane połączenie nie jest już nieaktywne.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.gg_ping()
.gg_ping()
.Typ zdarzenia | Pole gg_event | Typ pola | Opis |
---|---|---|---|
GG_EVENT_NONE | - | - |
Nie wydarzyło się nic wartego uwagi.
enum gg_check_t |
enum gg_event_t |
Rodzaj zdarzenia.
void gg_event_free | ( | struct gg_event * | e | ) |
Zwalnia pamięć zajmowaną przez informację o zdarzeniu.
Funkcję należy wywoływać za każdym razem gdy funkcja biblioteki zwróci strukturę gg_event
.
e | Struktura zdarzenia |
|
read |
Funkcja wywoływana po zaobserwowaniu zmian na deskryptorze sesji.
Funkcja zwraca strukturę zdarzenia gg_event
. Jeśli rodzaj zdarzenia to GG_EVENT_NONE
, nie wydarzyło się jeszcze nic wartego odnotowania. Strukturę zdarzenia należy zwolnić funkcja gg_event_free()
.
sess | Struktura sesji |
NULL
jeśli wystąpił błąd