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 __eIOState {
67 typedef enum _eNextState {
87 void SetEVState(AsyncIO *IO, eIOState State);
89 typedef eNextState (*IO_CallBack)(AsyncIO *IO);
90 typedef eReadState (*IO_LineReaderCallback)(AsyncIO *IO);
91 typedef void (*ParseDNSAnswerCb)(AsyncIO*, unsigned char*, int);
92 typedef void (*FreeDNSReply)(void *DNSData);
95 typedef struct __ReadAsyncMsg {
97 size_t maxlen; /* maximum message length */
99 const char *terminator; /* token signalling EOT */
104 /* if we read maxlen, read until nothing more arives and ignore this. */
106 int crlf; /* CRLF newlines instead of LF */
110 typedef struct _DNSQueryParts {
111 ParseDNSAnswerCb DNS_CB;
114 const char *QueryTYPE;
117 void *VParsedDNSReply;
118 FreeDNSReply DNSReplyFree;
122 typedef struct _evcurl_request_data
125 struct curl_slist *headers;
126 char errdesc[CURL_ERROR_SIZE];
127 const char *CurlError;
132 long PlainPostDataLen;
137 } evcurl_request_data;
140 typedef struct __evcares_data {
144 ev_timer timeout; /* timeout while requesting ips */
145 short int SourcePort;
147 struct ares_options Options;
148 ares_channel Channel;
149 DNSQueryParts *Query;
151 IO_CallBack Fail; /* the dns lookup didn't work out. */
159 eNextState NextState;
161 /* connection related */
162 ParsedURL *ConnectMe;
164 /* read/send related... */
170 /* when sending from / reading into files, this is used. */
173 ev_cleanup abort_by_shutdown, /* server wants to go down... */
174 db_abort_by_shutdown; /* server wants to go down... */
175 ev_timer conn_fail, /* connection establishing timed out */
176 rw_timeout; /* timeout while sending data */
177 ev_idle unwind_stack, /* get c-ares out of the stack */
178 db_unwind_stack, /* wait for next db operation... */
179 conn_fail_immediate; /* unwind stack, but fail immediately. */
180 ev_io recv_event, /* receive data from the client */
181 send_event, /* send more data to the client */
182 conn_event; /* Connection successfully established */
184 StrBuf *ErrMsg; /* if we fail to connect, or lookup, error goes here. */
186 /* Citadel application callbacks... */
187 IO_CallBack ReadDone, /* Theres new data to read... */
188 SendDone, /* we may send more data */
189 Terminate, /* shutting down... */
190 DBTerminate, /* shutting down... */
191 Timeout, /* Timeout handler;may also be conn. timeout */
192 ConnFail, /* What to do when one connection failed? */
193 ShutdownAbort,/* we're going down. make your piece. */
194 NextDBOperation; /* Perform Database IO */
196 /* if we have linereaders, maybe we want to read more lines before
197 * the real application logic is called? */
198 IO_LineReaderCallback LineReader;
202 evcurl_request_data HttpReq;
204 /* Saving / loading a message async from / to disk */
205 ReadAsyncMsg *ReadMsg;
206 struct CtdlMessage *AsyncMsg;
207 struct recptypes *AsyncRcp;
209 /* Context specific data; Hint: put AsyncIO in there */
210 void *Data; /* application specific data */
211 CitContext *CitContext; /* Citadel Session context... */
214 typedef struct _IOAddHandler {
221 extern int DebugEventLoop;
222 extern int DebugCAres;
224 #define EDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugEventLoop != 0))
226 #define CCID ((CitContext*)IO->CitContext)->cs_pid
228 #define EVQ_syslog(LEVEL, FORMAT, ...) \
229 EDBGLOG (LEVEL) syslog(LEVEL, "IOQ " FORMAT, __VA_ARGS__)
231 #define EVQM_syslog(LEVEL, FORMAT) \
232 EDBGLOG (LEVEL) syslog(LEVEL, "IO " FORMAT)
234 #define EV_syslog(LEVEL, FORMAT, ...) \
235 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
237 #define EVM_syslog(LEVEL, FORMAT) \
238 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
240 #define EVNC_syslog(LEVEL, FORMAT, ...) \
241 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld] " FORMAT, IO->ID, __VA_ARGS__)
243 #define EVNCM_syslog(LEVEL, FORMAT) EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID)
246 #define CDBGLOG() if (DebugCAres != 0)
247 #define CEDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugCAres != 0))
248 #define EV_DNS_LOG_START(a) \
249 CDBGLOG () {syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
252 #define EV_DNS_LOG_STOP(a) \
253 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
256 #define EV_DNS_LOG_INIT(a) \
257 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
260 #define EV_DNS_LOGT_START(a) \
261 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
264 #define EV_DNS_LOGT_STOP(a) \
265 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
268 #define EV_DNS_LOGT_INIT(a) \
269 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %p", IO->ID, CCID, &IO->a); \
272 #define EV_DNS_syslog(LEVEL, FORMAT, ...) \
273 CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
275 #define EVM_DNS_syslog(LEVEL, FORMAT) \
276 CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
278 void FreeAsyncIOContents(AsyncIO *IO);
280 eNextState NextDBOperation(AsyncIO *IO, IO_CallBack CB);
281 eNextState QueueDBOperation(AsyncIO *IO, IO_CallBack CB);
282 eNextState EventQueueDBOperation(AsyncIO *IO, IO_CallBack CB);
283 void StopDBWatchers(AsyncIO *IO);
284 eNextState QueueEventContext(AsyncIO *IO, IO_CallBack CB);
285 eNextState QueueCurlContext(AsyncIO *IO);
286 eNextState DBQueueEventContext(AsyncIO *IO, IO_CallBack CB);
288 eNextState EvConnectSock(AsyncIO *IO,
290 double first_rw_timeout,
292 void IO_postdns_callback(struct ev_loop *loop, ev_idle *watcher, int revents);
294 int QueueQuery(ns_type Type,
297 DNSQueryParts *QueryParts,
298 IO_CallBack PostDNS);
300 void QueueGetHostByName(AsyncIO *IO,
301 const char *Hostname,
302 DNSQueryParts *QueryParts,
303 IO_CallBack PostDNS);
305 void QueryCbDone(AsyncIO *IO);
307 void StopClient(AsyncIO *IO);
309 void StopClientWatchers(AsyncIO *IO, int CloseFD);
311 void SetNextTimeout(AsyncIO *IO, double timeout);
313 #include <curl/curl.h>
317 sta = curl_easy_setopt(chnd, (CURLOPT_##s), (v)); \
319 EVQ_syslog(LOG_ERR, \
320 "error setting option " #s \
321 " on curl handle: %s", \
322 curl_easy_strerror(sta)); \
325 void InitIOStruct(AsyncIO *IO,
327 eNextState NextState,
328 IO_LineReaderCallback LineReader,
329 IO_CallBack DNS_Fail,
330 IO_CallBack SendDone,
331 IO_CallBack ReadDone,
332 IO_CallBack Terminate,
333 IO_CallBack DBTerminate,
334 IO_CallBack ConnFail,
336 IO_CallBack ShutdownAbort);
338 int InitcURLIOStruct(AsyncIO *IO,
341 IO_CallBack SendDone,
342 IO_CallBack Terminate,
343 IO_CallBack DBTerminate,
344 IO_CallBack ShutdownAbort);
345 void KillAsyncIOContext(AsyncIO *IO);
346 void StopCurlWatchers(AsyncIO *IO);
348 eNextState CurlQueueDBOperation(AsyncIO *IO, IO_CallBack CB);
350 eNextState ReAttachIO(AsyncIO *IO,
354 void EV_backtrace(AsyncIO *IO);
355 ev_tstamp ctdl_ev_now (void);
357 #endif /* __EVENT_CLIENT_H__ */