ap_socache

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_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)
typedef struct ap_socache_provider_t	ap_socache_provider_t

Detailed Description

Macro Definition Documentation

AP_SOCACHE_DEFAULT_PROVIDER

#define AP_SOCACHE_DEFAULT_PROVIDER   "default"

Default provider name.

AP_SOCACHE_FLAG_NOTMPSAFE

#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.

AP_SOCACHE_PROVIDER_GROUP

#define AP_SOCACHE_PROVIDER_GROUP   "socache"

The provider group used to register socache providers.

AP_SOCACHE_PROVIDER_VERSION

#define AP_SOCACHE_PROVIDER_VERSION   "0"

The provider version used to register socache providers.

Typedef Documentation

ap_socache_instance_t

typedef struct ap_socache_instance_t ap_socache_instance_t

A cache instance.

ap_socache_iterator_t

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

instance	The cache instance
s	Associated server context (for logging)
userctx	User defined pointer passed from the iterator call
id	Unique ID for the object (binary blob) with a trailing null char for convenience
idlen	Length of id blob
data	Output buffer to place retrieved data (binary blob) with a trailing null char for convenience
datalen	Length of data buffer
pool	Pool 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

ap_socache_provider_t

typedef struct ap_socache_provider_t ap_socache_provider_t

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