c-icap-doc  0.1
Data Fields
ci_acl_type Struct Reference


This is the struct used to implement an acl type object. More...

#include <acl.h>

Data Fields

char name [MAX_NAME_LEN+1]
 The acl type name.
 
void *(* get_test_data )(struct ci_request *req, char *param)
 
Pointer to the functions which retrieves the test data for this acl type More...
 
void(* free_test_data )(struct ci_request *req, void *data)
 
Pointer to the function which release the acl test data (if required) More...
 
const ci_type_ops_t * type
 
Pointer to the ci_types_ops_t struct which implements basic operations for the acl test data
 

Detailed Description


This is the struct used to implement an acl type object.

Field Documentation

◆ free_test_data

void(* ci_acl_type::free_test_data) (struct ci_request *req, void *data)


Pointer to the function which release the acl test data (if required)

This method releases the acl test data,which allocated using the get_test_data method

Parameters
reqPointer to the related ci_request_t object
dataPointer to allocated test data

◆ get_test_data

void*(* ci_acl_type::get_test_data) (struct ci_request *req, char *param)


Pointer to the functions which retrieves the test data for this acl type

This method extract the test data from request object for this acl object. For example for the "src" acl type this function will extract the icap client ip address

Parameters
reqPointer to the related ci_request_t object
paramSome acl types supports one parameter passed by the c-icap administrator
Returns
A pointer to the test data

The documentation for this struct was generated from the following file: