Apache2
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Collaboration diagram for ap_socache:

Data Structures

struct  ap_socache_hints
 
struct  ap_socache_provider_t
 

Macros

#define AP_SOCACHE_FLAG_NOTMPSAFE   (0x0001)
 
#define AP_SOCACHE_PROVIDER_GROUP   "socache"
 
#define AP_SOCACHE_PROVIDER_VERSION   "0"
 
#define AP_SOCACHE_DEFAULT_PROVIDER   "default"
 

Typedefs

typedef struct
ap_socache_instance_t 
ap_socache_instance_t
 
typedef apr_status_tap_socache_iterator_t )(ap_socache_instance_t *instance, server_rec *s, void *userctx, const unsigned char *id, unsigned int idlen, const unsigned char *data, unsigned int datalen, apr_pool_t *pool)
 
typedef struct
ap_socache_provider_t 
ap_socache_provider_t
 

Detailed Description

Macro Definition Documentation

#define AP_SOCACHE_DEFAULT_PROVIDER   "default"

Default provider name.

#define AP_SOCACHE_FLAG_NOTMPSAFE   (0x0001)

If this flag is set, the store/retrieve/remove/status interfaces of the provider are NOT safe to be called concurrently from multiple processes or threads, and an external global mutex must be used to serialize access to the provider.

#define AP_SOCACHE_PROVIDER_GROUP   "socache"

The provider group used to register socache providers.

#define AP_SOCACHE_PROVIDER_VERSION   "0"

The provider version used to register socache providers.

Typedef Documentation

A cache instance.

typedef apr_status_t( ap_socache_iterator_t)(ap_socache_instance_t *instance, server_rec *s, void *userctx, const unsigned char *id, unsigned int idlen, const unsigned char *data, unsigned int datalen, apr_pool_t *pool)

Iterator callback prototype for the ap_socache_provider_t->iterate() method

Parameters
instanceThe cache instance
sAssociated server context (for logging)
userctxUser defined pointer passed from the iterator call
idUnique ID for the object (binary blob) with a trailing null char for convenience
idlenLength of id blob
dataOutput buffer to place retrieved data (binary blob) with a trailing null char for convenience
datalenLength of data buffer
poolPool for temporary allocations
Returns
APR status value; return APR_SUCCESS or the iteration will halt; this value is returned to the ap_socache_provider_t->iterate() caller

A socache provider structure. socache providers are registered with the ap_provider.h interface using the AP_SOCACHE_PROVIDER_* constants.