c-icap-doc
0.1
|
ICAP request related API.
More...
Macros | |
#define | ci_req_lock_data(req) ((req)->data_locked = 1) |
Lock a ci_request_t object. More... | |
#define | ci_req_unlock_data(req) ((req)->data_locked = 0) |
Unlock a ci_request_t object. More... | |
#define | ci_req_hasbody(req) ((req)->hasbody) |
More... | |
#define | ci_req_type(req) ((req)->type) |
More... | |
#define | ci_req_preview_size(req) ((req)->preview) /*The preview data size*/ |
More... | |
#define | ci_req_allow204(req) ((req)->allow204) |
More... | |
#define | ci_req_allow206(req) ((req)->allow206) |
More... | |
#define | ci_req_allow206_outside_preview(req) ((req)->allow206 && (req)->allow204) |
More... | |
#define | ci_req_sent_data(req) ((req)->status) |
More... | |
#define | ci_req_hasalldata(req) ((req)->eof_received) |
More... | |
Typedefs | |
typedef struct ci_request | ci_request_t |
This is the struct which holds all the data which represent an ICAP request. More... | |
Functions | |
const char * | ci_icap_add_xheader (ci_request_t *req, const char *header) |
Add an icap X-header to the icap response headers More... | |
int | ci_icap_append_xheaders (ci_request_t *req, ci_headers_list_t *headers) |
Append the icap X-headers to the icap response headers More... | |
ICAP request related API.
#define ci_req_allow204 | ( | req | ) | ((req)->allow204) |
req | is pointer to an object of type ci_request_t |
#define ci_req_allow206 | ( | req | ) | ((req)->allow206) |
req | is pointer to an object of type ci_request_t |
#define ci_req_allow206_outside_preview | ( | req | ) | ((req)->allow206 && (req)->allow204) |
req | is pointer to an object of type ci_request_t |
#define ci_req_hasalldata | ( | req | ) | ((req)->eof_received) |
req | is pointer to an object of type ci_request_t |
#define ci_req_hasbody | ( | req | ) | ((req)->hasbody) |
req | is pointer to an object of type ci_request_t |
#define ci_req_lock_data | ( | req | ) | ((req)->data_locked = 1) |
Lock a ci_request_t object.
After called the c-icap server stops sending body data to the ICAP client.
req | is pointer to an object of type ci_request_t |
#define ci_req_preview_size | ( | req | ) | ((req)->preview) /*The preview data size*/ |
req | is pointer to an object of type ci_request_t |
#define ci_req_sent_data | ( | req | ) | ((req)->status) |
req | is pointer to an object of type ci_request_t |
#define ci_req_type | ( | req | ) | ((req)->type) |
#define ci_req_unlock_data | ( | req | ) | ((req)->data_locked = 0) |
Unlock a ci_request_t object.
When called the c-icap server will start sending body data to the ICAP client.
req | is pointer to an object of type ci_request_t |
This is the struct which holds all the data which represent an ICAP request.
The developers should not access directly the fields of this struct but better use the documented macros and functions
const char* ci_icap_add_xheader | ( | ci_request_t * | req, |
const char * | header | ||
) |
Add an icap X-header to the icap response headers
It can be used with both request and response modification ICAP requests.
req | is a pointer to the current ICAP request object. |
header | is the header to add in the form "Header: Value" |
int ci_icap_append_xheaders | ( | ci_request_t * | req, |
ci_headers_list_t * | headers | ||
) |
Append the icap X-headers to the icap response headers
It can be used with both request and response modification ICAP requests.
req | is a pointer to the current ICAP request object. |
headers | is a pointer to the headers object to add |