gg_debug

Wyświetla komunikat o danym poziomie, o ile użytkownik sobie tego życzy.

void gg_debug(int level, const char *format, ...);

int level	poziom wiadomości
const char *format...	treść wiadomości (kompatybilna z printf())

Brak.

gg_vsaprintf

Robi dokładnie to samo, co vsprintf(), tyle że alokuje sobie wcześniej miejsce na dane. Powinno działać na tych maszynach, które mają funkcję vsnprintf() zgodną z C99, jak i na wcześniejszych.

char *gg_vsaprintf(const char *format, va_list ap);

const char *format	opis wyświetlanego tekstu jak dla printf()
va_list ap	lista argumentów dla printf()

Zaalokowany bufor, który należy później zwolnić, lub NULL jeśli nie udało się wykonać zadania.

gg_saprintf

Robi dokładnie to samo, co sprintf(), tyle że alokuje sobie wcześniej miejsce na dane. Powinno działać na tych maszynach, które mają funkcję vsnprintf() zgodną z C99, jak i na wcześniejszych.

char *gg_saprintf(const char *format, ...);

const char *format... treść taka sama jak w funkcji printf()

Zaalokowany bufor, który należy później zwolnić, lub NULL jeśli nie udało się wykonać zadania.

gg_get_line

Podaje kolejną linię z bufora tekstowego. Niszczy go bezpowrotnie, dzieląc na kolejne stringi. Zdarza się, nie ma potrzeby pisania funkcji dublującej bufor żeby tylko mieć nieruszone dane wejściowe, skoro i tak nie będą nam poźniej potrzebne. Obcina `\r\n'.

char *gg_get_line(char **ptr);

char **ptr wskaźnik do zmiennej, która przechowuje aktualną pozycję w przemiatanym buforze

Wskaźnik do kolejnej linii tekstu lub NULL, jeśli to już koniec bufora.

gg_connect

Łączy się z serwerem. Pierwszy argument jest typu (void *), żeby nie musieć niczego inkludować w libgadu.h i nie psuć jakiś głupich zależności na dziwnych systemach.

int gg_connect(void *addr, int port, int async);

void *addr	adres serwera (struct in_addr *)
int port	port serwera
int async	asynchroniczne połączenie

Deskryptor gniazda lub -1 w przypadku błędu (kod błędu w zmiennej errno).

gg_read_line

Czyta jedną linię tekstu z gniazda.

char *gg_read_line(int sock, char *buf, int length);

int sock	deskryptor gniazda
char *buf	wskaźnik do bufora
int length	długość bufora

Jeśli trafi na błąd odczytu lub podano nieprawidłowe parametry, zwraca NULL. Inaczej zwraca buf.

gg_chomp

Ucina "\r\n" lub "\n" z końca linii.

void gg_chomp(char *line);

char *line linia do przycięcia

Brak.

gg_urlencode

Zamienia podany tekst na ciąg znaków do formularza http. Przydaje się przy różnych usługach katalogu publicznego.

char *gg_urlencode(const char *str);

const char *str ciąg znaków do zakodowania

Zaalokowany bufor, który należy później zwolnić albo NULL w przypadku błędu.

gg_http_hash

Funkcja licząca hash dla adresu e-mail, hasła i paru innych.

int gg_http_hash(const char *format, ...);

const char *format... format kolejnych parametrów ('s' jeśli dany parametr jest ciągiem znaków lub 'u' jeśli numerem GG)

Hash wykorzystywany przy rejestracji i wszelkich manipulacjach własnego wpisu w katalogu publicznym.

gg_gethostbyname

Odpowiednik gethostbyname() troszczący się o współbieżność, gdy mamy do dyspozycji funkcję gethostbyname_r().

struct in_addr *gg_gethostbyname(const char *hostname);

const char *hostname nazwa serwera

Zwraca wskaźnik na strukturę in_addr, którą należy zwolnić.

gg_win32_thread_socket

Zwraca deskryptor gniazda, które było ostatnio tworzone dla wątku o podanym identyfikatorze.

jeśli na win32 przy połączeniach synchronicznych zapamiętamy w jakim wątku uruchomiliśmy funkcję, która się z czymkolwiek łączy, to z osobnego wątku możemy anulować połączenie poprzez gg_win32_thread_socket(watek, -1);

int gg_win32_thread_socket(int thread_id, int socket);

int thread_id	id wątku. jeśli jest równe 0, brany jest aktualny wątek, jeśli równe -1, usuwa wpis o podanym sockecie.
int socket	deskryptor gniazda. jeśli równe 0, zwraca deskryptor gniazda dla podanego wątku, jeśli równe -1, usuwa wpis, jeśli coś innego, ustawia dla podanego wątku dany numer deskryptora.

Jeśli socket jest równe 0, zwraca deskryptor gniazda dla podanego wątku.

gg_base64_encode

Zapisuje ciąg znaków w base64.

char *gg_base64_encode(const char *buf);

const char *buf ciąg znaków.

Zaalokowany bufor.

gg_base64_decode

Dekoduje ciąg znaków z base64.

char *gg_base64_decode(const char *buf);

const char *buf ciąg znaków.

Zaalokowany bufor.

gg_proxy_auth

Tworzy nagłówek autoryzacji dla proxy.

zaalokowany tekst lub NULL, jeśli proxy nie jest włączone lub nie wymaga autoryzacji.

char *gg_proxy_auth();

Brak.

gg_crc32_make_table

Static void gg_crc32_make_table() { uint32_t h = 1; unsigned int i, j;

memset(gg_crc32_table, 0, sizeof(gg_crc32_table));

for (i = 128; i; i >>= 1) { h = (h >> 1) ^ ((h & 1) ? 0xedb88320L : 0);

for (j = 0; j < 256; j += 2 * i) gg_crc32_table[i + j] = gg_crc32_table[j] ^ h; }

gg_crc32_initialized = 1; }

/* gg_crc32()

wyznacza sumę kontrolną CRC32 danego bloku danych.

uint32_t gg_crc32(uint32_t crc, unsigned char *buf, int len);

uint32_t crc	suma kontrola poprzedniego bloku danych lub 0 jeśli pierwszy
unsigned char *buf	bufor danych
size	ilość danych

Suma kontrolna CRC32.

gg_dcc_request

Wysyła informację o tym, że dany klient powinien się z nami połączyć. Wykorzystywane, kiedy druga strona, której chcemy coś wysłać jest za maskaradą.

int gg_dcc_request(struct gg_session *sess, uin_t uin);

struct gg_session *sess	struktura opisująca sesję GG
uin_t uin	numerek odbiorcy

Patrz gg_send_message_ctcp().

gg_dcc_fill_file_info

Wypełnia pola struct gg_dcc niezbędne do wysłania pliku.

int gg_dcc_fill_file_info(struct gg_dcc *d, const char *filename);

struct gg_dcc *d	struktura opisująca połączenie DCC
const char *filename	nazwa pliku

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_dcc_fill_file_info2

Wypełnia pola struct gg_dcc niezbędne do wysłania pliku.

int gg_dcc_fill_file_info2(struct gg_dcc *d, const char *filename, const char *local_filename);

struct gg_dcc *d	struktura opisująca połączenie DCC
const char *filename	nazwa pliku
const char *local_filename	nazwa na lokalnym systemie plików

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_dcc_get_file

Inicjuje proces odbierania pliku od danego klienta, gdy ten wysłał do nas żądanie połączenia.

struct gg_dcc *gg_dcc_get_file(uint32_t ip, uint16_t port, uin_t my_uin, uin_t peer_uin);

uint32_t ip	adres ip odbiorcy
uint16_t port	port odbiorcy
uin_t my_uin	własny numer
uin_t peer_uin	numer obiorcy

Zaalokowana struct gg_dcc lub NULL jeśli wystąpił błąd.

gg_dcc_send_file

Inicjuje proces wysyłania pliku do danego klienta.

struct gg_dcc *gg_dcc_send_file(uint32_t ip, uint16_t port, uin_t my_uin, uin_t peer_uin);

uint32_t ip	adres ip odbiorcy
uint16_t port	port odbiorcy
uin_t my_uin	własny numer
uin_t peer_uin	numer obiorcy

Zaalokowana struct gg_dcc lub NULL jeśli wystąpił błąd.

gg_dcc_voice_chat

Próbuje nawiązać połączenie głosowe.

struct gg_dcc *gg_dcc_voice_chat(uint32_t ip, uint16_t port, uin_t my_uin, uin_t peer_uin);

uint32_t ip	adres ip odbiorcy
uint16_t port	port odbiorcy
uin_t my_uin	własny numer
uin_t peer_uin	numer obiorcy

Zaalokowana struct gg_dcc lub NULL jeśli wystąpił błąd.

gg_dcc_set_type

Po zdarzeniu GG_EVENT_DCC_CALLBACK należy ustawić typ połączenia za pomocą tej funkcji.

void gg_dcc_set_type(struct gg_dcc *d, int type);

struct gg_dcc *d	struktura opisująca połączenie
int type	typ połączenia (GG_SESSION_DCC_SEND lub GG_SESSION_DCC_VOICE)

Brak.

gg_dcc_socket_create

Tworzy gniazdo dla bezpośredniej komunikacji między klientami.

struct gg_dcc *gg_dcc_socket_create(uin_t uin, uint16_t port);

uin_t uin	własny numer
uint16_t port	preferowany port, jeśli równy 0 lub -1, próbuje domyślnego

Zaalokowana struct gg_dcc, którą poźniej należy zwolnić funkcją gg_dcc_free(), albo NULL jeśli wystąpił błąd.

gg_dcc_voice_send

Wysyła ramkę danych dla rozmowy głosowej.

int gg_dcc_voice_send(struct gg_dcc *d, char *buf, int length);

struct gg_dcc *d	struktura opisująca połączenie dcc
char *buf	bufor z danymi
int length	rozmiar ramki

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_dcc_watch_fd

Funkcja, którą należy wywołać, gdy coś się zmieni na gg_dcc->fd.

struct gg_event *gg_dcc_watch_fd(struct gg_dcc *h);

struct gg_dcc *h struktura zwrócona przez gg_create_dcc_socket()

Zaalokowana struct gg_event lub NULL, jeśli zabrakło pamięci na nią.

gg_dcc_free

Zwalnia pamięć po strukturze połączenia dcc.

void gg_dcc_free(struct gg_dcc *d);

struct gg_dcc *d zwalniana struktura

Brak.

gg_event_free

Zwalnia pamięć zajmowaną przez informację o zdarzeniu.

void gg_event_free(struct gg_event *e);

struct gg_event *e wskaźnik do informacji o zdarzeniu

Brak.

gg_image_queue_remove

Usuwa z kolejki dany wpis.

int gg_image_queue_remove(struct gg_session *s, struct gg_image_queue *q, int freeq);

struct gg_session *s	sesja
struct gg_image_queue *q	kolejka
int freeq	czy zwolnić kolejkę

0/-1

gg_watch_fd

Funkcja, którą należy wywołać, gdy coś się stanie z obserwowanym deskryptorem. Zwraca klientowi informację o tym, co się dzieje.

struct gg_event *gg_watch_fd(struct gg_session *sess);

struct gg_session *sess opis sesji

Wskaźnik do struktury gg_event, którą trzeba zwolnić później za pomocą gg_event_free(). Jesli rodzaj zdarzenia jest równy GG_EVENT_NONE, należy je zignorować. Jeśli zwróciło NULL, stało się coś niedobrego -- albo zabrakło pamięci albo zerwało połączenie.

gg_http_connect

Rozpoczyna połączenie po http.

struct gg_http *gg_http_connect(const char *hostname, int port, int async, const char *method, const char *path, const char *header);

const char *hostname	adres serwera
int port	port serwera
int async	asynchroniczne połączenie
const char *method	metoda http (GET, POST, cokolwiek)
const char *path	ścieżka do zasobu (musi być poprzedzona ,,/'')
const char *header	nagłówek zapytania plus ewentualne dane dla POST

Zaalokowana struct gg_http, którą poźniej należy zwolnić funkcją gg_http_free(), albo NULL jeśli wystąpił błąd.

gg_http_watch_fd

Przy asynchronicznej obsłudze HTTP funkcję tą należy wywołać, jeśli zmieniło się coś na obserwowanym deskryptorze.

int gg_http_watch_fd(struct gg_http *h);

struct gg_http *h struktura opisująca połączenie

Jeśli wszystko poszło dobrze to 0, inaczej -1. Połączenie będzie zakończone, jeśli h->state == GG_STATE_PARSING. Jeśli wystąpi jakiś błąd, to będzie tam GG_STATE_ERROR i odpowiedni kod błędu w h->error.

gg_http_stop

Jeśli połączenie jest w trakcie, przerywa je. Nie zwalnia h->data.

void gg_http_stop(struct gg_http *h);

struct gg_http *h struktura opisująca połączenie

Brak.

gg_http_free_fields

Zwalnia pola struct gg_http, ale nie zwalnia samej struktury.

void gg_http_free_fields(struct gg_http *h);

Brak.

gg_http_free

Próbuje zamknąć połączenie i zwalnia pamięć po nim.

void gg_http_free(struct gg_http *h);

struct gg_http *h struktura, którą należy zlikwidować

Brak.

gg_libgadu_version

Zwraca wersję libgadu.

const char *gg_libgadu_version();

brak

Wersja libgadu.

gg_fix32

Zamienia kolejność bajtów w liczbie 32-bitowej tak, by odpowiadała kolejności bajtów w protokole GG. Ze względu na LE-owość serwera, zamienia tylko na maszynach BE-wych.

uint32_t gg_fix32(uint32_t x);

uint32_t x liczba do zamiany

Liczba z odpowiednią kolejnością bajtów.

gg_fix16

Zamienia kolejność bajtów w liczbie 16-bitowej tak, by odpowiadała kolejności bajtów w protokole GG. Ze względu na LE-owość serwera, zamienia tylko na maszynach BE-wych.

uint16_t gg_fix16(uint16_t x);

uint16_t x liczba do zamiany

Liczba z odpowiednią kolejnością bajtów.

gg_login_hash

Liczy hash z hasła i danego seeda.

unsigned int gg_login_hash(unsigned char *password, unsigned int seed);

unsigned char *password	hasło do hashowania
unsigned int seed	wartość podana przez serwer

Hash.

gg_resolve

Tworzy potok, forkuje się i w drugim procesie zaczyna resolvować podanego hosta. Zapisuje w sesji deskryptor potoku. Jeśli coś tam będzie gotowego, znaczy, że można wczytać struct in_addr. Jeśli nie znajdzie, zwraca INADDR_NONE.

int gg_resolve(int *fd, int *pid, const char *hostname);

int *fd	wskaźnik gdzie wrzucić deskryptor
int *pid	gdzie wrzucić pid procesu potomnego
const char *hostname	nazwa hosta do zresolvowania

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_resolve_pthread_cleanup

Sprząta po wątku resolvera.

void gg_resolve_pthread_cleanup(void *arg, int kill);

void *arg	wskaźnik na strukturę gg_resolve_pthread_data,
int kill	czy zabić wątek resolvera i posprzątać po nim?

Brak.

gg_resolve_pthread

Tworzy potok, nowy wątek i w nim zaczyna resolvować podanego hosta. Zapisuje w sesji deskryptor potoku. Jeśli coś tam będzie gotowego, znaczy, że można wczytać struct in_addr. Jeśli nie znajdzie, zwraca INADDR_NONE.

int gg_resolve_pthread(int *fd, void **resolver, const char *hostname);

int *fd	wskaźnik do zmiennej przechowującej desktyptor resolvera
void **resolver	wskaźnik do wskaźnika resolvera
const char *hostname	nazwa hosta do zresolvowania

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_read

Czyta z gniazda określoną ilość bajtów. Bierze pod uwagę, czy mamy połączenie zwykłe czy TLS.

int gg_read(struct gg_session *sess, char *buf, int length);

struct gg_session *sess	sesja,
char *buf	bufor,
int length	ilość bajtów,

Takie same wartości jak read().

gg_write

Zapisuje do gniazda określoną ilość bajtów. Bierze pod uwagę, czy mamy połączenie zwykłe czy TLS.

int gg_write(struct gg_session *sess, const char *buf, int length);

struct gg_session *sess	sesja,
const char *buf	bufor,
int length	ilość bajtów,

Takie same wartości jak write().

gg_recv_packet

Odbiera jeden pakiet i zwraca wskaźnik do niego. Pamięć po nim należy zwolnić za pomocą free().

void *gg_recv_packet(struct gg_session *sess);

struct gg_session *sess opis sesji

W przypadku błędu NULL, kod błędu w errno. Należy zwrócić uwagę, że gdy połączenie jest nieblokujące, a kod błędu wynosi EAGAIN, nie udało się odczytać całego pakietu i nie należy tego traktować jako błąd.

gg_send_packet

Konstruuje pakiet i wysyła go do serwera.

int gg_send_packet(struct gg_session *sess, int type, ...);

sock	deskryptor gniazda
int type	typ pakietu
payload_1	pierwsza część pakietu
payload_length_1	długość pierwszej części
payload_2	druga część pakietu
payload_length_2	długość drugiej części
...	kolejne części pakietu i ich długości
NULL	końcowym parametr (konieczny!)

Jeśli się powiodło, zwraca 0, w przypadku błędu -1. Jeśli errno == ENOMEM, zabrakło pamięci. Inaczej był błąd przy wysyłaniu pakietu. Dla errno == 0 nie wysłano całego pakietu.

gg_login

Rozpoczyna procedurę łączenia się z serwerem. Resztę obsługuje się przez gg_watch_fd().

UWAGA! program musi obsłużyć SIGCHLD, jeśli łączy się asynchronicznie, żeby poprawnie zamknąć proces resolvera.

struct gg_session *gg_login(const struct gg_login_params *p);

const struct gg_login_params *p struktura opisująca początkowy stan. wymagane pola: uin, password

W przypadku błędu NULL, jeśli idzie dobrze (async) albo poszło dobrze (sync), zwróci wskaźnik do zaalokowanej struct gg_session.

gg_free_session

Próbuje zamknąć połączenia i zwalnia pamięć zajmowaną przez sesję.

void gg_free_session(struct gg_session *sess);

struct gg_session *sess opis sesji

Brak.

gg_change_status

Zmienia status użytkownika. Przydatne do /away i /busy oraz /quit.

int gg_change_status(struct gg_session *sess, int status);

struct gg_session *sess	opis sesji
int status	nowy status użytkownika

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_change_status_descr

Zmienia status użytkownika na opisowy.

int gg_change_status_descr(struct gg_session *sess, int status, const char *descr);

struct gg_session *sess	opis sesji
int status	nowy status użytkownika
const char *descr	opis statusu

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_change_status_descr_time

Zmienia status użytkownika na opisowy z godziną powrotu.

int gg_change_status_descr_time(struct gg_session *sess, int status, const char *descr, int time);

struct gg_session *sess	opis sesji
int status	nowy status użytkownika
const char *descr	opis statusu
int time	czas w formacie uniksowym

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_logoff

Wylogowuje użytkownika i zamyka połączenie, ale nie zwalnia pamięci.

void gg_logoff(struct gg_session *sess);

struct gg_session *sess opis sesji

Brak.

gg_image_request

Wysyła żądanie wysłania obrazka o podanych parametrach.

int gg_image_request(struct gg_session *sess, uin_t recipient, int size, uint32_t crc32);

struct gg_session *sess	opis sesji
uin_t recipient	numer adresata
int size	rozmiar obrazka
uint32_t crc32	suma kontrolna obrazka

0/-1

gg_image_reply

Wysyła żądany obrazek.

int gg_image_reply(struct gg_session *sess, uin_t recipient, const char *filename, const char *image, int size);

struct gg_session *sess	opis sesji
uin_t recipient	numer adresata
const char *filename	nazwa pliku
const char *image	bufor z obrazkiem
int size	rozmiar obrazka

0/-1

gg_send_message_ctcp

Wysyła wiadomość do innego użytkownika. Zwraca losowy numer sekwencyjny, który można zignorować albo wykorzystać do potwierdzenia.

int gg_send_message_ctcp(struct gg_session *sess, int msgclass, uin_t recipient, unsigned char *message, int message_len);

struct gg_session *sess	opis sesji
int msgclass	rodzaj wiadomości
uin_t recipient	numer adresata
unsigned char *message	treść wiadomości
int message_len	długość

Numer sekwencyjny wiadomości lub -1 w przypadku błędu.

gg_send_message

Wysyła wiadomość do innego użytkownika. Zwraca losowy numer sekwencyjny, który można zignorować albo wykorzystać do potwierdzenia.

int gg_send_message(struct gg_session *sess, int msgclass, uin_t recipient, unsigned char *message);

struct gg_session *sess	opis sesji
int msgclass	rodzaj wiadomości
uin_t recipient	numer adresata
unsigned char *message	treść wiadomości

Numer sekwencyjny wiadomości lub -1 w przypadku błędu.

gg_send_message_richtext

Wysyła kolorową wiadomość do innego użytkownika. Zwraca losowy numer sekwencyjny, który można zignorować albo wykorzystać do potwierdzenia.

int gg_send_message_richtext(struct gg_session *sess, int msgclass, uin_t recipient, unsigned char *message, unsigned char *format, int formatlen);

struct gg_session *sess	opis sesji
int msgclass	rodzaj wiadomości
uin_t recipient	numer adresata
unsigned char *message	treść wiadomości
unsigned char *format	informacje o formatowaniu
int formatlen	długość informacji o formatowaniu

Numer sekwencyjny wiadomości lub -1 w przypadku błędu.

gg_send_message_confer

Wysyła wiadomość do kilku użytkownikow (konferencja). Zwraca losowy numer sekwencyjny, który można zignorować albo wykorzystać do potwierdzenia.

int gg_send_message_confer(struct gg_session *sess, int msgclass, int recipients_count, uin_t *recipients, unsigned char *message);

struct gg_session *sess	opis sesji
int msgclass	rodzaj wiadomości
int recipients_count	ilość adresatów
uin_t *recipients	numerki adresatów
unsigned char *message	treść wiadomości

Numer sekwencyjny wiadomości lub -1 w przypadku błędu.

gg_send_message_confer_richtext

Wysyła kolorową wiadomość do kilku użytkownikow (konferencja). Zwraca losowy numer sekwencyjny, który można zignorować albo wykorzystać do potwierdzenia.

int gg_send_message_confer_richtext(struct gg_session *sess, int msgclass, int recipients_count, uin_t *recipients, unsigned char *message, unsigned char *format, int formatlen);

struct gg_session *sess	opis sesji
int msgclass	rodzaj wiadomości
int recipients_count	ilość adresatów
uin_t *recipients	numerki adresatów
unsigned char *message	treść wiadomości
unsigned char *format	informacje o formatowaniu
int formatlen	długość informacji o formatowaniu

Numer sekwencyjny wiadomości lub -1 w przypadku błędu.

gg_ping

Wysyła do serwera pakiet ping.

int gg_ping(struct gg_session *sess);

struct gg_session *sess opis sesji

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_notify_ex

Wysyła serwerowi listę kontaktów (wraz z odpowiadającymi im typami userów), dzięki czemu wie, czyj stan nas interesuje.

int gg_notify_ex(struct gg_session *sess, uin_t *userlist, char *types, int count);

struct gg_session *sess	opis sesji
uin_t *userlist	wskaźnik do tablicy numerów
char *types	wskaźnik do tablicy typów użytkowników
int count	ilość numerków

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_notify

Wysyła serwerowi listę kontaktów, dzięki czemu wie, czyj stan nas interesuje.

int gg_notify(struct gg_session *sess, uin_t *userlist, int count);

struct gg_session *sess	opis sesji
uin_t *userlist	wskaźnik do tablicy numerów
int count	ilość numerków

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_add_notify_ex

Dodaje do listy kontaktów dany numer w trakcie połączenia. Dodawanemu użytkownikowi określamy jego typ (patrz protocol.html)

int gg_add_notify_ex(struct gg_session *sess, uin_t uin, char type);

struct gg_session *sess	opis sesji
uin_t uin	numer
char type	typ

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_add_notify

Dodaje do listy kontaktów dany numer w trakcie połączenia.

int gg_add_notify(struct gg_session *sess, uin_t uin);

struct gg_session *sess	opis sesji
uin_t uin	numer

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_remove_notify_ex

Usuwa z listy kontaktów w trakcie połączenia. Usuwanemu użytkownikowi określamy jego typ (patrz protocol.html)

int gg_remove_notify_ex(struct gg_session *sess, uin_t uin, char type);

struct gg_session *sess	opis sesji
uin_t uin	numer
char type	typ

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_remove_notify

Usuwa z listy kontaktów w trakcie połączenia.

int gg_remove_notify(struct gg_session *sess, uin_t uin);

struct gg_session *sess	opis sesji
uin_t uin	numer

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_userlist_request

Wysyła żądanie/zapytanie listy kontaktów na serwerze.

int gg_userlist_request(struct gg_session *sess, char type, const char *request);

struct gg_session *sess	opis sesji
char type	rodzaj zapytania/żądania
const char *request	treść zapytania/żądania (może być NULL)

0 jeśli operacja się powiodła, -1 w przypadku błędu.

gg_register3

Rozpoczyna rejestrację użytkownika protokołem GG 6.0. Wymaga wcześniejszego pobrania tokenu za pomocą funkcji gg_token().

struct gg_http *gg_register3(const char *email, const char *password, const char *tokenid, const char *tokenval, int async);

const char *email	adres e-mail klienta
const char *password	hasło klienta
const char *tokenid	identyfikator tokenu
const char *tokenval	wartość tokenu
int async	połączenie asynchroniczne

Zaalokowana struct gg_http, którą poźniej należy zwolnić funkcją gg_register_free(), albo NULL jeśli wystąpił błąd.

gg_unregister3

Usuwa konto użytkownika z serwera protokołem GG 6.0

struct gg_http *gg_unregister3(uin_t uin, const char *password, const char *tokenid, const char *tokenval, int async);

uin_t uin	numerek GG
const char *password	hasło klienta
const char *tokenid	identyfikator tokenu
const char *tokenval	wartość tokenu
int async	połączenie asynchroniczne

Zaalokowana struct gg_http, którą poźniej należy zwolnić funkcją gg_unregister_free(), albo NULL jeśli wystąpił błąd.

gg_change_passwd4

Wysyła żądanie zmiany hasła zgodnie z protokołem GG 6.0. Wymaga wcześniejszego pobrania tokenu za pomocą funkcji gg_token().

struct gg_http *gg_change_passwd4(uin_t uin, const char *email, const char *passwd, const char *newpasswd, const char *tokenid, const char *tokenval, int async);

uin_t uin	numer
const char *email	adres e-mail
const char *passwd	stare hasło
const char *newpasswd	nowe hasło
const char *tokenid	identyfikator tokenu
const char *tokenval	wartość tokenu
int async	połączenie asynchroniczne

Zaalokowana struct gg_http, którą poźniej należy zwolnić funkcją gg_change_passwd_free(), albo NULL jeśli wystąpił błąd.

gg_remind_passwd3

Wysyła żądanie przypomnienia hasła e-mailem.

struct gg_http *gg_remind_passwd3(uin_t uin, const char *email, const char *tokenid, const char *tokenval, int async);

uin_t uin	numer
const char *email	adres e-mail taki, jak ten zapisany na serwerze
int async	połączenie asynchroniczne
const char *tokenid	identyfikator tokenu
const char *tokenval	wartość tokenu

Zaalokowana struct gg_http, którą poźniej należy zwolnić funkcją gg_remind_passwd_free(), albo NULL jeśli wystąpił błąd.

gg_pubdir_watch_fd

Przy asynchronicznych operacjach na katalogu publicznym należy wywoływać tę funkcję przy zmianach na obserwowanym deskryptorze.

int gg_pubdir_watch_fd(struct gg_http *h);

struct gg_http *h struktura opisująca połączenie

Jeśli wszystko poszło dobrze to 0, inaczej -1. Operacja będzie zakończona, jeśli h->state == GG_STATE_DONE. Jeśli wystąpi jakiś błąd, to będzie tam GG_STATE_ERROR i odpowiedni kod błędu w h->error.

gg_pubdir_free

Zwalnia pamięć po efektach operacji na katalogu publicznym.

void gg_pubdir_free(struct gg_http *h);

struct gg_http *h zwalniana struktura

Brak.

gg_token

Pobiera z serwera token do autoryzacji zakładania konta, usuwania konta i zmiany hasła.

zaalokowana struct gg_http, którą poźniej należy zwolnić funkcją gg_token_free(), albo NULL jeśli wystąpił błąd.

struct gg_http *gg_token(int async);

Brak.

gg_token_watch_fd

Przy asynchronicznych operacjach związanych z tokenem należy wywoływać tę funkcję przy zmianach na obserwowanym deskryptorze.

int gg_token_watch_fd(struct gg_http *h);

struct gg_http *h struktura opisująca połączenie

gg_token_free

Zwalnia pamięć po efektach pobierania tokenu.

void gg_token_free(struct gg_http *h);

struct gg_http *h zwalniana struktura

Brak.

gg_pubdir50_new

Tworzy nową zmienną typu gg_pubdir50_t.

zaalokowana zmienna lub NULL w przypadku braku pamięci.

gg_pubdir50_t gg_pubdir50_new(int type);

Brak.

gg_pubdir50_add

Funkcja dodaje pole do zapytania.

int gg_pubdir50_add(gg_pubdir50_t req, const char *field, const char *value);

gg_pubdir50_t req	wskaźnik opisu zapytania,
const char *field	nazwa pola,
const char *value	wartość pola,

0/-1

gg_pubdir50_seq_set

Ustawia numer sekwencyjny zapytania.

int gg_pubdir50_seq_set(gg_pubdir50_t req, uint32_t seq);

gg_pubdir50_t req	zapytanie,
uint32_t seq	nowy numer sekwencyjny.

0/-1.

gg_pubdir50_free

Zwalnia pamięć po zapytaniu lub rezultacie szukania użytkownika.

void gg_pubdir50_free(gg_pubdir50_t s);

gg_pubdir50_t s zwalniana zmienna,

Brak.

gg_pubdir50

Wysyła zapytanie katalogu publicznego do serwera.

uint32_t gg_pubdir50(struct gg_session *sess, gg_pubdir50_t req);

struct gg_session *sess	sesja,
gg_pubdir50_t req	zapytanie.

Numer sekwencyjny wyszukiwania lub 0 w przypadku błędu.

gg_pubdir50_handle_reply

Analizuje przychodzący pakiet odpowiedzi i zapisuje wynik w struct gg_event.

int gg_pubdir50_handle_reply(struct gg_event *e, const char *packet, int length);

struct gg_event *e	opis zdarzenia
const char *packet	zawartość pakietu odpowiedzi
int length	długość pakietu odpowiedzi

0/-1

gg_pubdir50_get

Pobiera informację z rezultatu wyszukiwania.

const char *gg_pubdir50_get(gg_pubdir50_t res, int num, const char *field);

gg_pubdir50_t res	rezultat wyszukiwania,
int num	numer odpowiedzi,
const char *field	nazwa pola (wielkość liter nie ma znaczenia).

Wartość pola lub NULL, jeśli nie znaleziono.

gg_pubdir50_count

Zwraca ilość wyników danego zapytania.

int gg_pubdir50_count(gg_pubdir50_t res);

gg_pubdir50_t res odpowiedź

Ilość lub -1 w przypadku błędu.

gg_pubdir50_type

Zwraca rodzaj zapytania lub odpowiedzi.

int gg_pubdir50_type(gg_pubdir50_t res);

gg_pubdir50_t res zapytanie lub odpowiedź

Ilość lub -1 w przypadku błędu.

gg_pubdir50_next

Zwraca numer, od którego należy rozpocząć kolejne wyszukiwanie, jeśli zależy nam na kolejnych wynikach.

uin_t gg_pubdir50_next(gg_pubdir50_t res);

gg_pubdir50_t res odpowiedź

Numer lub -1 w przypadku błędu.

gg_pubdir50_seq

Zwraca numer sekwencyjny zapytania lub odpowiedzi.

uint32_t gg_pubdir50_seq(gg_pubdir50_t res);

gg_pubdir50_t res zapytanie lub odpowiedź

Numer lub -1 w przypadku błędu.