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 extern pthread_key_t evConKey;
37 typedef enum __eIOState {
69 typedef enum _eNextState {
89 void SetEVState(AsyncIO *IO, eIOState State);
91 typedef eNextState (*IO_CallBack)(AsyncIO *IO);
92 typedef eReadState (*IO_LineReaderCallback)(AsyncIO *IO);
93 typedef void (*ParseDNSAnswerCb)(AsyncIO*, unsigned char*, int);
94 typedef void (*FreeDNSReply)(void *DNSData);
97 typedef struct __ReadAsyncMsg {
99 size_t maxlen; /* maximum message length */
101 const char *terminator; /* token signalling EOT */
106 /* if we read maxlen, read until nothing more arives and ignore this. */
108 int crlf; /* CRLF newlines instead of LF */
112 typedef struct _DNSQueryParts {
113 ParseDNSAnswerCb DNS_CB;
116 const char *QueryTYPE;
119 void *VParsedDNSReply;
120 FreeDNSReply DNSReplyFree;
124 typedef struct _evcurl_request_data
127 struct curl_slist *headers;
128 char errdesc[CURL_ERROR_SIZE];
129 const char *CurlError;
134 long PlainPostDataLen;
139 } evcurl_request_data;
142 typedef struct __evcares_data {
146 ev_timer timeout; /* timeout while requesting ips */
147 short int SourcePort;
149 struct ares_options Options;
150 ares_channel Channel;
151 DNSQueryParts *Query;
153 IO_CallBack Fail; /* the dns lookup didn't work out. */
162 eNextState NextState;
164 /* connection related */
165 ParsedURL *ConnectMe;
167 /* read/send related... */
173 /* when sending from / reading into files, this is used. */
176 ev_cleanup abort_by_shutdown, /* server wants to go down... */
177 db_abort_by_shutdown; /* server wants to go down... */
178 ev_timer conn_fail, /* connection establishing timed out */
179 rw_timeout; /* timeout while sending data */
180 ev_idle unwind_stack, /* get c-ares out of the stack */
181 db_unwind_stack, /* wait for next db operation... */
182 conn_fail_immediate; /* unwind stack, but fail immediately. */
183 ev_io recv_event, /* receive data from the client */
184 send_event, /* send more data to the client */
185 conn_event; /* Connection successfully established */
187 StrBuf *ErrMsg; /* if we fail to connect, or lookup, error goes here. */
189 /* Citadel application callbacks... */
190 IO_CallBack ReadDone, /* Theres new data to read... */
191 SendDone, /* we may send more data */
192 Terminate, /* shutting down... */
193 DBTerminate, /* shutting down... */
194 Timeout, /* Timeout handler;may also be conn. timeout */
195 ConnFail, /* What to do when one connection failed? */
196 ShutdownAbort,/* we're going down. make your piece. */
197 NextDBOperation, /* Perform Database IO */
198 ReAttachCB; /* on the hop from one Q to the other, this is the next CB */
200 /* if we have linereaders, maybe we want to read more lines before
201 * the real application logic is called? */
202 IO_LineReaderCallback LineReader;
206 evcurl_request_data HttpReq;
208 /* Saving / loading a message async from / to disk */
209 ReadAsyncMsg *ReadMsg;
210 struct CtdlMessage *AsyncMsg;
213 /* Context specific data; Hint: put AsyncIO in there */
214 void *Data; /* application specific data */
215 CitContext *CitContext; /* Citadel Session context... */
218 typedef struct _IOAddHandler {
224 inline static time_t EvGetNow(AsyncIO *IO) { return (time_t) IO->Now;}
226 extern int DebugEventLoop;
227 extern int DebugCAres;
229 #define IOSTR (const char *) pthread_getspecific(evConKey)
231 #define EDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugEventLoop != 0))
233 #define CCID ((CitContext*)IO->CitContext)?((CitContext*)IO->CitContext)->cs_pid:-1
235 #define EVQ_syslog(LEVEL, FORMAT, ...) \
236 EDBGLOG (LEVEL) syslog(LEVEL, "%sQ " FORMAT, IOSTR, __VA_ARGS__)
238 #define EVQM_syslog(LEVEL, FORMAT) \
239 EDBGLOG (LEVEL) syslog(LEVEL, "%s " FORMAT, IOSTR)
241 #define EV_syslog(LEVEL, FORMAT, ...) \
242 EDBGLOG (LEVEL) syslog(LEVEL, "%s[%ld]CC[%d] " FORMAT, IOSTR, IO->ID, CCID, __VA_ARGS__)
244 #define EVM_syslog(LEVEL, FORMAT) \
245 EDBGLOG (LEVEL) syslog(LEVEL, "%s[%ld]CC[%d] " FORMAT, IOSTR, IO->ID, CCID)
247 #define EVNC_syslog(LEVEL, FORMAT, ...) \
248 EDBGLOG (LEVEL) syslog(LEVEL, "%s[%ld] " FORMAT, IOSTR, IO->ID, __VA_ARGS__)
250 #define EVNCM_syslog(LEVEL, FORMAT) EDBGLOG (LEVEL) syslog(LEVEL, "%s[%ld]" FORMAT, IOSTR, IO->ID)
253 #define CDBGLOG() if (DebugCAres != 0)
254 #define CEDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugCAres != 0))
255 #define EV_DNS_LOG_START(a) \
256 CDBGLOG () {syslog(LOG_DEBUG, "%s[%ld]CC[%d] + Starting " #a " %s %p FD %d", IOSTR, IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
259 #define EV_DNS_LOG_STOP(a) \
260 CDBGLOG () { syslog(LOG_DEBUG, "%s[%ld]CC[%d] - Stopping " #a " %s %p FD %d", IOSTR, IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
263 #define EV_DNS_LOG_INIT(a) \
264 CDBGLOG () { syslog(LOG_DEBUG, "%s[%ld]CC[%d] * Init " #a " %s %p FD %d", IOSTR, IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
267 #define EV_DNS_LOGT_START(a) \
268 CDBGLOG () { syslog(LOG_DEBUG, "%s[%ld]CC[%d] + Starting " #a " %s %p", IOSTR, IO->ID, CCID, __FUNCTION__, &IO->a); \
271 #define EV_DNS_LOGT_STOP(a) \
272 CDBGLOG () { syslog(LOG_DEBUG, "%s[%ld]CC[%d] - Stopping " #a " %s %p", IOSTR, IO->ID, CCID, __FUNCTION__, &IO->a); \
275 #define EV_DNS_LOGT_INIT(a) \
276 CDBGLOG () { syslog(LOG_DEBUG, "%s[%ld]CC[%d] * Init " #a " %p", IOSTR, IO->ID, CCID, &IO->a); \
279 #define EV_DNS_syslog(LEVEL, FORMAT, ...) \
280 CEDBGLOG (LEVEL) syslog(LEVEL, "%s[%ld]CC[%d] " FORMAT, IOSTR, IO->ID, CCID, __VA_ARGS__)
282 #define EVM_DNS_syslog(LEVEL, FORMAT) \
283 CEDBGLOG (LEVEL) syslog(LEVEL, "%s[%ld]CC[%d] " FORMAT, IOSTR, IO->ID, CCID)
285 void FreeAsyncIOContents(AsyncIO *IO);
287 eNextState NextDBOperation(AsyncIO *IO, IO_CallBack CB);
288 eNextState EventQueueDBOperation(AsyncIO *IO, IO_CallBack CB, int CloseFDs);
289 void StopDBWatchers(AsyncIO *IO);
290 eNextState QueueEventContext(AsyncIO *IO, IO_CallBack CB);
291 eNextState QueueCurlContext(AsyncIO *IO);
292 eNextState DBQueueEventContext(AsyncIO *IO, IO_CallBack CB);
294 eNextState EvConnectSock(AsyncIO *IO,
296 double first_rw_timeout,
298 void IO_postdns_callback(struct ev_loop *loop, ev_idle *watcher, int revents);
300 int QueueQuery(ns_type Type,
303 DNSQueryParts *QueryParts,
304 IO_CallBack PostDNS);
306 void QueueGetHostByName(AsyncIO *IO,
307 const char *Hostname,
308 DNSQueryParts *QueryParts,
309 IO_CallBack PostDNS);
311 void QueryCbDone(AsyncIO *IO);
313 void StopClient(AsyncIO *IO);
315 void StopClientWatchers(AsyncIO *IO, int CloseFD);
317 void SetNextTimeout(AsyncIO *IO, double timeout);
319 #include <curl/curl.h>
323 sta = curl_easy_setopt(chnd, (CURLOPT_##s), (v)); \
325 EVQ_syslog(LOG_ERR, \
326 "error setting option " #s \
327 " on curl handle: %s", \
328 curl_easy_strerror(sta)); \
331 void InitIOStruct(AsyncIO *IO,
333 eNextState NextState,
334 IO_LineReaderCallback LineReader,
335 IO_CallBack DNS_Fail,
336 IO_CallBack SendDone,
337 IO_CallBack ReadDone,
338 IO_CallBack Terminate,
339 IO_CallBack DBTerminate,
340 IO_CallBack ConnFail,
342 IO_CallBack ShutdownAbort);
344 int InitcURLIOStruct(AsyncIO *IO,
347 IO_CallBack SendDone,
348 IO_CallBack Terminate,
349 IO_CallBack DBTerminate,
350 IO_CallBack ShutdownAbort);
351 void KillAsyncIOContext(AsyncIO *IO);
352 void StopCurlWatchers(AsyncIO *IO);
354 eNextState CurlQueueDBOperation(AsyncIO *IO, IO_CallBack CB);
356 eNextState ReAttachIO(AsyncIO *IO,
360 void EV_backtrace(AsyncIO *IO);
361 ev_tstamp ctdl_ev_now (void);
363 #endif /* __EVENT_CLIENT_H__ */