![]() |
RedisX v1.0
A simple, light-weight Redis database client
|
Functions | |
void | rCloseClientAsync (RedisClient *cl) |
int | rConnectAsync (Redis *redis, boolean usePipeline) |
void | rDisconnectAsync (Redis *redis) |
void * | RedisPipelineListener (void *pRedis) |
int | redisxConnect (Redis *redis, boolean usePipeline) |
void | redisxDestroy (Redis *redis) |
void | redisxDisconnect (Redis *redis) |
Redis * | redisxInit (const char *server) |
boolean | redisxIsConnected (Redis *redis) |
int | redisxReconnect (Redis *redis, boolean usePipeline) |
int | redisxSetHostname (Redis *redis, const char *host) |
int | redisxSetPort (Redis *redis, int port) |
int | redisxSetSocketTimeout (Redis *redis, int millis) |
int | redisxSetTcpBuf (Redis *redis, int size) |
int | rSetServerAsync (Redis *redis, const char *desc, const char *hostname, int port) |
Network layer management functions for the RedisX library.
void rCloseClientAsync | ( | RedisClient * | cl | ) |
int rConnectAsync | ( | Redis * | redis, |
boolean | usePipeline ) |
Same as rConnectClient() but called with the client's mutex already locked.
redis | Pointer to a Redis instance. |
usePipeline | TRUE (non-zero) if a pipeline client should be connected also, or FALSE to create an interactive connection only. |
References REDISX_INTERACTIVE_CHANNEL, REDISX_PIPELINE_CHANNEL, redisxErrorDescription(), and redisxIsConnected().
void rDisconnectAsync | ( | Redis * | redis | ) |
Same as rCloseClient() except without the exlusive locking mechanism of the client's IO.
redis | Pointer to a Redis instance. |
void * RedisPipelineListener | ( | void * | pRedis | ) |
The listener function that processes pipelined responses in the background. It is started when Redis is connected with the pipeline enabled.
pRedis | Pointer to a Redis instance. |
References RESP::n, redisxCheckValid(), redisxDestroyRESP(), redisxReadReplyAsync(), RESP_SIMPLE_STRING, and RESP::type.
int redisxConnect | ( | Redis * | redis, |
boolean | usePipeline ) |
Connects to a Redis server.
redis | Pointer to a Redis instance. |
usePipeline | TRUE (non-zero) if Redis should be connected with a pipeline client also, or FALSE (0) if only the interactive client is needed. |
References rConnectAsync().
void redisxDestroy | ( | Redis * | redis | ) |
Destroys a Redis intance, disconnecting any clients that may be connected, and freeing all resources used by that Redis instance.
redis | Pointer to a Redis instance. |
References REDISX_CHANNELS, redisxClearSubscribers(), redisxDestroyRESP(), redisxDisconnect(), and redisxIsConnected().
void redisxDisconnect | ( | Redis * | redis | ) |
Disconnect all clients from the Redis server.
redis | Pointer to a Redis instance. |
References rDisconnectAsync(), and redisxCheckValid().
Redis * redisxInit | ( | const char * | server | ) |
Initializes the Redis client library, and sets the hostname or IP address for the Redis server.
server | Server host name or numeric IP address, e.g. "127.0.0.1". The string will be copied, not referenced, for the internal configuration, such that the string passed may be destroyed freely after the call. |
References REDISX_CHANNELS, REDISX_DEFAULT_TIMEOUT_MILLIS, REDISX_INTERACTIVE_CHANNEL, REDISX_PIPELINE_CHANNEL, REDISX_RESP2, REDISX_SUBSCRIPTION_CHANNEL, REDISX_TCP_BUF_SIZE, and rSetServerAsync().
boolean redisxIsConnected | ( | Redis * | redis | ) |
Checks if a Redis instance is connected.
redis | Pointer to a Redis instance. |
References redisxCheckValid().
int redisxReconnect | ( | Redis * | redis, |
boolean | usePipeline ) |
Disconnects from Redis, and then connects again...
redis | Pointer to a Redis instance. |
usePipeline | Whether to reconnect in pipelined mode. |
or else an error (<0) as would be returned by redisxConnect().
int redisxSetHostname | ( | Redis * | redis, |
const char * | host ) |
Changes the host name for the Redis server, prior to calling redisxConnect()
.
redis | Pointer to a Redis instance. |
host | New host name or IP address to use. |
References redisxIsConnected(), and rSetServerAsync().
int redisxSetPort | ( | Redis * | redis, |
int | port ) |
Sets a non-standard TCP port number to use for the Redis server, prior to calling redisxConnect()
.
redis | Pointer to a Redis instance. |
port | The TCP port number to use. |
References redisxIsConnected().
int redisxSetSocketTimeout | ( | Redis * | redis, |
int | millis ) |
Sets a socket timeout for future client connections on a Redis instance. Effectively this is a timeout for send() only. The timeout for interatvice replies is controlled separately via redisxSetReplyTimoeut().
If not set (or set to zero or a negative value), then the timeout will not be configured for sockets, and the system default timeout values will apply.
redis | The Redis instance |
millis | [ms] The desired socket read/write timeout, or <0 for socket default. |
References REDISX_DEFAULT_TIMEOUT_MILLIS.
int redisxSetTcpBuf | ( | Redis * | redis, |
int | size ) |
Set the size of the TCP/IP buffers (send and receive) for future client connections.
redis | Pointer to a Redis instance. |
size | (bytes) requested buffer size, or <= 0 to use default value |
int rSetServerAsync | ( | Redis * | redis, |
const char * | desc, | ||
const char * | hostname, | ||
int | port ) |
Configures a new server by name or IP address and port number for a given Redis instance
redis | A Redis instance |
desc | The type of server, e.g. "master", "replica", "sentinel-18" |
hostname | The new host name or IP address |
port | The new port number, or <=0 to use the default Redis port. |
References REDISX_TCP_PORT.