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>
28 typedef struct AsyncIO AsyncIO;
30 #ifndef __CIT_CONTEXT__
31 #define __CIT_CONTEXT__
32 typedef struct CitContext CitContext;
35 typedef enum _eNextState {
55 typedef eNextState (*IO_CallBack)(AsyncIO *IO);
56 typedef eReadState (*IO_LineReaderCallback)(AsyncIO *IO);
57 typedef void (*ParseDNSAnswerCb)(AsyncIO*, unsigned char*, int);
58 typedef void (*FreeDNSReply)(void *DNSData);
61 typedef struct __ReadAsyncMsg {
63 size_t maxlen; /* maximum message length */
65 const char *terminator; /* token signalling EOT */
70 /* if we read maxlen, read until nothing more arives and ignore this. */
72 int crlf; /* CRLF newlines instead of LF */
76 typedef struct _DNSQueryParts {
77 ParseDNSAnswerCb DNS_CB;
80 const char *QueryTYPE;
83 void *VParsedDNSReply;
84 FreeDNSReply DNSReplyFree;
88 typedef struct _evcurl_request_data
91 struct curl_slist *headers;
92 char errdesc[CURL_ERROR_SIZE];
97 long PlainPostDataLen;
102 } evcurl_request_data;
105 typedef struct __evcares_data {
109 ev_timer timeout; /* timeout while requesting ips */
110 short int SourcePort;
112 struct ares_options Options;
113 ares_channel Channel;
114 DNSQueryParts *Query;
116 IO_CallBack Fail; /* the dns lookup didn't work out. */
124 eNextState NextState;
126 /* connection related */
127 ParsedURL *ConnectMe;
129 /* read/send related... */
135 /* when sending from / reading into files, this is used. */
138 ev_cleanup abort_by_shutdown, /* server wants to go down... */
139 db_abort_by_shutdown; /* server wants to go down... */
140 ev_timer conn_fail, /* connection establishing timed out */
141 rw_timeout; /* timeout while sending data */
142 ev_idle unwind_stack, /* get c-ares out of the stack */
143 db_unwind_stack, /* wait for next db operation... */
144 conn_fail_immediate; /* unwind stack, but fail immediately. */
145 ev_io recv_event, /* receive data from the client */
146 send_event, /* send more data to the client */
147 conn_event; /* Connection successfully established */
149 StrBuf *ErrMsg; /* if we fail to connect, or lookup, error goes here. */
151 /* Citadel application callbacks... */
152 IO_CallBack ReadDone, /* Theres new data to read... */
153 SendDone, /* we may send more data */
154 Terminate, /* shutting down... */
155 DBTerminate, /* shutting down... */
156 Timeout, /* Timeout handler;may also be conn. timeout */
157 ConnFail, /* What to do when one connection failed? */
158 ShutdownAbort,/* we're going down. make your piece. */
159 NextDBOperation; /* Perform Database IO */
161 /* if we have linereaders, maybe we want to read more lines before
162 * the real application logic is called? */
163 IO_LineReaderCallback LineReader;
167 evcurl_request_data HttpReq;
169 /* Saving / loading a message async from / to disk */
170 ReadAsyncMsg *ReadMsg;
171 struct CtdlMessage *AsyncMsg;
172 struct recptypes *AsyncRcp;
174 /* Context specific data; Hint: put AsyncIO in there */
175 void *Data; /* application specific data */
176 CitContext *CitContext; /* Citadel Session context... */
179 typedef struct _IOAddHandler {
186 extern int DebugEventLoop;
187 extern int DebugCAres;
189 #define EDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugEventLoop != 0))
191 #define CCID ((CitContext*)IO->CitContext)->cs_pid
193 #define EVQ_syslog(LEVEL, FORMAT, ...) \
194 EDBGLOG (LEVEL) syslog(LEVEL, "IOQ " FORMAT, __VA_ARGS__)
196 #define EVQM_syslog(LEVEL, FORMAT) \
197 EDBGLOG (LEVEL) syslog(LEVEL, "IO " FORMAT)
199 #define EV_syslog(LEVEL, FORMAT, ...) \
200 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
202 #define EVM_syslog(LEVEL, FORMAT) \
203 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
205 #define EVNC_syslog(LEVEL, FORMAT, ...) \
206 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld] " FORMAT, IO->ID, __VA_ARGS__)
208 #define EVNCM_syslog(LEVEL, FORMAT) EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID)
211 #define CDBGLOG() if (DebugCAres != 0)
212 #define CEDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugCAres != 0))
213 #define EV_DNS_LOG_START(a) \
214 CDBGLOG () {syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
217 #define EV_DNS_LOG_STOP(a) \
218 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
221 #define EV_DNS_LOG_INIT(a) \
222 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
225 #define EV_DNS_LOGT_START(a) \
226 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
229 #define EV_DNS_LOGT_STOP(a) \
230 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
233 #define EV_DNS_LOGT_INIT(a) \
234 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %p", IO->ID, CCID, &IO->a); \
237 #define EV_DNS_syslog(LEVEL, FORMAT, ...) \
238 CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
240 #define EVM_DNS_syslog(LEVEL, FORMAT) \
241 CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
243 void FreeAsyncIOContents(AsyncIO *IO);
245 eNextState NextDBOperation(AsyncIO *IO, IO_CallBack CB);
246 eNextState QueueDBOperation(AsyncIO *IO, IO_CallBack CB);
247 void StopDBWatchers(AsyncIO *IO);
248 eNextState QueueEventContext(AsyncIO *IO, IO_CallBack CB);
249 eNextState QueueCurlContext(AsyncIO *IO);
251 eNextState EvConnectSock(AsyncIO *IO,
253 double first_rw_timeout,
255 void IO_postdns_callback(struct ev_loop *loop, ev_idle *watcher, int revents);
257 int QueueQuery(ns_type Type,
260 DNSQueryParts *QueryParts,
261 IO_CallBack PostDNS);
263 void QueueGetHostByName(AsyncIO *IO,
264 const char *Hostname,
265 DNSQueryParts *QueryParts,
266 IO_CallBack PostDNS);
268 void QueryCbDone(AsyncIO *IO);
270 void StopClient(AsyncIO *IO);
272 void StopClientWatchers(AsyncIO *IO, int CloseFD);
274 void SetNextTimeout(AsyncIO *IO, double timeout);
276 #include <curl/curl.h>
280 sta = curl_easy_setopt(chnd, (CURLOPT_##s), (v)); \
282 EVQ_syslog(LOG_ERR, \
283 "error setting option " #s \
284 " on curl handle: %s", \
285 curl_easy_strerror(sta)); \
288 void InitIOStruct(AsyncIO *IO,
290 eNextState NextState,
291 IO_LineReaderCallback LineReader,
292 IO_CallBack DNS_Fail,
293 IO_CallBack SendDone,
294 IO_CallBack ReadDone,
295 IO_CallBack Terminate,
296 IO_CallBack DBTerminate,
297 IO_CallBack ConnFail,
299 IO_CallBack ShutdownAbort);
301 int InitcURLIOStruct(AsyncIO *IO,
304 IO_CallBack SendDone,
305 IO_CallBack Terminate,
306 IO_CallBack DBTerminate,
307 IO_CallBack ShutdownAbort);
308 void KillAsyncIOContext(AsyncIO *IO);
309 void StopCurlWatchers(AsyncIO *IO);
312 eNextState ReAttachIO(AsyncIO *IO,
316 void EV_backtrace(AsyncIO *IO);
317 ev_tstamp ctdl_ev_now (void);
319 #endif /* __EVENT_CLIENT_H__ */