346 lines
13 KiB
C
346 lines
13 KiB
C
|
/*
|
||
|
|
* Copyright (c) 2009-2011, Salvatore Sanfilippo <antirez at gmail dot com>
|
||
|
|
* Copyright (c) 2010-2014, Pieter Noordhuis <pcnoordhuis at gmail dot com>
|
||
|
|
* Copyright (c) 2015, Matt Stancliff <matt at genges dot com>,
|
||
|
|
* Jan-Erik Rediger <janerik at fnordig dot com>
|
||
|
|
*
|
||
|
|
* All rights reserved.
|
||
|
|
*
|
||
|
|
* Redistribution and use in source and binary forms, with or without
|
||
|
|
* modification, are permitted provided that the following conditions are met:
|
||
|
|
*
|
||
|
|
* * Redistributions of source code must retain the above copyright notice,
|
||
|
|
* this list of conditions and the following disclaimer.
|
||
|
|
* * Redistributions in binary form must reproduce the above copyright
|
||
|
|
* notice, this list of conditions and the following disclaimer in the
|
||
|
|
* documentation and/or other materials provided with the distribution.
|
||
|
|
* * Neither the name of Redis nor the names of its contributors may be used
|
||
|
|
* to endorse or promote products derived from this software without
|
||
|
|
* specific prior written permission.
|
||
|
|
*
|
||
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
||
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef __HIREDIS_H
|
||
|
|
#define __HIREDIS_H
|
||
|
|
#include "read.h"
|
||
|
|
#include <stdarg.h> /* for va_list */
|
||
|
|
#ifndef _MSC_VER
|
||
|
|
#include <sys/time.h> /* for struct timeval */
|
||
|
|
#else
|
||
|
|
struct timeval; /* forward declaration */
|
||
|
|
typedef long long ssize_t;
|
||
|
|
#endif
|
||
|
|
#include <stdint.h> /* uintXX_t, etc */
|
||
|
|
#include "sds.h" /* for sds */
|
||
|
|
#include "alloc.h" /* for allocation wrappers */
|
||
|
|
|
||
|
|
#define HIREDIS_MAJOR 1
|
||
|
|
#define HIREDIS_MINOR 0
|
||
|
|
#define HIREDIS_PATCH 1
|
||
|
|
#define HIREDIS_SONAME 1.0.1-dev
|
||
|
|
|
||
|
|
/* Connection type can be blocking or non-blocking and is set in the
|
||
|
|
* least significant bit of the flags field in redisContext. */
|
||
|
|
#define REDIS_BLOCK 0x1
|
||
|
|
|
||
|
|
/* Connection may be disconnected before being free'd. The second bit
|
||
|
|
* in the flags field is set when the context is connected. */
|
||
|
|
#define REDIS_CONNECTED 0x2
|
||
|
|
|
||
|
|
/* The async API might try to disconnect cleanly and flush the output
|
||
|
|
* buffer and read all subsequent replies before disconnecting.
|
||
|
|
* This flag means no new commands can come in and the connection
|
||
|
|
* should be terminated once all replies have been read. */
|
||
|
|
#define REDIS_DISCONNECTING 0x4
|
||
|
|
|
||
|
|
/* Flag specific to the async API which means that the context should be clean
|
||
|
|
* up as soon as possible. */
|
||
|
|
#define REDIS_FREEING 0x8
|
||
|
|
|
||
|
|
/* Flag that is set when an async callback is executed. */
|
||
|
|
#define REDIS_IN_CALLBACK 0x10
|
||
|
|
|
||
|
|
/* Flag that is set when the async context has one or more subscriptions. */
|
||
|
|
#define REDIS_SUBSCRIBED 0x20
|
||
|
|
|
||
|
|
/* Flag that is set when monitor mode is active */
|
||
|
|
#define REDIS_MONITORING 0x40
|
||
|
|
|
||
|
|
/* Flag that is set when we should set SO_REUSEADDR before calling bind() */
|
||
|
|
#define REDIS_REUSEADDR 0x80
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Flag that indicates the user does not want the context to
|
||
|
|
* be automatically freed upon error
|
||
|
|
*/
|
||
|
|
#define REDIS_NO_AUTO_FREE 0x200
|
||
|
|
|
||
|
|
/* Flag that indicates the user does not want replies to be automatically freed */
|
||
|
|
#define REDIS_NO_AUTO_FREE_REPLIES 0x400
|
||
|
|
|
||
|
|
#define REDIS_KEEPALIVE_INTERVAL 15 /* seconds */
|
||
|
|
|
||
|
|
/* number of times we retry to connect in the case of EADDRNOTAVAIL and
|
||
|
|
* SO_REUSEADDR is being used. */
|
||
|
|
#define REDIS_CONNECT_RETRIES 10
|
||
|
|
|
||
|
|
/* Forward declarations for structs defined elsewhere */
|
||
|
|
struct redisAsyncContext;
|
||
|
|
struct redisContext;
|
||
|
|
|
||
|
|
/* RESP3 push helpers and callback prototypes */
|
||
|
|
#define redisIsPushReply(r) (((redisReply*)(r))->type == REDIS_REPLY_PUSH)
|
||
|
|
typedef void (redisPushFn)(void *, void *);
|
||
|
|
typedef void (redisAsyncPushFn)(struct redisAsyncContext *, void *);
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/* This is the reply object returned by redisCommand() */
|
||
|
|
typedef struct redisReply {
|
||
|
|
int type; /* REDIS_REPLY_* */
|
||
|
|
long long integer; /* The integer when type is REDIS_REPLY_INTEGER */
|
||
|
|
double dval; /* The double when type is REDIS_REPLY_DOUBLE */
|
||
|
|
size_t len; /* Length of string */
|
||
|
|
char *str; /* Used for REDIS_REPLY_ERROR, REDIS_REPLY_STRING
|
||
|
|
REDIS_REPLY_VERB, REDIS_REPLY_DOUBLE (in additional to dval),
|
||
|
|
and REDIS_REPLY_BIGNUM. */
|
||
|
|
char vtype[4]; /* Used for REDIS_REPLY_VERB, contains the null
|
||
|
|
terminated 3 character content type, such as "txt". */
|
||
|
|
size_t elements; /* number of elements, for REDIS_REPLY_ARRAY */
|
||
|
|
struct redisReply **element; /* elements vector for REDIS_REPLY_ARRAY */
|
||
|
|
} redisReply;
|
||
|
|
|
||
|
|
redisReader *redisReaderCreate(void);
|
||
|
|
|
||
|
|
/* Function to free the reply objects hiredis returns by default. */
|
||
|
|
void freeReplyObject(void *reply);
|
||
|
|
|
||
|
|
/* Functions to format a command according to the protocol. */
|
||
|
|
int redisvFormatCommand(char **target, const char *format, va_list ap);
|
||
|
|
int redisFormatCommand(char **target, const char *format, ...);
|
||
|
|
int redisFormatCommandArgv(char **target, int argc, const char **argv, const size_t *argvlen);
|
||
|
|
int redisFormatSdsCommandArgv(sds *target, int argc, const char ** argv, const size_t *argvlen);
|
||
|
|
void redisFreeCommand(char *cmd);
|
||
|
|
void redisFreeSdsCommand(sds cmd);
|
||
|
|
|
||
|
|
enum redisConnectionType {
|
||
|
|
REDIS_CONN_TCP,
|
||
|
|
REDIS_CONN_UNIX,
|
||
|
|
REDIS_CONN_USERFD
|
||
|
|
};
|
||
|
|
|
||
|
|
struct redisSsl;
|
||
|
|
|
||
|
|
#define REDIS_OPT_NONBLOCK 0x01
|
||
|
|
#define REDIS_OPT_REUSEADDR 0x02
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Don't automatically free the async object on a connection failure,
|
||
|
|
* or other implicit conditions. Only free on an explicit call to disconnect() or free()
|
||
|
|
*/
|
||
|
|
#define REDIS_OPT_NOAUTOFREE 0x04
|
||
|
|
|
||
|
|
/* Don't automatically intercept and free RESP3 PUSH replies. */
|
||
|
|
#define REDIS_OPT_NO_PUSH_AUTOFREE 0x08
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Don't automatically free replies
|
||
|
|
*/
|
||
|
|
#define REDIS_OPT_NOAUTOFREEREPLIES 0x10
|
||
|
|
|
||
|
|
/* In Unix systems a file descriptor is a regular signed int, with -1
|
||
|
|
* representing an invalid descriptor. In Windows it is a SOCKET
|
||
|
|
* (32- or 64-bit unsigned integer depending on the architecture), where
|
||
|
|
* all bits set (~0) is INVALID_SOCKET. */
|
||
|
|
#ifndef _WIN32
|
||
|
|
typedef int redisFD;
|
||
|
|
#define REDIS_INVALID_FD -1
|
||
|
|
#else
|
||
|
|
#ifdef _WIN64
|
||
|
|
typedef unsigned long long redisFD; /* SOCKET = 64-bit UINT_PTR */
|
||
|
|
#else
|
||
|
|
typedef unsigned long redisFD; /* SOCKET = 32-bit UINT_PTR */
|
||
|
|
#endif
|
||
|
|
#define REDIS_INVALID_FD ((redisFD)(~0)) /* INVALID_SOCKET */
|
||
|
|
#endif
|
||
|
|
|
||
|
|
typedef struct {
|
||
|
|
/*
|
||
|
|
* the type of connection to use. This also indicates which
|
||
|
|
* `endpoint` member field to use
|
||
|
|
*/
|
||
|
|
int type;
|
||
|
|
/* bit field of REDIS_OPT_xxx */
|
||
|
|
int options;
|
||
|
|
/* timeout value for connect operation. If NULL, no timeout is used */
|
||
|
|
const struct timeval *connect_timeout;
|
||
|
|
/* timeout value for commands. If NULL, no timeout is used. This can be
|
||
|
|
* updated at runtime with redisSetTimeout/redisAsyncSetTimeout. */
|
||
|
|
const struct timeval *command_timeout;
|
||
|
|
union {
|
||
|
|
/** use this field for tcp/ip connections */
|
||
|
|
struct {
|
||
|
|
const char *source_addr;
|
||
|
|
const char *ip;
|
||
|
|
int port;
|
||
|
|
} tcp;
|
||
|
|
/** use this field for unix domain sockets */
|
||
|
|
const char *unix_socket;
|
||
|
|
/**
|
||
|
|
* use this field to have hiredis operate an already-open
|
||
|
|
* file descriptor */
|
||
|
|
redisFD fd;
|
||
|
|
} endpoint;
|
||
|
|
|
||
|
|
/* Optional user defined data/destructor */
|
||
|
|
void *privdata;
|
||
|
|
void (*free_privdata)(void *);
|
||
|
|
|
||
|
|
/* A user defined PUSH message callback */
|
||
|
|
redisPushFn *push_cb;
|
||
|
|
redisAsyncPushFn *async_push_cb;
|
||
|
|
} redisOptions;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Helper macros to initialize options to their specified fields.
|
||
|
|
*/
|
||
|
|
#define REDIS_OPTIONS_SET_TCP(opts, ip_, port_) \
|
||
|
|
(opts)->type = REDIS_CONN_TCP; \
|
||
|
|
(opts)->endpoint.tcp.ip = ip_; \
|
||
|
|
(opts)->endpoint.tcp.port = port_;
|
||
|
|
|
||
|
|
#define REDIS_OPTIONS_SET_UNIX(opts, path) \
|
||
|
|
(opts)->type = REDIS_CONN_UNIX; \
|
||
|
|
(opts)->endpoint.unix_socket = path;
|
||
|
|
|
||
|
|
#define REDIS_OPTIONS_SET_PRIVDATA(opts, data, dtor) \
|
||
|
|
(opts)->privdata = data; \
|
||
|
|
(opts)->free_privdata = dtor; \
|
||
|
|
|
||
|
|
typedef struct redisContextFuncs {
|
||
|
|
void (*free_privctx)(void *);
|
||
|
|
void (*async_read)(struct redisAsyncContext *);
|
||
|
|
void (*async_write)(struct redisAsyncContext *);
|
||
|
|
ssize_t (*read)(struct redisContext *, char *, size_t);
|
||
|
|
ssize_t (*write)(struct redisContext *);
|
||
|
|
} redisContextFuncs;
|
||
|
|
|
||
|
|
/* Context for a connection to Redis */
|
||
|
|
typedef struct redisContext {
|
||
|
|
const redisContextFuncs *funcs; /* Function table */
|
||
|
|
|
||
|
|
int err; /* Error flags, 0 when there is no error */
|
||
|
|
char errstr[128]; /* String representation of error when applicable */
|
||
|
|
redisFD fd;
|
||
|
|
int flags;
|
||
|
|
char *obuf; /* Write buffer */
|
||
|
|
redisReader *reader; /* Protocol reader */
|
||
|
|
|
||
|
|
enum redisConnectionType connection_type;
|
||
|
|
struct timeval *connect_timeout;
|
||
|
|
struct timeval *command_timeout;
|
||
|
|
|
||
|
|
struct {
|
||
|
|
char *host;
|
||
|
|
char *source_addr;
|
||
|
|
int port;
|
||
|
|
} tcp;
|
||
|
|
|
||
|
|
struct {
|
||
|
|
char *path;
|
||
|
|
} unix_sock;
|
||
|
|
|
||
|
|
/* For non-blocking connect */
|
||
|
|
struct sockaddr *saddr;
|
||
|
|
size_t addrlen;
|
||
|
|
|
||
|
|
/* Optional data and corresponding destructor users can use to provide
|
||
|
|
* context to a given redisContext. Not used by hiredis. */
|
||
|
|
void *privdata;
|
||
|
|
void (*free_privdata)(void *);
|
||
|
|
|
||
|
|
/* Internal context pointer presently used by hiredis to manage
|
||
|
|
* SSL connections. */
|
||
|
|
void *privctx;
|
||
|
|
|
||
|
|
/* An optional RESP3 PUSH handler */
|
||
|
|
redisPushFn *push_cb;
|
||
|
|
} redisContext;
|
||
|
|
|
||
|
|
redisContext *redisConnectWithOptions(const redisOptions *options);
|
||
|
|
redisContext *redisConnect(const char *ip, int port);
|
||
|
|
redisContext *redisConnectWithTimeout(const char *ip, int port, const struct timeval tv);
|
||
|
|
redisContext *redisConnectNonBlock(const char *ip, int port);
|
||
|
|
redisContext *redisConnectBindNonBlock(const char *ip, int port,
|
||
|
|
const char *source_addr);
|
||
|
|
redisContext *redisConnectBindNonBlockWithReuse(const char *ip, int port,
|
||
|
|
const char *source_addr);
|
||
|
|
redisContext *redisConnectUnix(const char *path);
|
||
|
|
redisContext *redisConnectUnixWithTimeout(const char *path, const struct timeval tv);
|
||
|
|
redisContext *redisConnectUnixNonBlock(const char *path);
|
||
|
|
redisContext *redisConnectFd(redisFD fd);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Reconnect the given context using the saved information.
|
||
|
|
*
|
||
|
|
* This re-uses the exact same connect options as in the initial connection.
|
||
|
|
* host, ip (or path), timeout and bind address are reused,
|
||
|
|
* flags are used unmodified from the existing context.
|
||
|
|
*
|
||
|
|
* Returns REDIS_OK on successful connect or REDIS_ERR otherwise.
|
||
|
|
*/
|
||
|
|
int redisReconnect(redisContext *c);
|
||
|
|
|
||
|
|
redisPushFn *redisSetPushCallback(redisContext *c, redisPushFn *fn);
|
||
|
|
int redisSetTimeout(redisContext *c, const struct timeval tv);
|
||
|
|
int redisEnableKeepAlive(redisContext *c);
|
||
|
|
void redisFree(redisContext *c);
|
||
|
|
redisFD redisFreeKeepFd(redisContext *c);
|
||
|
|
int redisBufferRead(redisContext *c);
|
||
|
|
int redisBufferWrite(redisContext *c, int *done);
|
||
|
|
|
||
|
|
/* In a blocking context, this function first checks if there are unconsumed
|
||
|
|
* replies to return and returns one if so. Otherwise, it flushes the output
|
||
|
|
* buffer to the socket and reads until it has a reply. In a non-blocking
|
||
|
|
* context, it will return unconsumed replies until there are no more. */
|
||
|
|
int redisGetReply(redisContext *c, void **reply);
|
||
|
|
int redisGetReplyFromReader(redisContext *c, void **reply);
|
||
|
|
|
||
|
|
/* Write a formatted command to the output buffer. Use these functions in blocking mode
|
||
|
|
* to get a pipeline of commands. */
|
||
|
|
int redisAppendFormattedCommand(redisContext *c, const char *cmd, size_t len);
|
||
|
|
|
||
|
|
/* Write a command to the output buffer. Use these functions in blocking mode
|
||
|
|
* to get a pipeline of commands. */
|
||
|
|
int redisvAppendCommand(redisContext *c, const char *format, va_list ap);
|
||
|
|
int redisAppendCommand(redisContext *c, const char *format, ...);
|
||
|
|
int redisAppendCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);
|
||
|
|
|
||
|
|
/* Issue a command to Redis. In a blocking context, it is identical to calling
|
||
|
|
* redisAppendCommand, followed by redisGetReply. The function will return
|
||
|
|
* NULL if there was an error in performing the request, otherwise it will
|
||
|
|
* return the reply. In a non-blocking context, it is identical to calling
|
||
|
|
* only redisAppendCommand and will always return NULL. */
|
||
|
|
void *redisvCommand(redisContext *c, const char *format, va_list ap);
|
||
|
|
void *redisCommand(redisContext *c, const char *format, ...);
|
||
|
|
void *redisCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif
|