3 * Copyright (c) 1998-2012 by the citadel.org team
5 * This program is open source software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #ifndef __EVENT_CLIENT_H__
21 #define __EVENT_CLIENT_H__
23 #include "sysconfig.h"
25 #include <sys/types.h>
26 #include <sys/socket.h>
28 #include <arpa/nameser.h>
30 #include <curl/curl.h>
32 typedef struct AsyncIO AsyncIO;
34 typedef enum _eNextState {
54 typedef eNextState (*IO_CallBack)(AsyncIO *IO);
55 typedef eReadState (*IO_LineReaderCallback)(AsyncIO *IO);
56 typedef void (*ParseDNSAnswerCb)(AsyncIO*, unsigned char*, int);
57 typedef void (*FreeDNSReply)(void *DNSData);
60 typedef struct __ReadAsyncMsg {
62 size_t maxlen; /* maximum message length */
64 const char *terminator; /* token signalling EOT */
69 /* if we read maxlen, read until nothing more arives and ignore this. */
71 int crlf; /* CRLF newlines instead of LF */
75 typedef struct _DNSQueryParts {
76 ParseDNSAnswerCb DNS_CB;
80 void *VParsedDNSReply;
81 FreeDNSReply DNSReplyFree;
85 typedef struct _evcurl_request_data
88 struct curl_slist *headers;
89 char errdesc[CURL_ERROR_SIZE];
94 long PlainPostDataLen;
99 } evcurl_request_data;
102 typedef struct __evcares_data {
106 ev_timer timeout; /* timeout while requesting ips */
107 short int SourcePort;
109 struct ares_options Options;
110 ares_channel Channel;
111 DNSQueryParts *Query;
113 IO_CallBack Fail; /* the dns lookup didn't work out. */
121 eNextState NextState;
123 /* connection related */
124 ParsedURL *ConnectMe;
126 /* read/send related... */
132 /* when sending from / reading into files, this is used. */
135 ev_cleanup abort_by_shutdown, /* server wants to go down... */
136 db_abort_by_shutdown; /* server wants to go down... */
137 ev_timer conn_fail, /* connection establishing timed out */
138 rw_timeout; /* timeout while sending data */
139 ev_idle unwind_stack, /* get c-ares out of the stack */
140 db_unwind_stack, /* wait for next db operation... */
141 conn_fail_immediate; /* unwind stack, but fail immediately. */
142 ev_io recv_event, /* receive data from the client */
143 send_event, /* send more data to the client */
144 conn_event; /* Connection successfully established */
146 StrBuf *ErrMsg; /* if we fail to connect, or lookup, error goes here. */
148 /* Citadel application callbacks... */
149 IO_CallBack ReadDone, /* Theres new data to read... */
150 SendDone, /* we may send more data */
151 Terminate, /* shutting down... */
152 DBTerminate, /* shutting down... */
153 Timeout, /* Timeout handler;may also be conn. timeout */
154 ConnFail, /* What to do when one connection failed? */
155 ShutdownAbort,/* we're going down. make your piece. */
156 NextDBOperation; /* Perform Database IO */
158 /* if we have linereaders, maybe we want to read more lines before
159 * the real application logic is called? */
160 IO_LineReaderCallback LineReader;
164 evcurl_request_data HttpReq;
166 /* Saving / loading a message async from / to disk */
167 ReadAsyncMsg *ReadMsg;
168 struct CtdlMessage *AsyncMsg;
169 struct recptypes *AsyncRcp;
171 /* Context specific data; Hint: put AsyncIO in there */
172 void *Data; /* application specific data */
173 void *CitContext; /* Citadel Session context... */
176 typedef struct _IOAddHandler {
183 extern int DebugEventLoop;
184 extern int DebugCAres;
186 #define EDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugEventLoop != 0))
188 #define CCID ((CitContext*)IO->CitContext)->cs_pid
190 #define EVQ_syslog(LEVEL, FORMAT, ...) \
191 EDBGLOG (LEVEL) syslog(LEVEL, "IOQ " FORMAT, __VA_ARGS__)
193 #define EVQM_syslog(LEVEL, FORMAT) \
194 EDBGLOG (LEVEL) syslog(LEVEL, "IO " FORMAT)
196 #define EV_syslog(LEVEL, FORMAT, ...) \
197 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
199 #define EVM_syslog(LEVEL, FORMAT) \
200 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
202 #define EVNC_syslog(LEVEL, FORMAT, ...) \
203 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld] " FORMAT, IO->ID, __VA_ARGS__)
205 #define EVNCM_syslog(LEVEL, FORMAT) EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID)
208 #define CDBGLOG() if (DebugCAres != 0)
209 #define CEDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugCAres != 0))
210 #define EV_DNS_LOG_START(a) \
211 CDBGLOG () {syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
214 #define EV_DNS_LOG_STOP(a) \
215 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
218 #define EV_DNS_LOG_INIT(a) \
219 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
222 #define EV_DNS_LOGT_START(a) \
223 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
226 #define EV_DNS_LOGT_STOP(a) \
227 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
230 #define EV_DNS_LOGT_INIT(a) \
231 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %p", IO->ID, CCID, &IO->a); \
234 #define EV_DNS_syslog(LEVEL, FORMAT, ...) \
235 CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
237 #define EVM_DNS_syslog(LEVEL, FORMAT) \
238 CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
240 void FreeAsyncIOContents(AsyncIO *IO);
242 eNextState NextDBOperation(AsyncIO *IO, IO_CallBack CB);
243 eNextState QueueDBOperation(AsyncIO *IO, IO_CallBack CB);
244 void StopDBWatchers(AsyncIO *IO);
245 eNextState QueueEventContext(AsyncIO *IO, IO_CallBack CB);
246 eNextState QueueCurlContext(AsyncIO *IO);
248 eNextState EvConnectSock(AsyncIO *IO,
250 double first_rw_timeout,
252 void IO_postdns_callback(struct ev_loop *loop, ev_idle *watcher, int revents);
254 int QueueQuery(ns_type Type,
257 DNSQueryParts *QueryParts,
258 IO_CallBack PostDNS);
260 void QueueGetHostByName(AsyncIO *IO,
261 const char *Hostname,
262 DNSQueryParts *QueryParts,
263 IO_CallBack PostDNS);
265 void QueryCbDone(AsyncIO *IO);
267 void StopClient(AsyncIO *IO);
269 void StopClientWatchers(AsyncIO *IO);
271 void SetNextTimeout(AsyncIO *IO, double timeout);
273 #include <curl/curl.h>
277 sta = curl_easy_setopt(chnd, (CURLOPT_##s), (v)); \
279 EVQ_syslog(LOG_ERR, \
280 "error setting option " #s \
281 " on curl handle: %s", \
282 curl_easy_strerror(sta)); \
285 void InitIOStruct(AsyncIO *IO,
287 eNextState NextState,
288 IO_LineReaderCallback LineReader,
289 IO_CallBack DNS_Fail,
290 IO_CallBack SendDone,
291 IO_CallBack ReadDone,
292 IO_CallBack Terminate,
293 IO_CallBack DBTerminate,
294 IO_CallBack ConnFail,
296 IO_CallBack ShutdownAbort);
298 int InitcURLIOStruct(AsyncIO *IO,
301 IO_CallBack SendDone,
302 IO_CallBack Terminate,
303 IO_CallBack DBTerminate,
304 IO_CallBack ShutdownAbort);
306 eNextState ReAttachIO(AsyncIO *IO,
310 void EV_backtrace(AsyncIO *IO);
311 ev_tstamp ctdl_ev_now (void);
313 #endif /* __EVENT_CLIENT_H__ */