#include <redis_string.hpp>

类 acl::redis_string 继承关系图:

acl::redis_string 的协作图:

Public 成员函数
	redis_string (void)

	redis_string (redis_client *conn)

	redis_string (redis_client_cluster *cluster)

	redis_string (redis_client_pipeline *pipeline)

ACL_CPP_DEPRECATED	redis_string (redis_client_cluster *cluster, size_t max_conns)

virtual	~redis_string (void)

bool	set (const char key, const char value)

bool	set (const char key, size_t key_len, const char value, size_t value_len)

bool	set (const char key, const char value, int timeout, int flag)

bool	set (const char key, size_t key_len, const char value, size_t value_len, int timeout, int flag)

bool	setex (const char key, const char value, int timeout)

bool	setex (const char key, size_t key_len, const char value, size_t value_len, int timeout)

bool	psetex (const char key, const char value, int timeout)

bool	psetex (const char key, size_t key_len, const char value, size_t value_len, int timeout)

int	setnx (const char key, const char value)

int	setnx (const char key, size_t key_len, const char value, size_t value_len)

int	append (const char key, const char value)

int	append (const char key, const char value, size_t size)

bool	get (const char *key, size_t len, string &buf)

bool	get (const char *key, string &buf)

const redis_result *	get (const char *key)

const redis_result *	get (const char *key, size_t len)

bool	getset (const char key, const char value, string &buf)

bool	getset (const char key, size_t key_len, const char value, size_t value_len, string &buf)

int	get_strlen (const char *key)

int	get_strlen (const char *key, size_t key_len)

int	setrange (const char key, unsigned offset, const char value)

int	setrange (const char key, size_t key_len, unsigned offset, const char value, size_t value_len)

bool	getrange (const char *key, int start, int end, string &buf)

bool	getrange (const char *key, size_t key_len, int start, int end, string &buf)

bool	setbit_ (const char *key, unsigned offset, bool bit)

bool	setbit_ (const char *key, size_t len, unsigned offset, bool bit)

bool	getbit (const char *key, unsigned offset, int &bit)

bool	getbit (const char *key, size_t len, unsigned offset, int &bit)

int	bitcount (const char *key)

int	bitcount (const char *key, size_t len)

int	bitcount (const char *key, int start, int end)

int	bitcount (const char *key, size_t len, int start, int end)

int	bitop_and (const char *destkey, const std::vector< string > &keys)

int	bitop_and (const char destkey, const std::vector< const char > &keys)

int	bitop_and (const char destkey, const char key,...)

int	bitop_and (const char destkey, const char keys[], size_t size)

int	bitop_or (const char *destkey, const std::vector< string > &keys)

int	bitop_or (const char destkey, const std::vector< const char > &keys)

int	bitop_or (const char destkey, const char key,...)

int	bitop_or (const char destkey, const char keys[], size_t size)

int	bitop_xor (const char *destkey, const std::vector< string > &keys)

int	bitop_xor (const char destkey, const std::vector< const char > &keys)

int	bitop_xor (const char destkey, const char key,...)

int	bitop_xor (const char destkey, const char keys[], size_t size)

bool	mset (const std::map< string, string > &objs)

bool	mset (const std::vector< string > &keys, const std::vector< string > &values)

bool	mset (const char keys[], const char values[], size_t argc)

bool	mset (const char keys[], const size_t keys_len[], const char values[], const size_t values_len[], size_t argc)

int	msetnx (const std::map< string, string > &objs)

int	msetnx (const std::vector< string > &keys, const std::vector< string > &values)

int	msetnx (const char keys[], const char values[], size_t argc)

int	msetnx (const char keys[], const size_t keys_len[], const char values[], const size_t values_len[], size_t argc)

bool	mget (const std::vector< string > &keys, std::vector< string > *out=NULL)

bool	mget (const std::vector< const char * > &keys, std::vector< string > *out=NULL)

bool	mget (std::vector< string > result, const char first_key,...)

bool	mget (const char keys[], size_t argc, std::vector< string > out=NULL)

bool	mget (const char keys[], const size_t keys_len[], size_t argc, std::vector< string > out=NULL)

bool	incr (const char key, long long int result=NULL)

bool	incrby (const char key, long long int inc, long long int result=NULL)

bool	incrbyfloat (const char key, double inc, double result=NULL)

bool	decr (const char key, long long int result=NULL)

bool	decrby (const char key, long long int dec, long long int result=NULL)

Public 成员函数继承自 acl::redis_command
	redis_command (void)

	redis_command (redis_client *conn)

	redis_command (redis_client_cluster *cluster)

ACL_CPP_DEPRECATED	redis_command (redis_client_cluster *cluster, size_t max_conns)

	redis_command (redis_client_pipeline *pipeline)

virtual	~redis_command (void)

void	set_check_addr (bool on)

void	clear (bool save_slot=false)

void	reset (bool save_slot=false)

void	set_client (redis_client *conn)

redis_client *	get_client (void) const

const char *	get_client_addr (void) const

void	set_cluster (redis_client_cluster *cluster)

ACL_CPP_DEPRECATED void	set_cluster (redis_client_cluster *cluster, size_t max_conns)

redis_client_cluster *	get_cluster (void) const

void	set_pipeline (redis_client_pipeline *pipeline, bool use_mbox=true)

redis_client_pipeline *	get_pipeline (void) const

dbuf_pool *	get_dbuf (void) const

redis_result_t	result_type (void) const

const char *	result_status (void) const

const char *	result_error (void) const

size_t	result_size (void) const

int	result_number (bool *success=NULL) const

long long int	result_number64 (bool *success=NULL) const

const char *	get_result (size_t i, size_t *len=NULL) const

bool	eof (void) const

const redis_result *	get_result (void) const

const redis_result *	result_child (size_t i) const

const char *	result_value (size_t i, size_t *len=NULL) const

void	set_slice_request (bool on)

void	set_slice_respond (bool on)

const redis_result *	request (size_t argc, const char *argv[], size_t lens[], size_t nchild=0)

const redis_result *	request (const std::vector< string > &args, size_t nchild=0)

const string *	request_buf (void) const

void	build_request (size_t argc, const char *argv[], size_t lens[])

void	hash_slot (const char *key)

void	hash_slot (const char *key, size_t len)

int	get_slot (void) const

bool	is_check_addr (void) const

const char *	get_addr (const char *info)

void	set_client_addr (const char *addr)

void	set_client_addr (redis_client &conn)

redis_request *	get_request_obj (void) const

string *	get_request_buf (void) const

bool	is_slice_req (void) const

redis_pipeline_message &	get_pipeline_message (void)

额外继承的成员函数
静态 Public 成员函数继承自 acl::redis_command
static void	build_request (size_t argc, const char *argv[], size_t lens[], string &out)

Protected 成员函数继承自 acl::redis_command
const redis_result *	run (size_t nchild=0, int *timeout=NULL)

void	clear_request (void)

const redis_result **	scan_keys (const char cmd, const char key, int &cursor, size_t &size, const char pattern, const size_t count)

const redis_result **	scan_keys (const char cmd, const char key, size_t klen, int &cursor, size_t &size, const char pattern, const size_t count)

void	build (const char cmd, const char key, const std::map< string, string > &attrs)

void	build (const char cmd, const char key, size_t klen, const std::map< string, string > &attrs)

void	build (const char cmd, const char key, const std::map< string, const char * > &attrs)

void	build (const char cmd, const char key, const std::vector< string > &names, const std::vector< string > &values)

void	build (const char cmd, const char key, size_t klen, const std::vector< string > &names, const std::vector< string > &values)

void	build (const char cmd, const char key, const std::vector< const char * > &names, const std::vector< const char * > &values)

void	build (const char cmd, const char key, const char names[], const char values[], size_t argc)

void	build (const char cmd, const char key, const int names[], const char *values[], size_t argc)

void	build (const char cmd, const char key, const char names[], const size_t names_len[], const char values[], const size_t values_len[], size_t argc)

void	build (const char cmd, const char key, size_t klen, const char names[], const size_t names_len[], const char values[], const size_t values_len[], size_t argc)

void	build (const char cmd, const char key, const std::vector< string > &names)

void	build (const char cmd, const char key, size_t klen, const std::vector< string > &names)

void	build (const char cmd, const char key, const std::vector< const char * > &names)

void	build (const char cmd, const char key, const std::vector< int > &names)

void	build (const char cmd, const char key, const char *names[], size_t argc)

void	build (const char cmd, const char key, const char *names[], const size_t lens[], size_t argc)

void	build (const char cmd, const char key, size_t klen, const char *names[], const size_t lens[], size_t argc)

void	build (const char cmd, const char key, const int names[], size_t argc)

int	get_number (bool *success=NULL)

long long int	get_number64 (bool *success=NULL)

int	get_number (std::vector< int > &out)

int	get_number64 (std::vector< long long int > &out)

bool	check_status (const char *success="OK")

int	get_status (std::vector< bool > &out)

const char *	get_status (void)

int	get_string (string &buf)

int	get_string (string *buf)

int	get_string (char *buf, size_t size)

int	get_strings (std::vector< string > &result)

int	get_strings (std::vector< string > *result)

int	get_strings (std::list< string > &result)

int	get_strings (std::list< string > *result)

int	get_strings (std::map< string, string > &result)

int	get_strings (std::vector< string > &names, std::vector< string > &values)

int	get_strings (std::vector< const char * > &names, std::vector< const char * > &values)

void	argv_space (size_t n)

void	build_request1 (size_t argc, const char *argv[], size_t lens[])

void	build_request2 (size_t argc, const char *argv[], size_t lens[])

void	logger_result (const redis_result *result)

Protected 成员函数继承自 acl::acl::noncopyable
	noncopyable ()

	~noncopyable ()

Protected 属性继承自 acl::redis_command
dbuf_pool *	dbuf_

bool	check_addr_

char	addr_ [32]

redis_client *	conn_

redis_client_cluster *	cluster_

redis_client_pipeline *	pipeline_

bool	pipe_use_mbox_

int	slot_

int	redirect_max_

int	redirect_sleep_

bool	slice_req_

string *	request_buf_

redis_request *	request_obj_

size_t	argv_size_

const char **	argv_

size_t *	argv_lens_

size_t	argc_

bool	slice_res_

redis_pipeline_message *	pipe_msg_

const redis_result *	result_

详细描述

所有的字符串对象的命令都已实现 all the commands in redis Strings are be implemented.

在文件 redis_string.hpp 第 16 行定义.

构造及析构函数说明

◆ redis_string() [1/5]

acl::redis_string::redis_string ( void )

see redis_command::redis_command()

◆ redis_string() [2/5]

acl::redis_string::redis_string ( redis_client * conn )

see redis_command::redis_command(redis_client*)

◆ redis_string() [3/5]

acl::redis_string::redis_string ( redis_client_cluster * cluster )

see redis_command::redis_command(redis_client_cluster*)

◆ redis_string() [4/5]

acl::redis_string::redis_string ( redis_client_pipeline * pipeline )

◆ redis_string() [5/5]

ACL_CPP_DEPRECATED acl::redis_string::redis_string	(	redis_client_cluster *	cluster,
		size_t	max_conns
	)

◆ ~redis_string()

virtual acl::redis_string::~redis_string ( void )

virtual

成员函数说明

◆ append() [1/2]

int acl::redis_string::append	(	const char *	key,
		const char *	value
	)

如果 key 已经存在并且是一个字符串， APPEND 命令将 value 追加到 key 原来的值的末尾；如果 key 不存在， APPEND 就简单地将给定 key 设为 value append a value to a key

参数

key	{const char*} 字符串对象的 key the key of a string
value	{const char*} 字符串对象的值 the value to be appended to a key

返回: {int} 返回当前该字符串的长度，-1 表示出错或 key 非字符串对象 return the length of the string after appending, -1 if error happened or the key's object isn't a string

◆ append() [2/2]

int acl::redis_string::append	(	const char *	key,
		const char *	value,
		size_t	size
	)

◆ bitcount() [1/4]

int acl::redis_string::bitcount ( const char * key )

计算给定字符串中，被设置为 1 的比特位的数量，若指定了 start/end，则计数在指定区间内进行 count set bits in a string

参数

key	{const char*} 字符串对象的 key the key of a string

返回: {int} 标志位为 1 的数量，-1 表示出错或非字符串对象 the count of bits been set, -1 if error happened or it's not a string

◆ bitcount() [2/4]

int acl::redis_string::bitcount	(	const char *	key,
		size_t	len
	)

◆ bitcount() [3/4]

int acl::redis_string::bitcount	(	const char *	key,
		int	start,
		int	end
	)

◆ bitcount() [4/4]

int acl::redis_string::bitcount	(	const char *	key,
		size_t	len,
		int	start,
		int	end
	)

◆ bitop_and() [1/4]

int acl::redis_string::bitop_and	(	const char *	destkey,
		const std::vector< string > &	keys
	)

对一个或多个 key 求逻辑并，并将结果保存到 destkey BITOP AND on multiple source keys and save the result to another key

参数

destkey	{const char*} 目标字符串对象的 key the key storing the result
keys	源字符串对象集合 the source keys

返回: {int} 存储在目标 key 中的字符串的长度 the size of the string stored in the destination key, that is equal to the size of the longest input string

◆ bitop_and() [2/4]

int acl::redis_string::bitop_and	(	const char *	destkey,
		const std::vector< const char * > &	keys
	)

◆ bitop_and() [3/4]

int acl::redis_string::bitop_and	(	const char *	destkey,
		const char *	key,
			...
	)

◆ bitop_and() [4/4]

int acl::redis_string::bitop_and	(	const char *	destkey,
		const char *	keys[],
		size_t	size
	)

◆ bitop_or() [1/4]

int acl::redis_string::bitop_or	(	const char *	destkey,
		const std::vector< string > &	keys
	)

对一个或多个 key 求逻辑或，并将结果保存到 destkey BITOP OR on multiple source keys and save the result to another key

参数

destkey	{const char*} 目标字符串对象的 key the destination key
keys	源字符串对象集合 the source keys

返回: {int} the size of the string stored in the destination key

◆ bitop_or() [2/4]

int acl::redis_string::bitop_or	(	const char *	destkey,
		const std::vector< const char * > &	keys
	)

◆ bitop_or() [3/4]

int acl::redis_string::bitop_or	(	const char *	destkey,
		const char *	key,
			...
	)

◆ bitop_or() [4/4]

int acl::redis_string::bitop_or	(	const char *	destkey,
		const char *	keys[],
		size_t	size
	)

◆ bitop_xor() [1/4]

int acl::redis_string::bitop_xor	(	const char *	destkey,
		const std::vector< string > &	keys
	)

对一个或多个 key 求逻辑异或，并将结果保存到 destkey BITOP XOR on multiple source keys and save the result to another key

参数

destkey	{const char*} 目标字符串对象的 key the destination key
keys	源字符串对象集合 the source keys

返回: {int} the size of the string stored in the destination key

◆ bitop_xor() [2/4]

int acl::redis_string::bitop_xor	(	const char *	destkey,
		const std::vector< const char * > &	keys
	)

◆ bitop_xor() [3/4]

int acl::redis_string::bitop_xor	(	const char *	destkey,
		const char *	key,
			...
	)

◆ bitop_xor() [4/4]

int acl::redis_string::bitop_xor	(	const char *	destkey,
		const char *	keys[],
		size_t	size
	)

◆ decr()

bool acl::redis_string::decr	(	const char *	key,
		long long int *	result = `NULL`
	)

将 key 中储存的数字值减一 1) 如果 key 不存在，那么 key 的值会先被初始化为 0 ，然后再执行 DECR 操作 2) 如果值包含错误的类型，或字符串类型的值不能表示为数字，那么返回一个错误 3) 本操作的值限制在 64 位(bit)有符号数字表示之内 decrement the integer value of a key by one 1) if key not exists, the key's value will be set 0 and DECR 2) if key's value is not a number an error will be returned 3) the number is a 64 signed integer

参数

key	{const char*} 字符串对象的 key the given key
result	{long long int*} 非空时存储操作结果 store the result after INCR if it isn't NULL

返回: {bool} 操作是否成功 if the DECR was executed correctly

◆ decrby()

bool acl::redis_string::decrby	(	const char *	key,
		long long int	dec,
		long long int *	result = `NULL`
	)

将 key 所储存的值减去减量 decrement 1) 如果 key 不存在，那么 key 的值会先被初始化为 0 ，然后再执行 DECRBY 操作 2) 如果值包含错误的类型，或字符串类型的值不能表示为数字，那么返回一个错误 3) 本操作的值限制在 64 位(bit)有符号数字表示之内 decrement the integer value of a key by the given amount

参数

key	{const char*} 字符串对象的 key the given key
dec	{long long int} 减量值 the given amount
result	{long long int*} 非空时存储操作结果 store the result after INCR if it isn't NULL

返回: {bool} 操作是否成功 if the DECRBY was executed correctly

◆ get() [1/4]

bool acl::redis_string::get	(	const char *	key,
		size_t	len,
		string &	buf
	)

返回 key 所关联的字符串值 get the value of a key

参数

key	{const char*} 字符串对象的 key the key of a string
buf	{string&} 操作成功后存储字符串对象的值，如果返回 true 且该缓冲区为空则表示对应 key 不存在 store the value of a key after GET executed correctly, key not exist if the buf is empty when return true

返回: {bool} 操作是否成功，返回 false 表示出错或 key 非字符串对象 if the GET was executed correctly, false if error happened or is is not a string of the key

◆ get() [2/4]

bool acl::redis_string::get	(	const char *	key,
		string &	buf
	)

◆ get() [3/4]

const redis_result* acl::redis_string::get ( const char * key )

返回 key 所关联的字符串值，当返回的字符串值比较大时，内部会自动进行切片，即将一个大内存切成一些非连续的小内存，使用者需要根据返回的结果对象重新对结果数据进行组装，比如可以调用： redis_result::get(size_t, size_t*) 函数获得某个切片的片断数据，根据 redis_result::get_size() 获得分片数组的长度

参数

key	{const char*} 字符串对象的 key

返回: {bool} 操作是否成功，返回 false 表示出错或 key 非字符串对象

◆ get() [4/4]

const redis_result* acl::redis_string::get	(	const char *	key,
		size_t	len
	)

◆ get_strlen() [1/2]

int acl::redis_string::get_strlen ( const char * key )

获得指定 key 的字符串对象的值的数据长度 get the length of value stored in a key

参数

key	{const char*} 字符串对象的 key the key of the string

返回: {int} 返回值含义如下： return value as below: -1：出错或非字符串对象 error happened or the it isn't a string of the key 0：该 key 不存在 the key doesn't exist >0：该字符串数据的长度 the length of the value stored in a key

◆ get_strlen() [2/2]

int acl::redis_string::get_strlen	(	const char *	key,
		size_t	key_len
	)

◆ getbit() [1/2]

bool acl::redis_string::getbit	(	const char *	key,
		unsigned	offset,
		int &	bit
	)

对 key 所储存的字符串值，获取指定偏移量上的位(bit)，当 offset 比字符串值的长度大，或者 key 不存在时，返回 0 get the bit at offset in the string value stored at key

参数

key	{const char*} 字符串对象的 key the key of the string
offset	{unsigned} 指定偏移量的位置 the offset in the string value
bit	{int&} 成功后存储指定位置的标志位 on success it will stored the bit at the specified offset

返回: {bool} 操作是否成功，返回 false 表示出错或该 key 非字符串对象 if the GETBIT was executed correctly, false if error happened, or the key doesn't store a string object

◆ getbit() [2/2]

bool acl::redis_string::getbit	(	const char *	key,
		size_t	len,
		unsigned	offset,
		int &	bit
	)

◆ getrange() [1/2]

bool acl::redis_string::getrange	(	const char *	key,
		int	start,
		int	end,
		string &	buf
	)

返回 key 中字符串值的子字符串，字符串的截取范围由 start 和 end 两个偏移量决定 (包括 start 和 end 在内) get substring of the string stored at a key

参数

key	{const char*} 字符串对象的 key the key of string
start	{int} 起始下标值 the starting offset of the string
end	{int} 结束下标值 the ending offset of the string
buf	{string&} 成功时存储结果 store the substring result

返回: {bool} 操作是否成功 if GETRANGE was executed correctly. 注：下标位置可以为负值，表示从字符串尾部向前开始计数，如 -1 表示最后一个元素

◆ getrange() [2/2]

bool acl::redis_string::getrange	(	const char *	key,
		size_t	key_len,
		int	start,
		int	end,
		string &	buf
	)

◆ getset() [1/2]

bool acl::redis_string::getset	(	const char *	key,
		const char *	value,
		string &	buf
	)

将给定 key 的值设为 value ，并返回 key 的旧值，当 key 存在但不是字符串类型时，返回一个错误 set the string value of a key and and return its old value

参数

key	{const char*} 字符串对象的 key the key of string
value	{const char*} 设定的新的对象的值 the new string value of the key
buf	{string&} 存储对象的旧的值 store the old string value of the key

返回: {bool} 是否成功 if GETSET was executed correctly.

◆ getset() [2/2]

bool acl::redis_string::getset	(	const char *	key,
		size_t	key_len,
		const char *	value,
		size_t	value_len,
		string &	buf
	)

◆ incr()

bool acl::redis_string::incr	(	const char *	key,
		long long int *	result = `NULL`
	)

将 key 中储存的数字值增一 1）如果 key 不存在，那么 key 的值会先被初始化为 0 ，然后再执行 INCR 操作； 2）如果值包含错误的类型，或字符串类型的值不能表示为数字，那么返回一个错误； 3）本操作的值限制在 64 位(bit)有符号数字表示之内 increment the integer value of a key by one 1) if key not exists, the key's value will be set 0 and INCR 2) if key's value is not a number an error will be returned 3) the number is a 64 signed integer

参数

key	{const char*} 字符串对象的 key the given key
result	{long long int*} 非空时存储操作结果 store the result after INCR if it isn't NULL

返回: {bool} 操作是否成功 if the INCR was executed correctly

◆ incrby()

bool acl::redis_string::incrby	(	const char *	key,
		long long int	inc,
		long long int *	result = `NULL`
	)

将 key 所储存的值加上增量 increment 1）如果 key 不存在，那么 key 的值会先被初始化为 0 ，然后再执行 INCRBY 命令 2）如果值包含错误的类型，或字符串类型的值不能表示为数字，那么返回一个错误 3）本操作的值限制在 64 位(bit)有符号数字表示之内 increment the integer value of a key by a given amount 1) if key not exists, the key's value will be set 0 and INCRBY 2) if key's value is not a number an error will be returned 3) the number is a 64 signed integer

参数

key	{const char*} 字符串对象的 key the given key
inc	{long long int} 增量值 the given amount
result	{long long int*} 非空时存储操作结果 store the result after INCR if it isn't NULL

返回: {bool} 操作是否成功 if the INCRBY was executed correctly

◆ incrbyfloat()

bool acl::redis_string::incrbyfloat	(	const char *	key,
		double	inc,
		double *	result = `NULL`
	)

为 key 中所储存的值加上浮点数增量 1) 如果 key 不存在，那么 INCRBYFLOAT 会先将 key 的值设为 0 ，再执行加法操作 2) 如果命令执行成功，那么 key 的值会被更新为（执行加法之后的）新值，并且新值会以字符串的形式返回给调用者 3) 计算结果也最多只能表示小数点的后十七位 increment the float value of a key by the given amount 1) if key not exists, the key's value will be set 0 and INCRBYFLOAT 2) if key's value is not a float an error will be returned

参数

key	{const char*} 字符串对象的 key the given key
inc	{double} 增量值 the given amount
result	{double*} 非空时存储操作结果 store the result after INCR if it isn't NULL

返回: {bool} 操作是否成功 if the INCRBYFLOAT was executed correctly

◆ mget() [1/5]

bool acl::redis_string::mget	(	const std::vector< string > &	keys,
		std::vector< string > *	out = `NULL`
	)

返回所有(一个或多个)给定 key 的值，如果给定的 key 里面，有某个 key 不存在，那么这个 key 返回空串添加进结果数组中 get the values of the given keys

参数

keys	{const std::vector<string>&} 字符串 key 集合 the given keys
out	{std::vector<acl::string>*} 非空时存储字符串值集合数组，对于不存在的 key 也会存储一个空串对象 acl::string array storing the result. if one key not exists, a empty string "" will also be stored in the array.

返回: {bool} 操作是否成功，操作成功后可以通过以下任一种方式获得数据： if successul, one of below ways can be used to get the result:

1、在调用方法中传入非空的存储结果对象的地址 input the no-NULL result parameter when call hmget, when success, the result will store the values of the given fileds

2、基类方法 get_value 获得指定下标的元素数据 call redis_command::result_value with the specified subscript

3、基类方法 get_child 获得指定下标的元素对象(redis_result），然后再通过 redis_result::argv_to_string 方法获得元素数据 redis_result::argv_to_string 方法获得元素数据 call redis_command::result_child with specified subscript to get redis_result object, then call redis_result::argv_to_string with above result to get the values of the give fileds

4、基类方法 get_result 方法取得总结果集对象 redis_result，然后再通过 redis_result::get_child 获得一个元素对象，然后再通过方式 2 中指定的方法获得该元素的数据 call redis_command::get_result with the specified subscript to get redis_result object, and use redis_result::get_child to get one result object, then call redis_result::argv_to_string to get the value of one filed.

5、基类方法 get_children 获得结果元素数组对象，再通过 redis_result 中的方法 argv_to_string 从每一个元素对象中获得元素数据 use redis_command::get_children to get the redis_result array, then use redis_result::argv_to_string to get every value of the given fileds

◆ mget() [2/5]

bool acl::redis_string::mget	(	const std::vector< const char * > &	keys,
		std::vector< string > *	out = `NULL`
	)

◆ mget() [3/5]

bool acl::redis_string::mget	(	std::vector< string > *	result,
		const char *	first_key,
			...
	)

◆ mget() [4/5]

bool acl::redis_string::mget	(	const char *	keys[],
		size_t	argc,
		std::vector< string > *	out = `NULL`
	)

◆ mget() [5/5]

bool acl::redis_string::mget	(	const char *	keys[],
		const size_t	keys_len[],
		size_t	argc,
		std::vector< string > *	out = `NULL`
	)

◆ mset() [1/4]

bool acl::redis_string::mset ( const std::map< string, string > & objs )

同时设置一个或多个 key-value 对 set multiple key-value pair

参数

objs	key-value 对集合 the collection of multiple key-value pair

返回: {bool} 操作是否成功 if the command was executed correctly

◆ mset() [2/4]

bool acl::redis_string::mset	(	const std::vector< string > &	keys,
		const std::vector< string > &	values
	)

◆ mset() [3/4]

bool acl::redis_string::mset	(	const char *	keys[],
		const char *	values[],
		size_t	argc
	)

◆ mset() [4/4]

bool acl::redis_string::mset	(	const char *	keys[],
		const size_t	keys_len[],
		const char *	values[],
		const size_t	values_len[],
		size_t	argc
	)

◆ msetnx() [1/4]

int acl::redis_string::msetnx ( const std::map< string, string > & objs )

当且仅当所有给定 key 都不存在时同时设置一个或多个 key-value 对 set multiple keys to multiple values only if none of the keys exist

参数

objs	key-value 对集合 the collection of multile key-value pair

返回: {int} 返回值含义如下： return value as below: -1：出错或非字符串对象 error happened or there were a object of not a string. 0：添加的 key 集合中至少有一个已经存在 none be set because some of the keys already exist 1：添加成功 add ok.

◆ msetnx() [2/4]

int acl::redis_string::msetnx	(	const std::vector< string > &	keys,
		const std::vector< string > &	values
	)

◆ msetnx() [3/4]

int acl::redis_string::msetnx	(	const char *	keys[],
		const char *	values[],
		size_t	argc
	)

◆ msetnx() [4/4]

int acl::redis_string::msetnx	(	const char *	keys[],
		const size_t	keys_len[],
		const char *	values[],
		const size_t	values_len[],
		size_t	argc
	)

◆ psetex() [1/2]

bool acl::redis_string::psetex	(	const char *	key,
		const char *	value,
		int	timeout
	)

将值 value 关联到 key ，并将 key 的生存时间设为 timeout (以毫秒为单位)，如果 key 已经存在， SETEX 命令将覆写旧值 set key to hold the string value, and set key to timeout after a given number of milliseconds.

参数

key	{const char*} 字符串对象的 key the key of a string
value	{const char*} 字符串对象的 value the value of a string
timeout	{int} 过期值，单位为毫秒 the timeout in milliseconds of a string

返回: {bool} 操作是否成功，返回 false 表示出错或该 key 对象非字符串对象 true if SETEX was executed correctly, false if error happened or the object specified by the key is not a string

◆ psetex() [2/2]

bool acl::redis_string::psetex	(	const char *	key,
		size_t	key_len,
		const char *	value,
		size_t	value_len,
		int	timeout
	)

◆ set() [1/4]

bool acl::redis_string::set	(	const char *	key,
		const char *	value
	)

将字符串值 value 关联到 key set the string value of a key

参数

key	{const char*} 字符串对象的 key the key of a string
value	{const char*} 字符串对象的 value the value of a string

返回: {bool} 操作是否成功，返回 false 表示出错或该 key 对象非字符串对象 true if SET was executed correctly, false if error happened or the key's object isn't a string.

◆ set() [2/4]

bool acl::redis_string::set	(	const char *	key,
		size_t	key_len,
		const char *	value,
		size_t	value_len
	)

◆ set() [3/4]

bool acl::redis_string::set	(	const char *	key,
		const char *	value,
		int	timeout,
		int	flag
	)

从 Redis 2.6.12 版本开始， SET 命令的行为可以通过一系列参数来修改： EX seconds ：将键的过期时间设置为 seconds 秒。执行 SET key value EX seconds 的效果等同于执行 SETEX key seconds value 。 PX milliseconds ：将键的过期时间设置为 milliseconds 毫秒。执行 SET key value PX milliseconds 的效果等同于执行 PSETEX key milliseconds value 。 NX ：只在键不存在时，才对键进行设置操作。执行 SET key value NX 的效果等同于执行 SETNX key value 。 XX ：只在键已经存在时，才对键进行设置操作。 @Note 因为 SET 命令可以通过参数来实现 SETNX 、 SETEX 以及 PSETEX 命令的效果，所以 Redis 将来的版本可能会移除并废弃 SETNX 、 SETEX 和 PSETEX 这三个命令。

参数

key	{const char*} 字符串对象的 key the key of a string
value	{const char*} 字符串对象的 value the value of a string
timeout	{int} 过期值，单位为秒(EX)/毫秒(PX) the timeout in seconds of a string
flag	{int} 标记，EX/PX \| NX/XX the flag of a string

返回: {bool} 操作是否成功，返回 false 表示出错或该 key 对象非字符串对象 true if SET was executed correctly, false if error happened or the key's object isn't a string.

◆ set() [4/4]

bool acl::redis_string::set	(	const char *	key,
		size_t	key_len,
		const char *	value,
		size_t	value_len,
		int	timeout,
		int	flag
	)

◆ setbit_() [1/2]

bool acl::redis_string::setbit_	(	const char *	key,
		unsigned	offset,
		bool	bit
	)

对 key 所储存的字符串值，设置或清除指定偏移量上的位(bit)，位的设置或清除取决于 value 参数，可以是 0 也可以是 1 set or clear the bit at offset in the string value stored at key

参数

key	{const char*} 字符串对象的 key the key of the string
offset	{unsigned} 指定偏移量的位置 the offset at the string value
bit	{bool} 为 true 表示设置标志位，否则为取消标志位 set bit if true, or clear bit if false at the specified offset

返回: {bool} 操作是否成功 if the command was executed correctly

◆ setbit_() [2/2]

bool acl::redis_string::setbit_	(	const char *	key,
		size_t	len,
		unsigned	offset,
		bool	bit
	)

◆ setex() [1/2]

bool acl::redis_string::setex	(	const char *	key,
		const char *	value,
		int	timeout
	)

将值 value 关联到 key ，并将 key 的生存时间设为 timeout (以秒为单位)，如果 key 已经存在， SETEX 命令将覆写旧值 set key to hold the strnig value, and set key to timeout after a given number of seconds.

参数

key	{const char*} 字符串对象的 key the key of a string
value	{const char*} 字符串对象的 value the value of a string
timeout	{int} 过期值，单位为秒 the timeout in seconds of a string

返回: {bool} 操作是否成功，返回 false 表示出错或该 key 对象非字符串对象 true if SETEX was executed correctly, false if error happened or the object specified by the key is not a string

◆ setex() [2/2]

bool acl::redis_string::setex	(	const char *	key,
		size_t	key_len,
		const char *	value,
		size_t	value_len,
		int	timeout
	)

◆ setnx() [1/2]

int acl::redis_string::setnx	(	const char *	key,
		const char *	value
	)

将 key 的值设为 value ，当且仅当 key 不存在，若给定的 key 已经存在，则 SETNX 不做任何动作 set the value of a key, only if the key does not exist.

参数

key	{const char*} 字符串对象的 key the key of the string
value	{const char*} 字符串对象的 value the value of the string

返回: {int} 返回值含义如下： return the value as below: -1：出错或 key 非字符串对象 error happened or the object by the key isn't a string 0：给定 key 的对象存在 the string of the key already exists 1：添加成功 the command was executed correctly

◆ setnx() [2/2]

int acl::redis_string::setnx	(	const char *	key,
		size_t	key_len,
		const char *	value,
		size_t	value_len
	)

◆ setrange() [1/2]

int acl::redis_string::setrange	(	const char *	key,
		unsigned	offset,
		const char *	value
	)

用 value 参数覆写(overwrite)给定 key 所储存的字符串值，从偏移量 offset 开始，不存在的 key 当作空白字符串处理 overwrite part of a string at key starting at the specified offset

参数

key	{const char*} 字符串对象的 key the key of a string
offset	{unsigned} 偏移量起始位置，该值可以大于字符串的数据长度，此时是间的空洞将由 \0 补充 the specified offset of the string
value	{const char*} 覆盖的值 the value to be set

返回: {int} 当前字符串对象的数据长度 the length of the string after SETRANGE

◆ setrange() [2/2]

int acl::redis_string::setrange	(	const char *	key,
		size_t	key_len,
		unsigned	offset,
		const char *	value,
		size_t	value_len
	)

该类的文档由以下文件生成:

include/acl_cpp/redis/redis_string.hpp

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ redis_string() [1/5]

◆ redis_string() [2/5]

◆ redis_string() [3/5]

◆ redis_string() [4/5]

◆ redis_string() [5/5]

◆ ~redis_string()

成员函数说明

◆ append() [1/2]

◆ append() [2/2]

◆ bitcount() [1/4]

◆ bitcount() [2/4]

◆ bitcount() [3/4]

◆ bitcount() [4/4]

◆ bitop_and() [1/4]

◆ bitop_and() [2/4]

◆ bitop_and() [3/4]

◆ bitop_and() [4/4]

◆ bitop_or() [1/4]

◆ bitop_or() [2/4]

◆ bitop_or() [3/4]

◆ bitop_or() [4/4]

◆ bitop_xor() [1/4]

◆ bitop_xor() [2/4]

◆ bitop_xor() [3/4]

◆ bitop_xor() [4/4]

◆ decr()

◆ decrby()

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ get_strlen() [1/2]

◆ get_strlen() [2/2]

◆ getbit() [1/2]

◆ getbit() [2/2]

◆ getrange() [1/2]

◆ getrange() [2/2]

◆ getset() [1/2]

◆ getset() [2/2]

◆ incr()

◆ incrby()

◆ incrbyfloat()

◆ mget() [1/5]

◆ mget() [2/5]

◆ mget() [3/5]

◆ mget() [4/5]

◆ mget() [5/5]

◆ mset() [1/4]

◆ mset() [2/4]

◆ mset() [3/4]

◆ mset() [4/4]

◆ msetnx() [1/4]

◆ msetnx() [2/4]

◆ msetnx() [3/4]

◆ msetnx() [4/4]

◆ psetex() [1/2]

◆ psetex() [2/2]

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ setbit_() [1/2]

◆ setbit_() [2/2]

◆ setex() [1/2]

◆ setex() [2/2]

◆ setnx() [1/2]

◆ setnx() [2/2]

◆ setrange() [1/2]

◆ setrange() [2/2]