SSDB C++ API
The C++ Client API for SSDB server
Static Public Member Functions | List of all members
ssdb::Client Class Referenceabstract

The SSDB client used to connect to SSDB server. More...

#include <SSDB.h>

Public Member Functions

Free hand methods

All these methods return NULL if error; vector<std::string> if response ready, the first element is response code.

virtual const std::vector
< std::string > * 
request (const std::vector< std::string > &req)=0
 
virtual const std::vector
< std::string > * 
request (const std::string &cmd)=0
 
virtual const std::vector
< std::string > * 
request (const std::string &cmd, const std::string &s2)=0
 
virtual const std::vector
< std::string > * 
request (const std::string &cmd, const std::string &s2, const std::string &s3)=0
 
virtual const std::vector
< std::string > * 
request (const std::string &cmd, const std::string &s2, const std::string &s3, const std::string &s4)=0
 
virtual const std::vector
< std::string > * 
request (const std::string &cmd, const std::string &s2, const std::string &s3, const std::string &s4, const std::string &s5)=0
 
virtual const std::vector
< std::string > * 
request (const std::string &cmd, const std::string &s2, const std::string &s3, const std::string &s4, const std::string &s5, const std::string &s6)=0
 
KV methods
virtual Status get (const std::string &key, std::string *val)=0
 
virtual Status set (const std::string &key, const std::string &val)=0
 
virtual Status setx (const std::string &key, const std::string &val, int ttl)=0
 Set the value of the key, with a time to live.
 
virtual Status del (const std::string &key)=0
 
virtual Status incr (const std::string &key, int64_t incrby, int64_t *ret)=0
 
virtual Status keys (const std::string &key_start, const std::string &key_end, uint64_t limit, std::vector< std::string > *ret)=0
 
virtual Status scan (const std::string &key_start, const std::string &key_end, uint64_t limit, std::vector< std::string > *ret)=0
 Return key-value pairs. More...
 
virtual Status rscan (const std::string &key_start, const std::string &key_end, uint64_t limit, std::vector< std::string > *ret)=0
 Return key-value pairs. More...
 
Map(Hash) methods
virtual Status hget (const std::string &name, const std::string &key, std::string *val)=0
 
virtual Status hset (const std::string &name, const std::string &key, const std::string &val)=0
 
virtual Status hdel (const std::string &name, const std::string &key)=0
 
virtual Status hincr (const std::string &name, const std::string &key, int64_t incrby, int64_t *ret)=0
 
virtual Status hsize (const std::string &name, int64_t *ret)=0
 
virtual Status hclear (const std::string &name, int64_t *ret)=0
 Delete all of the keys in a hashmap, return the number of keys deleted.
 
virtual Status hkeys (const std::string &name, const std::string &key_start, const std::string &key_end, uint64_t limit, std::vector< std::string > *ret)=0
 
virtual Status hscan (const std::string &name, const std::string &key_start, const std::string &key_end, uint64_t limit, std::vector< std::string > *ret)=0
 Return key-value pairs. More...
 
virtual Status hrscan (const std::string &name, const std::string &key_start, const std::string &key_end, uint64_t limit, std::vector< std::string > *ret)=0
 Return key-value pairs. More...
 
Zset methods
virtual Status zget (const std::string &name, const std::string &key, int64_t *ret)=0
 
virtual Status zset (const std::string &name, const std::string &key, int64_t score)=0
 
virtual Status zdel (const std::string &name, const std::string &key)=0
 
virtual Status zincr (const std::string &name, const std::string &key, int64_t incrby, int64_t *ret)=0
 
virtual Status zsize (const std::string &name, int64_t *ret)=0
 
virtual Status zclear (const std::string &name, int64_t *ret)=0
 Delete all of the keys in a zset, return the number of keys deleted.
 
virtual Status zrank (const std::string &name, const std::string &key, int64_t *ret)=0
 Important! This method may be extremly SLOW!
 
virtual Status zrrank (const std::string &name, const std::string &key, int64_t *ret)=0
 Important! This method may be extremly SLOW!
 
virtual Status zrange (const std::string &name, uint64_t offset, uint64_t limit, std::vector< std::string > *ret)=0
 Important! This method is SLOW for large offset!
 
virtual Status zrrange (const std::string &name, uint64_t offset, uint64_t limit, std::vector< std::string > *ret)=0
 Important! This method is SLOW for large offset!
 
virtual Status zkeys (const std::string &name, const std::string &key_start, int64_t *score_start, int64_t *score_end, uint64_t limit, std::vector< std::string > *ret)=0
 
virtual Status zscan (const std::string &name, const std::string &key_start, int64_t *score_start, int64_t *score_end, uint64_t limit, std::vector< std::string > *ret)=0
 Return key-score pairs. More...
 
virtual Status zrscan (const std::string &name, const std::string &key_start, int64_t *score_start, int64_t *score_end, uint64_t limit, std::vector< std::string > *ret)=0
 Return key-score pairs. More...
 

Static Public Member Functions

static Clientconnect (const char *ip, int port)
 

Detailed Description

The SSDB client used to connect to SSDB server.

Member Function Documentation

virtual Status ssdb::Client::hkeys ( const std::string &  name,
const std::string &  key_start,
const std::string &  key_end,
uint64_t  limit,
std::vector< std::string > *  ret 
)
pure virtual
Parameters
key_startEmpty string means no limit.
key_endEmpty string means no limit.
virtual Status ssdb::Client::hrscan ( const std::string &  name,
const std::string &  key_start,
const std::string &  key_end,
uint64_t  limit,
std::vector< std::string > *  ret 
)
pure virtual

Return key-value pairs.

The two elements at ret[n] and ret[n+1] form a key-value pair, n=0,2,4,...

virtual Status ssdb::Client::hscan ( const std::string &  name,
const std::string &  key_start,
const std::string &  key_end,
uint64_t  limit,
std::vector< std::string > *  ret 
)
pure virtual

Return key-value pairs.

The two elements at ret[n] and ret[n+1] form a key-value pair, n=0,2,4,...

virtual Status ssdb::Client::keys ( const std::string &  key_start,
const std::string &  key_end,
uint64_t  limit,
std::vector< std::string > *  ret 
)
pure virtual
Parameters
key_startEmpty string means no limit.
key_endEmpty string means no limit.
virtual Status ssdb::Client::rscan ( const std::string &  key_start,
const std::string &  key_end,
uint64_t  limit,
std::vector< std::string > *  ret 
)
pure virtual

Return key-value pairs.

The two elements at ret[n] and ret[n+1] form a key-value pair, n=0,2,4,...

virtual Status ssdb::Client::scan ( const std::string &  key_start,
const std::string &  key_end,
uint64_t  limit,
std::vector< std::string > *  ret 
)
pure virtual

Return key-value pairs.

The two elements at ret[n] and ret[n+1] form a key-value pair, n=0,2,4,...

virtual Status ssdb::Client::zkeys ( const std::string &  name,
const std::string &  key_start,
int64_t *  score_start,
int64_t *  score_end,
uint64_t  limit,
std::vector< std::string > *  ret 
)
pure virtual
Parameters
score_startNULL means no limit.
score_endNULL means no limit.
virtual Status ssdb::Client::zrscan ( const std::string &  name,
const std::string &  key_start,
int64_t *  score_start,
int64_t *  score_end,
uint64_t  limit,
std::vector< std::string > *  ret 
)
pure virtual

Return key-score pairs.

The two elements at ret[n] and ret[n+1] form a key-score pair, n=0,2,4,...

virtual Status ssdb::Client::zscan ( const std::string &  name,
const std::string &  key_start,
int64_t *  score_start,
int64_t *  score_end,
uint64_t  limit,
std::vector< std::string > *  ret 
)
pure virtual

Return key-score pairs.

The two elements at ret[n] and ret[n+1] form a key-score pair, n=0,2,4,...


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