Classes
struct	apr_redis_server_t

struct	apr_redis_t

struct	apr_redis_stats_t

Typedefs
typedef struct apr_redis_conn_t	apr_redis_conn_t

typedef struct apr_redis_server_t	apr_redis_server_t

typedef struct apr_redis_t	apr_redis_t

typedef apr_uint32_t(*	apr_redis_hash_func) (void baton, const char data, const apr_size_t data_len)

typedef apr_redis_server_t (	apr_redis_server_func) (void baton, apr_redis_t rc, const apr_uint32_t hash)

Enumerations
enum	apr_redis_server_status_t { APR_RC_SERVER_LIVE , APR_RC_SERVER_DEAD }

enum	apr_redis_server_role_t { APR_RS_SERVER_MASTER , APR_RS_SERVER_SLAVE , APR_RS_SERVER_UNKNOWN }

Functions
	APU_DECLARE (apr_uint32_t) apr_redis_hash(apr_redis_t *rc

	APU_DECLARE (apr_redis_server_t ) apr_redis_find_server_hash(apr_redis_t rc

	APU_DECLARE (apr_status_t) apr_redis_add_server(apr_redis_t *rc

Variables
const char *	data

const char const apr_size_t	data_len

const apr_uint32_t	hash

apr_redis_t *	rc

apr_redis_server_t *	server

const char *	host

const char apr_port_t	port

apr_redis_server_t *	rs

const char apr_port_t apr_uint32_t	min

const char apr_port_t apr_uint32_t apr_uint32_t	smax

const char apr_port_t apr_uint32_t apr_uint32_t apr_uint32_t	max

const char apr_port_t apr_uint32_t apr_uint32_t apr_uint32_t apr_uint32_t	ttl

const char apr_port_t apr_uint32_t apr_uint32_t apr_uint32_t apr_uint32_t apr_uint32_t	rwto

const char apr_port_t apr_uint32_t apr_uint32_t apr_uint32_t apr_uint32_t apr_uint32_t apr_redis_server_t **	ns

apr_uint16_t	max_servers

apr_uint16_t apr_uint32_t	flags

apr_pool_t *	p

apr_pool_t const char *	key

apr_pool_t const char char **	baton

apr_pool_t const char char apr_size_t *	len

const char char const apr_size_t	data_size

const char char const apr_size_t apr_uint32_t	timeout

const char apr_int32_t	inc

const char apr_int32_t apr_uint32_t *	new_value

apr_pool_t *	temp_pool

apr_pool_t apr_pool_t *	data_pool

apr_pool_t apr_pool_t apr_hash_t *	values

apr_pool_t apr_redis_stats_t **	stats

Detailed Description

Typedef Documentation

◆ apr_redis_conn_t

typedef struct apr_redis_conn_t apr_redis_conn_t

Opaque redis client connection object

Definition at line 71 of file apr_redis.h.

◆ apr_redis_hash_func

typedef apr_uint32_t(* apr_redis_hash_func) (void *baton, const char *data, const apr_size_t data_len)

Definition at line 107 of file apr_redis.h.

◆ apr_redis_server_func

typedef apr_redis_server_t *(* apr_redis_server_func) (void *baton, apr_redis_t *rc, const apr_uint32_t hash)

Definition at line 115 of file apr_redis.h.

◆ apr_redis_server_t

typedef struct apr_redis_server_t apr_redis_server_t

Redis Server Info Object

Definition at line 74 of file apr_redis.h.

◆ apr_redis_t

typedef struct apr_redis_t apr_redis_t

Definition at line 100 of file apr_redis.h.

Enumeration Type Documentation

◆ apr_redis_server_role_t

enum apr_redis_server_role_t

Enumerator
APR_RS_SERVER_MASTER	Server is a master
APR_RS_SERVER_SLAVE	Server is a slave
APR_RS_SERVER_UNKNOWN	Server role is unknown

Definition at line 373 of file apr_redis.h.

◆ apr_redis_server_status_t

enum apr_redis_server_status_t

Specifies the status of a redis server

Enumerator
APR_RC_SERVER_LIVE	Server is alive and responding to requests
APR_RC_SERVER_DEAD	Server is not responding to requests

Definition at line 64 of file apr_redis.h.

Function Documentation

◆ APU_DECLARE() [1/3]

APU_DECLARE ( apr_redis_server_t * )

Picks a server based on a hash

Parameters

rc	The redis client object to use
hash	Hashed value of a Key

Returns: server that controls specified hash

See also: apr_redis_hash

server selection compatible with the standard Perl Client.

Finds a Server object based on a hostname/port pair

Parameters

rc	The redis client object to use
host	Hostname of the server
port	Port of the server

Returns: Server with matching Hostname and Port, or NULL if none was found.

◆ APU_DECLARE() [2/3]

APU_DECLARE ( apr_status_t )

Adds a server to a client object

Parameters

rc	The redis client object to use
server	Server to add

Remarks: Adding servers is not thread safe, and should be done once at startup.

Warning: Changing servers after startup may cause keys to go to different servers.

Enables a Server for use again

Parameters

rc	The redis client object to use
rs	Server to Activate

Disable a Server

Parameters

rc	The redis client object to use
rs	Server to Disable

Creates a new Server Object

Parameters

p	Pool to use
host	hostname of the server
port	port of the server
min	minimum number of client sockets to open
smax	soft maximum number of client connections to open
max	hard maximum number of client connections
ttl	time to live in microseconds of a client connection
rwto	r/w timeout value in seconds of a client connection
ns	location of the new server object

See also: apr_reslist_create

Remarks: min, smax, and max are only used when APR_HAS_THREADS

Creates a new redisd client object

Parameters

p	Pool to use
max_servers	maximum number of servers
flags	Not currently used
rc	location of the new redis client object

Gets a value from the server, allocating the value out of p

Parameters

rc	client to use
p	Pool to use
key	null terminated string containing the key
baton	location of the allocated value
len	length of data at baton
flags	any flags set by the client for this key

Returns

Sets a value by key on the server

Parameters

rc	client to use
key	null terminated string containing the key
baton	data to store on the server
data_size	length of data at baton
flags	any flags set by the client for this key

Sets a value by key on the server

Parameters

rc	client to use
key	null terminated string containing the key
baton	data to store on the server
data_size	length of data at baton
timeout	time in seconds for the data to live on the server
flags	any flags set by the client for this key

Deletes a key from a server

Parameters

rc	client to use
key	null terminated string containing the key
timeout	time for the delete to stop other clients from adding

Query a server's version

Parameters

rs	server to query
p	Pool to allocate answer from
baton	location to store server version string

Query a server's INFO

Parameters

rs	server to query
p	Pool to allocate answer from
baton	location to store server INFO response string

Increments a value

Parameters

rc	client to use
key	null terminated string containing the key
inc	number to increment by
new_value	new value after incrementing

Decrements a value

Parameters

rc	client to use
key	null terminated string containing the key
inc	number to decrement by
new_value	new value after decrementing

Pings the server

Parameters

rs	Server to ping

Gets multiple values from the server, allocating the values out of p

Parameters

rc	client to use
temp_pool	Pool used for temporary allocations. May be cleared inside this call.
data_pool	Pool used to allocate data for the returned values.
values	hash of apr_redis_value_t keyed by strings, contains the result of the multiget call.

Returns

Query a server for statistics

Parameters

rs	server to query
p	Pool to allocate answer from
stats	location of the new statistics structure

< Shared lock. More than one process or thread can hold a shared lock at any given time. Essentially, this is a "read lock", preventing writers from establishing an exclusive lock.

< Exclusive lock. Only one process may hold an exclusive lock at any given time. This is analogous to a "write lock".

< Replace

< Insert with duplicates

< Shared lock. More than one process or thread can hold a shared lock at any given time. Essentially, this is a "read lock", preventing writers from establishing an exclusive lock.

< mask to extract lock type

< Shared lock. More than one process or thread can hold a shared lock at any given time. Essentially, this is a "read lock", preventing writers from establishing an exclusive lock.

< Exclusive lock. Only one process may hold an exclusive lock at any given time. This is analogous to a "write lock".

< Size of the file

< Shared lock. More than one process or thread can hold a shared lock at any given time. Essentially, this is a "read lock", preventing writers from establishing an exclusive lock.

< Exclusive lock. Only one process may hold an exclusive lock at any given time. This is analogous to a "write lock".

Definition at line 358 of file apr_brigade.c.