Duda I/O: API Documentation

Cookies object

The cookie object provides a set of methods to handle HTTP cookies

Usage 

cookie->method(...);

Methods

cmp()

Compares a cookie value with the given string

Prototype

int cmp(duda_request_t *dr, char *key, char *cmp);
Parameters
dr
the request context information hold by a duda_request_t type
key
the cookie name
cmp
the comparisson string
Return: If the cookie value is equal to the given string, it returns 0. Otherwise it returns -1.

destroy()

It destroy a cookie. This method tells the HTTP client to invalidate the cookie setting up a new expire time based in a past date. The changes should take effect in the next request.

Prototype

int destroy(duda_request_t *dr, char *key, int key_len);
Parameters
dr
the request context information hold by a duda_request_t type
key
the cookie name
key_len
the key string length
Return: Upon successful completion it returns 0, on error it returns -1.

get()

Retrieve a specific cookie value sent by the HTTP client.

Prototype

int get(duda_request_t *dr, char *key, char **val, int *val_len);
Parameters
dr
the request context information hold by a duda_request_t type
key
the cookie name
val
stores the cookie value
val_len
stores the string length of the cookie value
Return: Upon successful completion it returns 0, on error it returns -1.

set()

It creates a new cookie

Prototype

int set(duda_request_t *dr, char *key, int key_len,
        char *val, int val_len, int expires);
Parameters
dr
the request context information hold by a duda_request_t type
key
the cookie name
key_len
the key string length
val
the cookie value
val_len
the value string length
expires
defines the expiration time in unix time seconds. Use value 0 if you dont want to make the cookie expire
Return: Upon successful completion it returns 0, on error it returns -1