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, version 3.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
14 #ifndef __EVENT_CLIENT_H__
15 #define __EVENT_CLIENT_H__
17 #include "sysconfig.h"
19 #include <sys/types.h>
20 #include <sys/socket.h>
22 #include <arpa/nameser.h>
24 #include <curl/curl.h>
26 typedef struct AsyncIO AsyncIO;
28 typedef enum _eNextState {
48 typedef eNextState (*IO_CallBack)(AsyncIO *IO);
49 typedef eReadState (*IO_LineReaderCallback)(AsyncIO *IO);
50 typedef void (*ParseDNSAnswerCb)(AsyncIO*, unsigned char*, int);
51 typedef void (*FreeDNSReply)(void *DNSData);
54 typedef struct __ReadAsyncMsg {
56 size_t maxlen; /* maximum message length */
58 const char *terminator; /* token signalling EOT */
63 /* if we read maxlen, read until nothing more arives and ignore this. */
65 int crlf; /* CRLF newlines instead of LF */
69 typedef struct _DNSQueryParts {
70 ParseDNSAnswerCb DNS_CB;
74 void *VParsedDNSReply;
75 FreeDNSReply DNSReplyFree;
79 typedef struct _evcurl_request_data
82 struct curl_slist *headers;
83 char errdesc[CURL_ERROR_SIZE];
88 long PlainPostDataLen;
93 } evcurl_request_data;
96 typedef struct __evcares_data {
100 ev_timer timeout; /* timeout while requesting ips */
101 short int SourcePort;
103 struct ares_options Options;
104 ares_channel Channel;
105 DNSQueryParts *Query;
107 IO_CallBack Fail; /* the dns lookup didn't work out. */
115 eNextState NextState;
117 /* connection related */
118 ParsedURL *ConnectMe;
120 /* read/send related... */
126 /* when sending from / reading into files, this is used. */
129 ev_cleanup abort_by_shutdown, /* server wants to go down... */
130 db_abort_by_shutdown; /* server wants to go down... */
131 ev_timer conn_fail, /* connection establishing timed out */
132 rw_timeout; /* timeout while sending data */
133 ev_idle unwind_stack, /* get c-ares out of the stack */
134 db_unwind_stack, /* wait for next db operation... */
135 conn_fail_immediate; /* unwind stack, but fail immediately. */
136 ev_io recv_event, /* receive data from the client */
137 send_event, /* send more data to the client */
138 conn_event; /* Connection successfully established */
140 StrBuf *ErrMsg; /* if we fail to connect, or lookup, error goes here. */
142 /* Citadel application callbacks... */
143 IO_CallBack ReadDone, /* Theres new data to read... */
144 SendDone, /* we may send more data */
145 Terminate, /* shutting down... */
146 DBTerminate, /* shutting down... */
147 Timeout, /* Timeout handler;may also be conn. timeout */
148 ConnFail, /* What to do when one connection failed? */
149 ShutdownAbort,/* we're going down. make your piece. */
150 NextDBOperation; /* Perform Database IO */
152 /* if we have linereaders, maybe we want to read more lines before
153 * the real application logic is called? */
154 IO_LineReaderCallback LineReader;
158 evcurl_request_data HttpReq;
160 /* Saving / loading a message async from / to disk */
161 ReadAsyncMsg *ReadMsg;
162 struct CtdlMessage *AsyncMsg;
163 struct recptypes *AsyncRcp;
165 /* Context specific data; Hint: put AsyncIO in there */
166 void *Data; /* application specific data */
167 void *CitContext; /* Citadel Session context... */
170 typedef struct _IOAddHandler {
177 extern int DebugEventLoop;
178 extern int DebugCAres;
180 #define EDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugEventLoop != 0))
182 #define CCID ((CitContext*)IO->CitContext)->cs_pid
184 #define EVQ_syslog(LEVEL, FORMAT, ...) \
185 EDBGLOG (LEVEL) syslog(LEVEL, "IOQ " FORMAT, __VA_ARGS__)
187 #define EVQM_syslog(LEVEL, FORMAT) \
188 EDBGLOG (LEVEL) syslog(LEVEL, "IO " FORMAT)
190 #define EV_syslog(LEVEL, FORMAT, ...) \
191 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
193 #define EVM_syslog(LEVEL, FORMAT) \
194 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
196 #define EVNC_syslog(LEVEL, FORMAT, ...) \
197 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld] " FORMAT, IO->ID, __VA_ARGS__)
199 #define EVNCM_syslog(LEVEL, FORMAT) EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID)
202 #define CDBGLOG() if (DebugCAres != 0)
203 #define CEDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugCAres != 0))
204 #define EV_DNS_LOG_START(a) \
205 CDBGLOG () {syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
208 #define EV_DNS_LOG_STOP(a) \
209 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
212 #define EV_DNS_LOG_INIT(a) \
213 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
216 #define EV_DNS_LOGT_START(a) \
217 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
220 #define EV_DNS_LOGT_STOP(a) \
221 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
224 #define EV_DNS_LOGT_INIT(a) \
225 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %p", IO->ID, CCID, &IO->a); \
228 #define EV_DNS_syslog(LEVEL, FORMAT, ...) \
229 CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
231 #define EVM_DNS_syslog(LEVEL, FORMAT) \
232 CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
234 void FreeAsyncIOContents(AsyncIO *IO);
236 eNextState NextDBOperation(AsyncIO *IO, IO_CallBack CB);
237 eNextState QueueDBOperation(AsyncIO *IO, IO_CallBack CB);
238 void StopDBWatchers(AsyncIO *IO);
239 eNextState QueueEventContext(AsyncIO *IO, IO_CallBack CB);
240 eNextState QueueCurlContext(AsyncIO *IO);
242 eNextState EvConnectSock(AsyncIO *IO,
244 double first_rw_timeout,
246 void IO_postdns_callback(struct ev_loop *loop, ev_idle *watcher, int revents);
248 int QueueQuery(ns_type Type,
251 DNSQueryParts *QueryParts,
252 IO_CallBack PostDNS);
254 void QueueGetHostByName(AsyncIO *IO,
255 const char *Hostname,
256 DNSQueryParts *QueryParts,
257 IO_CallBack PostDNS);
259 void QueryCbDone(AsyncIO *IO);
261 void StopClient(AsyncIO *IO);
263 void StopClientWatchers(AsyncIO *IO, int CloseFD);
265 void SetNextTimeout(AsyncIO *IO, double timeout);
267 #include <curl/curl.h>
271 sta = curl_easy_setopt(chnd, (CURLOPT_##s), (v)); \
273 EVQ_syslog(LOG_ERR, \
274 "error setting option " #s \
275 " on curl handle: %s", \
276 curl_easy_strerror(sta)); \
279 void InitIOStruct(AsyncIO *IO,
281 eNextState NextState,
282 IO_LineReaderCallback LineReader,
283 IO_CallBack DNS_Fail,
284 IO_CallBack SendDone,
285 IO_CallBack ReadDone,
286 IO_CallBack Terminate,
287 IO_CallBack DBTerminate,
288 IO_CallBack ConnFail,
290 IO_CallBack ShutdownAbort);
292 int InitcURLIOStruct(AsyncIO *IO,
295 IO_CallBack SendDone,
296 IO_CallBack Terminate,
297 IO_CallBack DBTerminate,
298 IO_CallBack ShutdownAbort);
300 void StopCurlWatchers(AsyncIO *IO);
303 eNextState ReAttachIO(AsyncIO *IO,
307 void EV_backtrace(AsyncIO *IO);
308 ev_tstamp ctdl_ev_now (void);
310 #endif /* __EVENT_CLIENT_H__ */