KLone i LibU – różne funkcje

Spis treści

 
Używane do dostępu do wszystkich informacji powiązanych do bieżącego żądania HTTP tj.: zmienne formularza, ciasteczka, pola nagłówka HTTP, załadowane pliki, itd.
char * request_get_addr(request) wyświetla adres IP i port na którym jest uruchomiony serwer Klone
char * request_get_arg(request,"variable") funkcja pobiera wartość zmiennej variable przez metodę GET lub POST. Funkcja niezalecana
char * request_get_client_request(request) wyświetla linię żądania
int * request_get_content_length(request) podaje długość żądania POST
const char * request_get_cookie(request, const char *name) pobiera wartość z danego ciasteczka
char * request_get_field_value(request,"pole") pobiera wartość pola nagłówka HTTP
char * request_get_filename(request) pobiera ścieżkę wyświetlanego pliku
char * request_get_getarg(request,"variable") funkcja pobiera wartość zmiennej variable przez metodę GET
int * request_get_method(request) podaje metodę żądania w postaci liczby(0 – metoda nieznana, 1 – GET, 2 – HEAD, 3 – POST, 4 – PUT, 5 – DELETE)
time_t request_get_if_modified_since(request) pobiera czas z pola żądania
const char * request_get_path_info(request) pobiera pole info ścieżki (może być NULL)
char * request_get_peer_addr(request) wyświetla adres IP i port klienta, który wywołał stronę
char * request_get_postarg(request,"variable") funkcja pobiera wartość zmiennej variable przez metodę POST
char * request_get_protocol(request) pobiera protokół używany przez żądanie klienta w formie numerycznej
char * request_get_resolved_filename(request) pobiera nazwę rozwiązanego pliku żądania
const char * request_get_resolved_path_info(request) pobiera info o rozwiązanej ścieżce
int request_get_uploaded_file(request, const char *name, size_t idx, char local_filename[U_FILENAME_MAX], char client_filename[U_FILENAME_MAX], char mime_type[MIME_TYPE_BUFSZ], size_t *file_size) pobiera info i uchwyty do załadowanych plików
char * request_get_uri(request) funkcja pobiera wywołane URI(/nazwa_pliku?string_GET)
char * request_get_query_string(request)  funkcja pobiera wszystkie zmienne i wartości metody GET i POST i łączy je za pomocą "&"
Ten obiekt pozwala tobie na dostęp i modyfikację pozycji odpowiedzi HTTP, tj. pola nagłówka i kody statusu.
int * response_del_field(response,"pole") usuwa dane pole z nagłówka
int * response_disable_caching(response) wyłącza buforowanie
int * response_enable_caching(response) usuwa wszystkie nagłówki, które hamują buforowanie. Włącza buforowanie
int response_get_method(response) pobiera metodę odpowiedzi
int * response_get_status(response) pobiera status HTTP strony
int * response_print_header(response) wyświetla stopkę serwera
int response_redirect(response, const char *url) przekierowuje do danego adresu URL
int * response_set_content_encoding(response, "kodowanie") ustawia kodowanie strony
int * response_set_content_length(response,rozmiar) ustawia rozmiar w nagłówku zawartości strony
int * response_set_content_type(response, "mime type") ustawia typ MIME "mime type" danego pliku
int response_set_cookie(response, const char *name, const char *value, time_t expire, const char *path, const char *domain, int secure) ustawia ciasteczka pod podaną zmienną i z podaną wartością. Opcjami dodatkowymi są: czas trwania ciasteczka, ścieżka, domena i bezpieczeństwo
int * response_set_date(response, data) ustawia datę strony
int * response_set_field(response,"pole", "wartość") ustawia wartość danego pola w nagłówku
int * response_set_last_modified(response, time) ustawia datę ostatniej modyfikacji strony
void response_set_method(response, metoda) ustawia metodę odpowiedzi
int * response_set_status(response, status) ustawia status HTTP(liczba)
Sesje są obiektami, które mogą być używane do zachowywania informacji o kliencie przez kolejne późniejsze dostępy. Proste funkcje są dostarczane ustawiania/pobierania pary {nazwa,wartość}.
int session_age(session) pobiera liczbę sekund, przez jaką sesja była nieaktywna
int session_clean(session) usuwa wszystkie zmienne i wartości z sesji
int session_del(session, const char *name) usuwa daną zmienną z sesji
const char * session_get(session, const char *name) pobiera wartość zmiennej z sesji
const char * session_get_id(session) pobiera ID sesji
int session_set(session, const char *name, const char *value) ustawia wartość danej zmiennej w sesji
Wyjściowy obiekt jest używany do wyświetlania wygenerowanej zawartości dynamicznej.
int io_close(out) zamyka podany obiekt io
int io_codec_add_head(out, codec_t *c) wstawia kodek w nagłówku łańcucha kodeku
int io_codec_add_tail(out, codec_t *c) dołącza kodek do łańcucha kodeku
int io_codecs_remove(out) czyści, usuwa i zwalnia wszystkie kodeku w łańcuchu kodeka
ssize_t io_copy(io_t *out, io_t *in, size_t size) kopiuje block danych pomiędzy dwoma obiektami io
int io_dup(out, io_t **pio) powiela uchwyt IO
ssize_t io_flush(out) czyści bufor zapisu
int io_free(out) uwalnia obiekt io
ssize_t io_getc(out, char *pc) czyta znak z obiektu io_t
ssize_t io_get_until(out, char stop_at, char *buf, size_t size) czyta daną ilość danych dopóki nie znajdzie podanego znaku
ssize_t io_gets(out, char *buf, size_t size) czytaj linię z obiektu io_t
int io_name_get(out, char *name, size_t sz) zwraca nazwę podanego obiektu io_t
int io_name_set(out, const char *name)  ustawia nazwę obiektu io_t
void io_printf(out,"",…) funkcja podobna do printf(), która pozwala na wyświetlenie danych z kodu C/C++ do strumienia wyjściowego
ssize_t io_putc(out, char c) zapis znaku do obiektu io_t
ssize_t io_read(out, char *buf, size_t size) czyta blok danych z obiektu io_t
ssize_t io_seek(out, size_t off) przesuwa się do podanej pozycji w io
ssize_t io_tell(out) zwraca bieżącą pozycję pliku
enum io_type_e io_type(out) zwraca typ podanego io
ssize_t io_vprintf(out, const char *fmt, va_list ap) zapisuje łańcuch znaków do io użwając printf va_list
ssize_t io_write(out, const char *buf, size_t size) zapis bloku danych do obiektu io_t
   
Nie wytłumaczone:
vars_t * request_get_args(request) pobiera listę zmiennych żądania (używającego metody GET lub POST)
vars_t * request_get_cookies(request) pobiera listę ciasteczek [ cookies ]
field_t * request_get_field(request, const char *name) pobiera pole nagłówka
vars_t * request_get_getargs(request) pobiera listę zmiennych żądania używającego metody GET
header_t * request_get_header(request) zwraca obiekt nagłówka
http_t * request_get_http(request) pobiera uchwyt żądania serwera HTTP
vars_t * request_get_postargs(request) pobiera listę zmiennych żądania używającego metody POST
vars_t * request_get_uploads(request) pobiera listę zmiennych załadowanych plików
io_t * request_io(request) pobiera obiekt io_t powiązany z obiektem żądania
header_t * response_get_header(response) pobiera nagłówek odpowiedzi
io_t * response_io(response) pobiera obiekt wejścia/wyjścia odpowiedzi
vars_t * session_get_vars(session) pobiera zmienne sesji