Sesja Gadu-Gadu. Więcej...
#include <libgadu.h>
Pola danych | |
| int | fd |
| Obserwowany deskryptor. | |
| int | check |
| Informacja o żądaniu odczytu/zapisu (patrz gg_check_t) | |
| int | state |
| Aktualny stan połączenia (patrz gg_state_t) | |
| int | error |
Kod błędu dla GG_STATE_ERROR (patrz gg_error_t) | |
| int | type |
| Rodzaj sesji (patrz gg_session_t) | |
| int | id |
| Identyfikator sesji. | |
| int | timeout |
| Czas pozostały do zakończenia stanu. | |
| int(* | callback )(struct gg_session *) |
| Funkcja zwrotna. | |
| void(* | destroy )(struct gg_session *) |
| Funkcja zwalniania zasobów. | |
| int | async |
| Flaga połączenia asynchronicznego. | |
| int | pid |
| Numer procesu rozwiązującego nazwę serwera. | |
| int | port |
| Port serwera. | |
| int | seq |
| Numer sekwencyjny ostatniej wiadomości. | |
| int | last_pong |
| Czas otrzymania ostatniej ramki utrzymaniowej. | |
| int | last_event |
| Czas otrzymania ostatniego pakietu. | |
| struct gg_event * | event |
Zdarzenie po wywołaniu callback. | |
| uint32_t | proxy_addr |
| Adres serwera pośredniczącego. | |
| uint16_t | proxy_port |
| Port serwera pośredniczącego. | |
| uint32_t | hub_addr |
| Adres huba po rozwiązaniu nazwy. | |
| uint32_t | server_addr |
| Adres serwera otrzymany od huba. | |
| uint32_t | client_addr |
| Adres gniazda dla połączeń bezpośrednich. | |
| uint16_t | client_port |
| Port gniazda dla połączeń bezpośrednich. | |
| uint32_t | external_addr |
| Publiczny adres dla połączeń bezpośrednich. | |
| uint16_t | external_port |
| Publiczny port dla połączeń bezpośrednich. | |
| uin_t | uin |
| Własny numer Gadu-Gadu. | |
| char * | password |
| Hasło (zwalniane po użyciu) | |
| int | initial_status |
| Początkowy status. | |
| int | status |
| Aktualny status. | |
| char * | recv_buf |
| Bufor na odbierane pakiety. | |
| int | recv_done |
| Liczba wczytanych bajtów pakietu. | |
| int | recv_left |
| Liczba pozostałych do wczytania bajtów pakietu. | |
| int | protocol_version |
| Wersja protokołu (bez flag) | |
| char * | client_version |
| Wersja klienta. | |
| int | last_sysmsg |
| Numer ostatniej wiadomości systemowej. | |
| char * | initial_descr |
| Początkowy opis statusu. | |
| void * | resolver |
| Dane prywatne procesu lub wątku rozwiązującego nazwę serwera. | |
| void * | ssl |
| Struktura TLS. | |
| void * | ssl_ctx |
| Kontekst sesji TLS. | |
| int | image_size |
| Maksymalny rozmiar obsługiwanych obrazków w KiB. | |
| char * | userlist_reply |
| Bufor z odbieraną listą kontaktów. | |
| int | userlist_blocks |
| Liczba części listy kontaktów. | |
| struct gg_image_queue * | images |
| Lista wczytywanych obrazków. | |
| int | hash_type |
Rodzaj funkcji skrótu hasła (GG_LOGIN_HASH_GG32 lub GG_LOGIN_HASH_SHA1) | |
| char * | send_buf |
| Bufor z danymi do wysłania. | |
| int | send_left |
| Liczba bajtów do wysłania. | |
| struct gg_dcc7 * | dcc7_list |
| Lista połączeń bezpośrednich skojarzonych z sesją | |
| int | soft_timeout |
Flaga mówiąca, że po przekroczeniu timeout należy wywołać gg_watch_fd() | |
| int | protocol_flags |
| Flagi protokołu. | |
| gg_encoding_t | encoding |
| Rodzaj kodowania znaków. | |
| gg_resolver_t | resolver_type |
| Sposób rozwiązywania nazw serwerów. | |
| int(* | resolver_start )(int *fd, void **private_data, const char *hostname) |
| Funkcja rozpoczynająca rozwiązywanie nazwy. | |
| void(* | resolver_cleanup )(void **private_data, int force) |
| Funkcja zwalniająca zasoby po rozwiązaniu nazwy. | |
| int | protocol_features |
| Opcje protokołu. | |
| int | status_flags |
| Flagi statusu. | |
| int | recv_msg_count |
| Liczba odebranych wiadomości. | |
| const char * | resolver_host |
| Nazwa do rozwiązania. | |
| struct in_addr * | resolver_result |
| Wynik rozwiązywania nazwy. | |
| unsigned int | resolver_index |
| Indeks aktualnie obsługiwanego wyniku rozwiązywania nazwy. | |
| unsigned int | resolver_count |
| Liczba wyników rozwiązywania nazwy. | |
| uint16_t | connect_port [2] |
| Lista portów do połączenia. | |
| unsigned int | connect_index |
| Indeks aktualnie obsługiwanego portu. | |
| char * | connect_host |
| Adres serwera Gadu-Gadu, z którym się łączymy. | |
| gg_ssl_t | ssl_flag |
| Flaga połączenia szyfrowanego. | |
| struct gg_session_private * | private_data |
| Prywatne dane sesji, nie udostępnione w API. | |
Opis szczegółowy
Sesja Gadu-Gadu.
Tworzona przez funkcję gg_login(), zwalniana przez gg_free_session().
Dokumentacja pól
◆ fd
| int fd |
Obserwowany deskryptor.
◆ check
| int check |
Informacja o żądaniu odczytu/zapisu (patrz gg_check_t)
◆ state
| int state |
Aktualny stan połączenia (patrz gg_state_t)
◆ error
| int error |
Kod błędu dla GG_STATE_ERROR (patrz gg_error_t)
◆ type
| int type |
Rodzaj sesji (patrz gg_session_t)
◆ id
| int id |
Identyfikator sesji.
◆ timeout
| int timeout |
Czas pozostały do zakończenia stanu.
◆ callback
| int(* callback) (struct gg_session *) |
Funkcja zwrotna.
◆ destroy
| void(* destroy) (struct gg_session *) |
Funkcja zwalniania zasobów.
◆ async
| int async |
Flaga połączenia asynchronicznego.
◆ pid
| int pid |
Numer procesu rozwiązującego nazwę serwera.
◆ port
| int port |
Port serwera.
◆ seq
| int seq |
Numer sekwencyjny ostatniej wiadomości.
◆ last_pong
| int last_pong |
Czas otrzymania ostatniej ramki utrzymaniowej.
◆ last_event
| int last_event |
Czas otrzymania ostatniego pakietu.
◆ event
| struct gg_event* event |
Zdarzenie po wywołaniu callback.
◆ proxy_addr
| uint32_t proxy_addr |
Adres serwera pośredniczącego.
◆ proxy_port
| uint16_t proxy_port |
Port serwera pośredniczącego.
◆ hub_addr
| uint32_t hub_addr |
Adres huba po rozwiązaniu nazwy.
◆ server_addr
| uint32_t server_addr |
Adres serwera otrzymany od huba.
◆ client_addr
| uint32_t client_addr |
Adres gniazda dla połączeń bezpośrednich.
◆ client_port
| uint16_t client_port |
Port gniazda dla połączeń bezpośrednich.
◆ external_addr
| uint32_t external_addr |
Publiczny adres dla połączeń bezpośrednich.
◆ external_port
| uint16_t external_port |
Publiczny port dla połączeń bezpośrednich.
◆ uin
| uin_t uin |
Własny numer Gadu-Gadu.
◆ password
| char* password |
Hasło (zwalniane po użyciu)
◆ initial_status
| int initial_status |
Początkowy status.
◆ status
| int status |
Aktualny status.
◆ recv_buf
| char* recv_buf |
Bufor na odbierane pakiety.
Wskaźnik zawsze maksymalnie wyrównany, tak jak w wyniku działania malloc().
◆ recv_done
| int recv_done |
Liczba wczytanych bajtów pakietu.
◆ recv_left
| int recv_left |
Liczba pozostałych do wczytania bajtów pakietu.
◆ protocol_version
| int protocol_version |
Wersja protokołu (bez flag)
◆ client_version
| char* client_version |
Wersja klienta.
◆ last_sysmsg
| int last_sysmsg |
Numer ostatniej wiadomości systemowej.
◆ initial_descr
| char* initial_descr |
Początkowy opis statusu.
◆ resolver
| void* resolver |
Dane prywatne procesu lub wątku rozwiązującego nazwę serwera.
◆ ssl
| void* ssl |
Struktura TLS.
◆ ssl_ctx
| void* ssl_ctx |
Kontekst sesji TLS.
◆ image_size
| int image_size |
Maksymalny rozmiar obsługiwanych obrazków w KiB.
◆ userlist_reply
| char* userlist_reply |
Bufor z odbieraną listą kontaktów.
◆ userlist_blocks
| int userlist_blocks |
Liczba części listy kontaktów.
◆ images
| struct gg_image_queue* images |
Lista wczytywanych obrazków.
◆ hash_type
| int hash_type |
Rodzaj funkcji skrótu hasła (GG_LOGIN_HASH_GG32 lub GG_LOGIN_HASH_SHA1)
◆ send_buf
| char* send_buf |
Bufor z danymi do wysłania.
◆ send_left
| int send_left |
Liczba bajtów do wysłania.
◆ dcc7_list
| struct gg_dcc7* dcc7_list |
Lista połączeń bezpośrednich skojarzonych z sesją
◆ soft_timeout
| int soft_timeout |
Flaga mówiąca, że po przekroczeniu timeout należy wywołać gg_watch_fd()
◆ protocol_flags
| int protocol_flags |
Flagi protokołu.
◆ encoding
| gg_encoding_t encoding |
Rodzaj kodowania znaków.
◆ resolver_type
| gg_resolver_t resolver_type |
Sposób rozwiązywania nazw serwerów.
◆ resolver_start
| int(* resolver_start) (int *fd, void **private_data, const char *hostname) |
Funkcja rozpoczynająca rozwiązywanie nazwy.
◆ resolver_cleanup
| void(* resolver_cleanup) (void **private_data, int force) |
Funkcja zwalniająca zasoby po rozwiązaniu nazwy.
◆ protocol_features
| int protocol_features |
Opcje protokołu.
◆ status_flags
| int status_flags |
Flagi statusu.
◆ recv_msg_count
| int recv_msg_count |
Liczba odebranych wiadomości.
◆ resolver_host
| const char* resolver_host |
Nazwa do rozwiązania.
◆ resolver_result
| struct in_addr* resolver_result |
Wynik rozwiązywania nazwy.
◆ resolver_index
| unsigned int resolver_index |
Indeks aktualnie obsługiwanego wyniku rozwiązywania nazwy.
◆ resolver_count
| unsigned int resolver_count |
Liczba wyników rozwiązywania nazwy.
◆ connect_port
| uint16_t connect_port[2] |
Lista portów do połączenia.
◆ connect_index
| unsigned int connect_index |
Indeks aktualnie obsługiwanego portu.
◆ connect_host
| char* connect_host |
Adres serwera Gadu-Gadu, z którym się łączymy.
◆ ssl_flag
| gg_ssl_t ssl_flag |
Flaga połączenia szyfrowanego.
◆ private_data
| struct gg_session_private* private_data |
Prywatne dane sesji, nie udostępnione w API.
Dokumentacja dla tej struktury została wygenerowana z pliku:
