1 | /* |
2 | * Copyright (c) 2009-2011, Salvatore Sanfilippo <antirez at gmail dot com> |
3 | * Copyright (c) 2010-2011, 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_ASYNC_H |
33 | #define __HIREDIS_ASYNC_H |
34 | #include "hiredis.h" |
35 | |
36 | #ifdef __cplusplus |
37 | extern "C" { |
38 | #endif |
39 | |
40 | struct redisAsyncContext; /* need forward declaration of redisAsyncContext */ |
41 | struct dict; /* dictionary header is included in async.c */ |
42 | |
43 | /* Reply callback prototype and container */ |
44 | typedef void (redisCallbackFn)(struct redisAsyncContext*, void*, void*); |
45 | typedef struct redisCallback { |
46 | struct redisCallback *next; /* simple singly linked list */ |
47 | redisCallbackFn *fn; |
48 | int pending_subs; |
49 | void *privdata; |
50 | } redisCallback; |
51 | |
52 | /* List of callbacks for either regular replies or pub/sub */ |
53 | typedef struct redisCallbackList { |
54 | redisCallback *head, *tail; |
55 | } redisCallbackList; |
56 | |
57 | /* Connection callback prototypes */ |
58 | typedef void (redisDisconnectCallback)(const struct redisAsyncContext*, int status); |
59 | typedef void (redisConnectCallback)(const struct redisAsyncContext*, int status); |
60 | typedef void(redisTimerCallback)(void *timer, void *privdata); |
61 | |
62 | /* Context for an async connection to Redis */ |
63 | typedef struct redisAsyncContext { |
64 | /* Hold the regular context, so it can be realloc'ed. */ |
65 | redisContext c; |
66 | |
67 | /* Setup error flags so they can be used directly. */ |
68 | int err; |
69 | char *errstr; |
70 | |
71 | /* Not used by hiredis */ |
72 | void *data; |
73 | void (*dataCleanup)(void *privdata); |
74 | |
75 | /* Event library data and hooks */ |
76 | struct { |
77 | void *data; |
78 | |
79 | /* Hooks that are called when the library expects to start |
80 | * reading/writing. These functions should be idempotent. */ |
81 | void (*addRead)(void *privdata); |
82 | void (*delRead)(void *privdata); |
83 | void (*addWrite)(void *privdata); |
84 | void (*delWrite)(void *privdata); |
85 | void (*cleanup)(void *privdata); |
86 | void (*scheduleTimer)(void *privdata, struct timeval tv); |
87 | } ev; |
88 | |
89 | /* Called when either the connection is terminated due to an error or per |
90 | * user request. The status is set accordingly (REDIS_OK, REDIS_ERR). */ |
91 | redisDisconnectCallback *onDisconnect; |
92 | |
93 | /* Called when the first write event was received. */ |
94 | redisConnectCallback *onConnect; |
95 | |
96 | /* Regular command callbacks */ |
97 | redisCallbackList replies; |
98 | |
99 | /* Address used for connect() */ |
100 | struct sockaddr *saddr; |
101 | size_t addrlen; |
102 | |
103 | /* Subscription callbacks */ |
104 | struct { |
105 | redisCallbackList replies; |
106 | struct dict *channels; |
107 | struct dict *patterns; |
108 | } sub; |
109 | |
110 | /* Any configured RESP3 PUSH handler */ |
111 | redisAsyncPushFn *push_cb; |
112 | } redisAsyncContext; |
113 | |
114 | /* Functions that proxy to hiredis */ |
115 | redisAsyncContext *redisAsyncConnectWithOptions(const redisOptions *options); |
116 | redisAsyncContext *redisAsyncConnect(const char *ip, int port); |
117 | redisAsyncContext *redisAsyncConnectBind(const char *ip, int port, const char *source_addr); |
118 | redisAsyncContext *redisAsyncConnectBindWithReuse(const char *ip, int port, |
119 | const char *source_addr); |
120 | redisAsyncContext *redisAsyncConnectUnix(const char *path); |
121 | int redisAsyncSetConnectCallback(redisAsyncContext *ac, redisConnectCallback *fn); |
122 | int redisAsyncSetDisconnectCallback(redisAsyncContext *ac, redisDisconnectCallback *fn); |
123 | |
124 | redisAsyncPushFn *redisAsyncSetPushCallback(redisAsyncContext *ac, redisAsyncPushFn *fn); |
125 | int redisAsyncSetTimeout(redisAsyncContext *ac, struct timeval tv); |
126 | void redisAsyncDisconnect(redisAsyncContext *ac); |
127 | void redisAsyncFree(redisAsyncContext *ac); |
128 | |
129 | /* Handle read/write events */ |
130 | void redisAsyncHandleRead(redisAsyncContext *ac); |
131 | void redisAsyncHandleWrite(redisAsyncContext *ac); |
132 | void redisAsyncHandleTimeout(redisAsyncContext *ac); |
133 | void redisAsyncRead(redisAsyncContext *ac); |
134 | void redisAsyncWrite(redisAsyncContext *ac); |
135 | |
136 | /* Command functions for an async context. Write the command to the |
137 | * output buffer and register the provided callback. */ |
138 | int redisvAsyncCommand(redisAsyncContext *ac, redisCallbackFn *fn, void *privdata, const char *format, va_list ap); |
139 | int redisAsyncCommand(redisAsyncContext *ac, redisCallbackFn *fn, void *privdata, const char *format, ...); |
140 | int redisAsyncCommandArgv(redisAsyncContext *ac, redisCallbackFn *fn, void *privdata, int argc, const char **argv, const size_t *argvlen); |
141 | int redisAsyncFormattedCommand(redisAsyncContext *ac, redisCallbackFn *fn, void *privdata, const char *cmd, size_t len); |
142 | |
143 | #ifdef __cplusplus |
144 | } |
145 | #endif |
146 | |
147 | #endif |
148 | |