Dokumentacja pliku common.c

Funkcje wykorzystywane przez różne moduły biblioteki. Więcej...

Funkcje
char *	gg_vsaprintf (const char *format, va_list ap)
char *	gg_saprintf (const char *format,...)
char *	gg_get_line (char **ptr)
char *	gg_read_line (int sock, char *buf, int length)
int	gg_connect (void *addr, int port, int async)
void	gg_chomp (char *line)
char *	gg_urlencode (const char *str)
int	gg_http_hash (const char *format,...)
char *	gg_base64_encode (const char *buf)
char *	gg_base64_decode (const char *buf)
char *	gg_proxy_auth (void)
uint32_t	gg_crc32 (uint32_t crc, const unsigned char *buf, int len)
	Wyznacza sumę kontrolną CRC32. Więcej...

Zmienne
static char	gg_base64_charset []
static const uint32_t	gg_crc32_table [256]

Opis szczegółowy

Funkcje wykorzystywane przez różne moduły biblioteki.

Dokumentacja funkcji

char* gg_get_line

(

char **

ptr

)

Pobiera linię tekstu z bufora.

Funkcja niszczy bufor źródłowy bezpowrotnie, dzieląc go na kolejne ciągi znaków i obcina znaki końca linii.

Parametry

ptr	Wskaźnik do zmiennej, która przechowuje aktualne położenie w analizowanym buforze

Zwraca

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

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

Czyta linię tekstu z gniazda.

Funkcja czyta tekst znak po znaku, więc nie jest efektywna, ale dzięki brakowi buforowania, nie koliduje z innymi funkcjami odczytu.

Parametry

sock	Deskryptor gniazda
buf	Wskaźnik do bufora
length	Długość bufora

Zwraca

Zwraca buf jeśli się powiodło, lub NULL w przypadku błędu.

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

Wyznacza skrót dla usług HTTP.

Funkcja jest wykorzystywana do wyznaczania skrótu adresu e-mail, hasła i innych wartości przekazywanych jako parametry usług HTTP.

W parametrze format należy umieścić znaki określające postać kolejnych parametrów: 's' jeśli parametr jest ciągiem znaków, 'u' jeśli jest liczbą.

Parametry

format

Format kolejnych parametrów (niezgodny z printf)

Zwraca

Wartość skrótu

char* gg_proxy_auth

(

void

)

Tworzy nagłówek autoryzacji serwera pośredniczącego.

Dane pobiera ze zmiennych globalnych gg_proxy_username i gg_proxy_password.

Zwraca

Zaalokowany bufor z tekstem lub NULL, jeśli serwer pośredniczący nie jest używany lub nie wymaga autoryzacji.

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

Wyznacza sumę kontrolną CRC32.

Parametry

crc	Suma kontrola poprzedniego bloku danych lub 0 jeśli liczona jest suma kontrolna pierwszego bloku
buf	Bufor danych
len	Długość bufora danych

Zwraca

Suma kontrolna.

Dokumentacja zmiennych

char gg_base64_charset[]

static

Wartość początkowa:

=
        "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"

Zestaw znaków kodowania base64.

const uint32_t gg_crc32_table[256]

static

Tablica pomocnicza do wyznaczania sumy kontrolnej.