summaryrefslogtreecommitdiff
path: root/hiredict.h
diff options
context:
space:
mode:
Diffstat (limited to 'hiredict.h')
-rw-r--r--hiredict.h260
1 files changed, 130 insertions, 130 deletions
diff --git a/hiredict.h b/hiredict.h
index 1936b4d..c186bb7 100644
--- a/hiredict.h
+++ b/hiredict.h
@@ -15,8 +15,8 @@
*
*/
-#ifndef __HIREDIS_H
-#define __HIREDIS_H
+#ifndef __HIREDICT_H
+#define __HIREDICT_H
#include "read.h"
#include <stdarg.h> /* for va_list */
#ifndef _MSC_VER
@@ -29,141 +29,141 @@ typedef long long ssize_t;
#include "sds.h" /* for sds */
#include "alloc.h" /* for allocation wrappers */
-#define HIREDIS_MAJOR 1
-#define HIREDIS_MINOR 2
-#define HIREDIS_PATCH 0
-#define HIREDIS_SONAME 1.2.1-dev
+#define HIREDICT_MAJOR 1
+#define HIREDICT_MINOR 2
+#define HIREDICT_PATCH 0
+#define HIREDICT_SONAME 1.2.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
+ * least significant bit of the flags field in redictContext. */
+#define REDICT_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
+#define REDICT_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
+#define REDICT_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
+#define REDICT_FREEING 0x8
/* Flag that is set when an async callback is executed. */
-#define REDIS_IN_CALLBACK 0x10
+#define REDICT_IN_CALLBACK 0x10
/* Flag that is set when the async context has one or more subscriptions. */
-#define REDIS_SUBSCRIBED 0x20
+#define REDICT_SUBSCRIBED 0x20
/* Flag that is set when monitor mode is active */
-#define REDIS_MONITORING 0x40
+#define REDICT_MONITORING 0x40
/* Flag that is set when we should set SO_REUSEADDR before calling bind() */
-#define REDIS_REUSEADDR 0x80
+#define REDICT_REUSEADDR 0x80
/* Flag that is set when the async connection supports push replies. */
-#define REDIS_SUPPORTS_PUSH 0x100
+#define REDICT_SUPPORTS_PUSH 0x100
/**
* Flag that indicates the user does not want the context to
* be automatically freed upon error
*/
-#define REDIS_NO_AUTO_FREE 0x200
+#define REDICT_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 REDICT_NO_AUTO_FREE_REPLIES 0x400
/* Flags to prefer IPv6 or IPv4 when doing DNS lookup. (If both are set,
* AF_UNSPEC is used.) */
-#define REDIS_PREFER_IPV4 0x800
-#define REDIS_PREFER_IPV6 0x1000
+#define REDICT_PREFER_IPV4 0x800
+#define REDICT_PREFER_IPV6 0x1000
-#define REDIS_KEEPALIVE_INTERVAL 15 /* seconds */
+#define REDICT_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
+#define REDICT_CONNECT_RETRIES 10
/* Forward declarations for structs defined elsewhere */
-struct redisAsyncContext;
-struct redisContext;
+struct redictAsyncContext;
+struct redictContext;
/* 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 *);
+#define redictIsPushReply(r) (((redictReply*)(r))->type == REDICT_REPLY_PUSH)
+typedef void (redictPushFn)(void *, void *);
+typedef void (redictAsyncPushFn)(struct redictAsyncContext *, 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 */
+/* This is the reply object returned by redictCommand() */
+typedef struct redictReply {
+ int type; /* REDICT_REPLY_* */
+ long long integer; /* The integer when type is REDICT_REPLY_INTEGER */
+ double dval; /* The double when type is REDICT_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
+ char *str; /* Used for REDICT_REPLY_ERROR, REDICT_REPLY_STRING
+ REDICT_REPLY_VERB, REDICT_REPLY_DOUBLE (in additional to dval),
+ and REDICT_REPLY_BIGNUM. */
+ char vtype[4]; /* Used for REDICT_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;
+ size_t elements; /* number of elements, for REDICT_REPLY_ARRAY */
+ struct redictReply **element; /* elements vector for REDICT_REPLY_ARRAY */
+} redictReply;
-redisReader *redisReaderCreate(void);
+redictReader *redictReaderCreate(void);
-/* Function to free the reply objects hiredis returns by default. */
+/* Function to free the reply objects hiredict 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, ...);
-long long redisFormatCommandArgv(char **target, int argc, const char **argv, const size_t *argvlen);
-long long 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
+int redictvFormatCommand(char **target, const char *format, va_list ap);
+int redictFormatCommand(char **target, const char *format, ...);
+long long redictFormatCommandArgv(char **target, int argc, const char **argv, const size_t *argvlen);
+long long redictFormatSdsCommandArgv(sds *target, int argc, const char ** argv, const size_t *argvlen);
+void redictFreeCommand(char *cmd);
+void redictFreeSdsCommand(sds cmd);
+
+enum redictConnectionType {
+ REDICT_CONN_TCP,
+ REDICT_CONN_UNIX,
+ REDICT_CONN_USERFD
};
-struct redisSsl;
+struct redictSsl;
-#define REDIS_OPT_NONBLOCK 0x01
-#define REDIS_OPT_REUSEADDR 0x02
-#define REDIS_OPT_NOAUTOFREE 0x04 /* Don't automatically free the async
+#define REDICT_OPT_NONBLOCK 0x01
+#define REDICT_OPT_REUSEADDR 0x02
+#define REDICT_OPT_NOAUTOFREE 0x04 /* 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_NO_PUSH_AUTOFREE 0x08 /* Don't automatically intercept and
+#define REDICT_OPT_NO_PUSH_AUTOFREE 0x08 /* Don't automatically intercept and
* free RESP3 PUSH replies. */
-#define REDIS_OPT_NOAUTOFREEREPLIES 0x10 /* Don't automatically free replies. */
-#define REDIS_OPT_PREFER_IPV4 0x20 /* Prefer IPv4 in DNS lookups. */
-#define REDIS_OPT_PREFER_IPV6 0x40 /* Prefer IPv6 in DNS lookups. */
-#define REDIS_OPT_PREFER_IP_UNSPEC (REDIS_OPT_PREFER_IPV4 | REDIS_OPT_PREFER_IPV6)
+#define REDICT_OPT_NOAUTOFREEREPLIES 0x10 /* Don't automatically free replies. */
+#define REDICT_OPT_PREFER_IPV4 0x20 /* Prefer IPv4 in DNS lookups. */
+#define REDICT_OPT_PREFER_IPV6 0x40 /* Prefer IPv6 in DNS lookups. */
+#define REDICT_OPT_PREFER_IP_UNSPEC (REDICT_OPT_PREFER_IPV4 | REDICT_OPT_PREFER_IPV6)
/* 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
+typedef int redictFD;
+#define REDICT_INVALID_FD -1
#else
#ifdef _WIN64
-typedef unsigned long long redisFD; /* SOCKET = 64-bit UINT_PTR */
+typedef unsigned long long redictFD; /* SOCKET = 64-bit UINT_PTR */
#else
-typedef unsigned long redisFD; /* SOCKET = 32-bit UINT_PTR */
+typedef unsigned long redictFD; /* SOCKET = 32-bit UINT_PTR */
#endif
-#define REDIS_INVALID_FD ((redisFD)(~0)) /* INVALID_SOCKET */
+#define REDICT_INVALID_FD ((redictFD)(~0)) /* INVALID_SOCKET */
#endif
typedef struct {
@@ -172,12 +172,12 @@ typedef struct {
* `endpoint` member field to use
*/
int type;
- /* bit field of REDIS_OPT_xxx */
+ /* bit field of REDICT_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. */
+ * updated at runtime with redictSetTimeout/redictAsyncSetTimeout. */
const struct timeval *command_timeout;
union {
/** use this field for tcp/ip connections */
@@ -189,9 +189,9 @@ typedef struct {
/** use this field for unix domain sockets */
const char *unix_socket;
/**
- * use this field to have hiredis operate an already-open
+ * use this field to have hiredict operate an already-open
* file descriptor */
- redisFD fd;
+ redictFD fd;
} endpoint;
/* Optional user defined data/destructor */
@@ -199,56 +199,56 @@ typedef struct {
void (*free_privdata)(void *);
/* A user defined PUSH message callback */
- redisPushFn *push_cb;
- redisAsyncPushFn *async_push_cb;
-} redisOptions;
+ redictPushFn *push_cb;
+ redictAsyncPushFn *async_push_cb;
+} redictOptions;
/**
* Helper macros to initialize options to their specified fields.
*/
-#define REDIS_OPTIONS_SET_TCP(opts, ip_, port_) do { \
- (opts)->type = REDIS_CONN_TCP; \
+#define REDICT_OPTIONS_SET_TCP(opts, ip_, port_) do { \
+ (opts)->type = REDICT_CONN_TCP; \
(opts)->endpoint.tcp.ip = ip_; \
(opts)->endpoint.tcp.port = port_; \
} while(0)
-#define REDIS_OPTIONS_SET_UNIX(opts, path) do { \
- (opts)->type = REDIS_CONN_UNIX; \
+#define REDICT_OPTIONS_SET_UNIX(opts, path) do { \
+ (opts)->type = REDICT_CONN_UNIX; \
(opts)->endpoint.unix_socket = path; \
} while(0)
-#define REDIS_OPTIONS_SET_PRIVDATA(opts, data, dtor) do { \
+#define REDICT_OPTIONS_SET_PRIVDATA(opts, data, dtor) do { \
(opts)->privdata = data; \
(opts)->free_privdata = dtor; \
} while(0)
-typedef struct redisContextFuncs {
- void (*close)(struct redisContext *);
+typedef struct redictContextFuncs {
+ void (*close)(struct redictContext *);
void (*free_privctx)(void *);
- void (*async_read)(struct redisAsyncContext *);
- void (*async_write)(struct redisAsyncContext *);
+ void (*async_read)(struct redictAsyncContext *);
+ void (*async_write)(struct redictAsyncContext *);
/* Read/Write data to the underlying communication stream, returning the
* number of bytes read/written. In the event of an unrecoverable error
* these functions shall return a value < 0. In the event of a
* recoverable error, they should return 0. */
- ssize_t (*read)(struct redisContext *, char *, size_t);
- ssize_t (*write)(struct redisContext *);
-} redisContextFuncs;
+ ssize_t (*read)(struct redictContext *, char *, size_t);
+ ssize_t (*write)(struct redictContext *);
+} redictContextFuncs;
-/* Context for a connection to Redis */
-typedef struct redisContext {
- const redisContextFuncs *funcs; /* Function table */
+/* Context for a connection to Redict */
+typedef struct redictContext {
+ const redictContextFuncs *funcs; /* Function table */
int err; /* Error flags, 0 when there is no error */
char errstr[128]; /* String representation of error when applicable */
- redisFD fd;
+ redictFD fd;
int flags;
char *obuf; /* Write buffer */
- redisReader *reader; /* Protocol reader */
+ redictReader *reader; /* Protocol reader */
- enum redisConnectionType connection_type;
+ enum redictConnectionType connection_type;
struct timeval *connect_timeout;
struct timeval *command_timeout;
@@ -267,30 +267,30 @@ typedef struct redisContext {
size_t addrlen;
/* Optional data and corresponding destructor users can use to provide
- * context to a given redisContext. Not used by hiredis. */
+ * context to a given redictContext. Not used by hiredict. */
void *privdata;
void (*free_privdata)(void *);
- /* Internal context pointer presently used by hiredis to manage
+ /* Internal context pointer presently used by hiredict 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,
+ redictPushFn *push_cb;
+} redictContext;
+
+redictContext *redictConnectWithOptions(const redictOptions *options);
+redictContext *redictConnect(const char *ip, int port);
+redictContext *redictConnectWithTimeout(const char *ip, int port, const struct timeval tv);
+redictContext *redictConnectNonBlock(const char *ip, int port);
+redictContext *redictConnectBindNonBlock(const char *ip, int port,
const char *source_addr);
-redisContext *redisConnectBindNonBlockWithReuse(const char *ip, int port,
+redictContext *redictConnectBindNonBlockWithReuse(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);
+redictContext *redictConnectUnix(const char *path);
+redictContext *redictConnectUnixWithTimeout(const char *path, const struct timeval tv);
+redictContext *redictConnectUnixNonBlock(const char *path);
+redictContext *redictConnectFd(redictFD fd);
/**
* Reconnect the given context using the saved information.
@@ -299,45 +299,45 @@ redisContext *redisConnectFd(redisFD fd);
* 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.
+ * Returns REDICT_OK on successful connect or REDICT_ERR otherwise.
*/
-int redisReconnect(redisContext *c);
-
-redisPushFn *redisSetPushCallback(redisContext *c, redisPushFn *fn);
-int redisSetTimeout(redisContext *c, const struct timeval tv);
-int redisEnableKeepAlive(redisContext *c);
-int redisEnableKeepAliveWithInterval(redisContext *c, int interval);
-int redisSetTcpUserTimeout(redisContext *c, unsigned int timeout);
-void redisFree(redisContext *c);
-redisFD redisFreeKeepFd(redisContext *c);
-int redisBufferRead(redisContext *c);
-int redisBufferWrite(redisContext *c, int *done);
+int redictReconnect(redictContext *c);
+
+redictPushFn *redictSetPushCallback(redictContext *c, redictPushFn *fn);
+int redictSetTimeout(redictContext *c, const struct timeval tv);
+int redictEnableKeepAlive(redictContext *c);
+int redictEnableKeepAliveWithInterval(redictContext *c, int interval);
+int redictSetTcpUserTimeout(redictContext *c, unsigned int timeout);
+void redictFree(redictContext *c);
+redictFD redictFreeKeepFd(redictContext *c);
+int redictBufferRead(redictContext *c);
+int redictBufferWrite(redictContext *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);
+int redictGetReply(redictContext *c, void **reply);
+int redictGetReplyFromReader(redictContext *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);
+int redictAppendFormattedCommand(redictContext *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);
+int redictvAppendCommand(redictContext *c, const char *format, va_list ap);
+int redictAppendCommand(redictContext *c, const char *format, ...);
+int redictAppendCommandArgv(redictContext *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
+/* Issue a command to Redict. In a blocking context, it is identical to calling
+ * redictAppendCommand, followed by redictGetReply. 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);
+ * only redictAppendCommand and will always return NULL. */
+void *redictvCommand(redictContext *c, const char *format, va_list ap);
+void *redictCommand(redictContext *c, const char *format, ...);
+void *redictCommandArgv(redictContext *c, int argc, const char **argv, const size_t *argvlen);
#ifdef __cplusplus
}