#include <server_api.h>

Public Attributes
int(*	get_socket_fd )(const void *cookie)
void(*	get_auth_data )(const void cookie, auth_data_t data)
void(*	store_engine_specific )(const void cookie, void engine_data)
void (	get_engine_specific )(const void *cookie)
void(*	notify_io_complete )(const void *cookie, ENGINE_ERROR_CODE status)
void(*	set_tap_nack_mode )(const void *cookie, bool enable)
void(*	reserve )(const void *cookie)
void(*	release )(const void *cookie)

Detailed Description

Commands to operate on a specific cookie.

Definition at line 83 of file server_api.h.

Member Data Documentation

void(* SERVER_COOKIE_API::get_auth_data)(const void *cookie, auth_data_t *data)

Get the auth data for the connection associated with the given cookie.

Parameters

cookie	The cookie provided by the frontend
data	Pointer to auth_data_t structure for returning the values

Definition at line 101 of file server_api.h.

void*(* SERVER_COOKIE_API::get_engine_specific)(const void *cookie)

Retrieve engine-specific session data for the given cookie.

Parameters

cookie The cookie provided by the frontend

Returns: the data provied by store_engine_specific or NULL if none was provided

Definition at line 124 of file server_api.h.

int(* SERVER_COOKIE_API::get_socket_fd)(const void *cookie)

Retrieve socket file descriptor of the session for the given cookie.

Parameters

cookie The cookie provided by the frontend

Returns: the socket file descriptor of the session for the given cookie.

Definition at line 91 of file server_api.h.

void(* SERVER_COOKIE_API::notify_io_complete)(const void *cookie, ENGINE_ERROR_CODE status)

Let a connection know that IO has completed.

Parameters

cookie	cookie representing the connection
status	the status for the io operation

Definition at line 131 of file server_api.h.

void(* SERVER_COOKIE_API::release)(const void *cookie)

Notify the core that we're releasing the reference to the The engine is not allowed to use the cookie (the core may invalidate the memory)

Definition at line 156 of file server_api.h.

void(* SERVER_COOKIE_API::reserve)(const void *cookie)

Notify the core that we're holding on to this cookie for future use. (The core guarantees it will not invalidate the memory until the cookie is invalidated by calling release())

Definition at line 149 of file server_api.h.

void(* SERVER_COOKIE_API::set_tap_nack_mode)(const void *cookie, bool enable)

Enable or disable automatic generation of a negative ACK message for a TAP message (even if the request didn't have tap ack flag set)

Parameters

cookie	cookie representing the connection
enabel	true to enable, false to disable

Definition at line 142 of file server_api.h.

void(* SERVER_COOKIE_API::store_engine_specific)(const void *cookie, void *engine_data)

Store engine-specific session data on the given cookie.

The engine interface allows for a single item to be attached to the connection that it can use to track connection-specific data throughout duration of the connection.

Parameters

cookie	The cookie provided by the frontend
engine_data	pointer to opaque data

Definition at line 114 of file server_api.h.

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

plugin/innodb_memcached/daemon_memcached/include/memcached/server_api.h

Public Attributes

Detailed Description

Member Data Documentation