deps/hiredis/hiredis.h

   1 /*
   2  * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
   3  * Copyright (c) 2010, Pieter Noordhuis <pcnoordhuis at gmail dot com>
   4  *
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions are met:
   9  *
  10  *   * Redistributions of source code must retain the above copyright notice,
  11  *     this list of conditions and the following disclaimer.
  12  *   * Redistributions in binary form must reproduce the above copyright
  13  *     notice, this list of conditions and the following disclaimer in the
  14  *     documentation and/or other materials provided with the distribution.
  15  *   * Neither the name of Redis nor the names of its contributors may be used
  16  *     to endorse or promote products derived from this software without
  17  *     specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef __HIREDIS_H
  33 #define __HIREDIS_H
  34 #include <stdio.h> /* for size_t */
  35 #include <stdarg.h> /* for va_list */
  36 #include <sys/time.h> /* for struct timeval */
  37
  38 #define HIREDIS_MAJOR 0
  39 #define HIREDIS_MINOR 9
  40 #define HIREDIS_PATCH 2
  41
  42 #define REDIS_ERR -1
  43 #define REDIS_OK 0
  44
  45 /* When an error occurs, the err flag in a context is set to hold the type of
  46  * error that occured. REDIS_ERR_IO means there was an I/O error and you
  47  * should use the "errno" variable to find out what is wrong.
  48  * For other values, the "errstr" field will hold a description. */
  49 #define REDIS_ERR_IO 1 /* error in read or write */
  50 #define REDIS_ERR_EOF 3 /* eof */
  51 #define REDIS_ERR_PROTOCOL 4 /* protocol error */
  52 #define REDIS_ERR_OTHER 2 /* something else */
  53
  54 /* Connection type can be blocking or non-blocking and is set in the
  55  * least significant bit of the flags field in redisContext. */
  56 #define REDIS_BLOCK 0x1
  57
  58 /* Connection may be disconnected before being free'd. The second bit
  59  * in the flags field is set when the context is connected. */
  60 #define REDIS_CONNECTED 0x2
  61
  62 /* The async API might try to disconnect cleanly and flush the output
  63  * buffer and read all subsequent replies before disconnecting.
  64  * This flag means no new commands can come in and the connection
  65  * should be terminated once all replies have been read. */
  66 #define REDIS_DISCONNECTING 0x4
  67
  68 /* Flag specific to the async API which means that the context should be clean
  69  * up as soon as possible. */
  70 #define REDIS_FREEING 0x8
  71
  72 /* Flag that is set when an async callback is executed. */
  73 #define REDIS_IN_CALLBACK 0x10
  74
  75 /* Flag that is set when the async context has one or more subscriptions. */
  76 #define REDIS_SUBSCRIBED 0x20
  77
  78 #define REDIS_REPLY_STRING 1
  79 #define REDIS_REPLY_ARRAY 2
  80 #define REDIS_REPLY_INTEGER 3
  81 #define REDIS_REPLY_NIL 4
  82 #define REDIS_REPLY_STATUS 5
  83 #define REDIS_REPLY_ERROR 6
  84
  85 #ifdef __cplusplus
  86 extern "C" {
  87 #endif
  88
  89 /* This is the reply object returned by redisCommand() */
  90 typedef struct redisReply {
  91     int type; /* REDIS_REPLY_* */
  92     long long integer; /* The integer when type is REDIS_REPLY_INTEGER */
  93     int len; /* Length of string */
  94     char *str; /* Used for both REDIS_REPLY_ERROR and REDIS_REPLY_STRING */
  95     size_t elements; /* number of elements, for REDIS_REPLY_ARRAY */
  96     struct redisReply **element; /* elements vector for REDIS_REPLY_ARRAY */
  97 } redisReply;
  98
  99 typedef struct redisReadTask {
 100     int type;
 101     int elements; /* number of elements in multibulk container */
 102     int idx; /* index in parent (array) object */
 103     void *obj; /* holds user-generated value for a read task */
 104     struct redisReadTask *parent; /* parent task */
 105     void *privdata; /* user-settable arbitrary field */
 106 } redisReadTask;
 107
 108 typedef struct redisReplyObjectFunctions {
 109     void *(*createString)(const redisReadTask*, char*, size_t);
 110     void *(*createArray)(const redisReadTask*, int);
 111     void *(*createInteger)(const redisReadTask*, long long);
 112     void *(*createNil)(const redisReadTask*);
 113     void (*freeObject)(void*);
 114 } redisReplyObjectFunctions;
 115
 116 struct redisContext; /* need forward declaration of redisContext */
 117
 118 /* Context for a connection to Redis */
 119 typedef struct redisContext {
 120     int fd;
 121     int flags;
 122     char *obuf; /* Write buffer */
 123     int err; /* Error flags, 0 when there is no error */
 124     char *errstr; /* String representation of error when applicable */
 125
 126     /* Function set for reply buildup and reply reader */
 127     redisReplyObjectFunctions *fn;
 128     void *reader;
 129 } redisContext;
 130
 131 void freeReplyObject(void *reply);
 132 void *redisReplyReaderCreate(void);
 133 int redisReplyReaderSetReplyObjectFunctions(void *reader, redisReplyObjectFunctions *fn);
 134 int redisReplyReaderSetPrivdata(void *reader, void *privdata);
 135 void *redisReplyReaderGetObject(void *reader);
 136 char *redisReplyReaderGetError(void *reader);
 137 void redisReplyReaderFree(void *ptr);
 138 void redisReplyReaderFeed(void *reader, const char *buf, size_t len);
 139 int redisReplyReaderGetReply(void *reader, void **reply);
 140
 141 /* Functions to format a command according to the protocol. */
 142 int redisvFormatCommand(char **target, const char *format, va_list ap);
 143 int redisFormatCommand(char **target, const char *format, ...);
 144 int redisFormatCommandArgv(char **target, int argc, const char **argv, const size_t *argvlen);
 145
 146 redisContext *redisConnect(const char *ip, int port);
 147 redisContext *redisConnectWithTimeout(const char *ip, int port, struct timeval tv);
 148 redisContext *redisConnectNonBlock(const char *ip, int port);
 149 redisContext *redisConnectUnix(const char *path);
 150 redisContext *redisConnectUnixWithTimeout(const char *path, struct timeval tv);
 151 redisContext *redisConnectUnixNonBlock(const char *path);
 152 int redisSetTimeout(redisContext *c, struct timeval tv);
 153 int redisSetReplyObjectFunctions(redisContext *c, redisReplyObjectFunctions *fn);
 154 void redisFree(redisContext *c);
 155 int redisBufferRead(redisContext *c);
 156 int redisBufferWrite(redisContext *c, int *done);
 157
 158 /* In a blocking context, this function first checks if there are unconsumed
 159  * replies to return and returns one if so. Otherwise, it flushes the output
 160  * buffer to the socket and reads until it has a reply. In a non-blocking
 161  * context, it will return unconsumed replies until there are no more. */
 162 int redisGetReply(redisContext *c, void **reply);
 163 int redisGetReplyFromReader(redisContext *c, void **reply);
 164
 165 /* Write a command to the output buffer. Use these functions in blocking mode
 166  * to get a pipeline of commands. */
 167 void redisvAppendCommand(redisContext *c, const char *format, va_list ap);
 168 void redisAppendCommand(redisContext *c, const char *format, ...);
 169 void redisAppendCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);
 170
 171 /* Issue a command to Redis. In a blocking context, it is identical to calling
 172  * redisAppendCommand, followed by redisGetReply. The function will return
 173  * NULL if there was an error in performing the request, otherwise it will
 174  * return the reply. In a non-blocking context, it is identical to calling
 175  * only redisAppendCommand and will always return NULL. */
 176 void *redisvCommand(redisContext *c, const char *format, va_list ap);
 177 void *redisCommand(redisContext *c, const char *format, ...);
 178 void *redisCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);
 179
 180 #ifdef __cplusplus
 181 }
 182 #endif
 183
 184 #endif