Generic Extensions API

Classes
struct	extension_daemon_descriptor
struct	EXTENSION_LOGGER_DESCRIPTOR
struct	SERVER_LOG_API
struct	token_t
struct	extension_ascii_protocol_descriptor
struct	SERVER_EXTENSION_API

Typedefs
typedef struct extension_daemon_descriptor	EXTENSION_DAEMON_DESCRIPTOR
typedef struct extension_ascii_protocol_descriptor	EXTENSION_ASCII_PROTOCOL_DESCRIPTOR
typedef EXTENSION_ERROR_CODE(*	MEMCACHED_EXTENSIONS_INITIALIZE )(const char *config, GET_SERVER_API get_server_api)

Enumerations
enum	EXTENSION_ERROR_CODE { EXTENSION_SUCCESS = 0x00, EXTENSION_FATAL = 0xfe, EXTENSION_FAILED = 0xff }
enum	extension_type_t { EXTENSION_DAEMON = 0x00, EXTENSION_LOGGER, EXTENSION_ASCII_PROTOCOL }
enum	EXTENSION_LOG_LEVEL { EXTENSION_LOG_DETAIL, EXTENSION_LOG_DEBUG, EXTENSION_LOG_INFO, EXTENSION_LOG_WARNING }

Detailed Description

Definition of the generic extension API to memcached.

Typedef Documentation

typedef struct extension_ascii_protocol_descriptor EXTENSION_ASCII_PROTOCOL_DESCRIPTOR

ASCII protocol extensions must provide the following descriptor to extend the capabilities of the ascii protocol. The memcached core will probe each command in the order they are registered, so you should register the most likely command to be used first (or you could register only one descriptor and do a better dispatch routine inside your own implementation of accept / execute).

typedef struct extension_daemon_descriptor EXTENSION_DAEMON_DESCRIPTOR

Deamon extensions should provide the following descriptor when they register themselves.

typedef EXTENSION_ERROR_CODE(* MEMCACHED_EXTENSIONS_INITIALIZE)(const char *config, GET_SERVER_API get_server_api)

The signature for the "memcached_extensions_initialize" function exported from the loadable module.

Parameters

config	configuration for this extension
GET_SERVER_API	pointer to a function to get a specific server API from. server_extension_api contains functions to register extensions.

Returns

one of the error codes above.

Definition at line 216 of file extension.h.

Enumeration Type Documentation

enum EXTENSION_ERROR_CODE

Response codes for extension operations.

Enumerator:

EXTENSION_SUCCESS	The command executed successfully
EXTENSION_FATAL	A fatal error occurred, and the server should shut down as soon as possible
EXTENSION_FAILED	Generic failure.

Definition at line 23 of file extension.h.

enum extension_type_t

Enumerator:

EXTENSION_DAEMON	A generic extention that don't provide a functionality to the memcached core, but lives in the memcached address space.
EXTENSION_LOGGER	A log consumer
EXTENSION_ASCII_PROTOCOL	Command extension for the ASCII protocol

Definition at line 33 of file extension.h.