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];
131 long PlainPostDataLen;
136 } evcurl_request_data;
139 typedef struct __evcares_data {
143 ev_timer timeout; /* timeout while requesting ips */
144 short int SourcePort;
146 struct ares_options Options;
147 ares_channel Channel;
148 DNSQueryParts *Query;
150 IO_CallBack Fail; /* the dns lookup didn't work out. */
158 eNextState NextState;
160 /* connection related */
161 ParsedURL *ConnectMe;
163 /* read/send related... */
169 /* when sending from / reading into files, this is used. */
172 ev_cleanup abort_by_shutdown, /* server wants to go down... */
173 db_abort_by_shutdown; /* server wants to go down... */
174 ev_timer conn_fail, /* connection establishing timed out */
175 rw_timeout; /* timeout while sending data */
176 ev_idle unwind_stack, /* get c-ares out of the stack */
177 db_unwind_stack, /* wait for next db operation... */
178 conn_fail_immediate; /* unwind stack, but fail immediately. */
179 ev_io recv_event, /* receive data from the client */
180 send_event, /* send more data to the client */
181 conn_event; /* Connection successfully established */
183 StrBuf *ErrMsg; /* if we fail to connect, or lookup, error goes here. */
185 /* Citadel application callbacks... */
186 IO_CallBack ReadDone, /* Theres new data to read... */
187 SendDone, /* we may send more data */
188 Terminate, /* shutting down... */
189 DBTerminate, /* shutting down... */
190 Timeout, /* Timeout handler;may also be conn. timeout */
191 ConnFail, /* What to do when one connection failed? */
192 ShutdownAbort,/* we're going down. make your piece. */
193 NextDBOperation; /* Perform Database IO */
195 /* if we have linereaders, maybe we want to read more lines before
196 * the real application logic is called? */
197 IO_LineReaderCallback LineReader;
201 evcurl_request_data HttpReq;
203 /* Saving / loading a message async from / to disk */
204 ReadAsyncMsg *ReadMsg;
205 struct CtdlMessage *AsyncMsg;
206 struct recptypes *AsyncRcp;
208 /* Context specific data; Hint: put AsyncIO in there */
209 void *Data; /* application specific data */
210 CitContext *CitContext; /* Citadel Session context... */
213 typedef struct _IOAddHandler {
220 extern int DebugEventLoop;
221 extern int DebugCAres;
223 #define EDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugEventLoop != 0))
225 #define CCID ((CitContext*)IO->CitContext)->cs_pid
227 #define EVQ_syslog(LEVEL, FORMAT, ...) \
228 EDBGLOG (LEVEL) syslog(LEVEL, "IOQ " FORMAT, __VA_ARGS__)
230 #define EVQM_syslog(LEVEL, FORMAT) \
231 EDBGLOG (LEVEL) syslog(LEVEL, "IO " FORMAT)
233 #define EV_syslog(LEVEL, FORMAT, ...) \
234 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
236 #define EVM_syslog(LEVEL, FORMAT) \
237 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
239 #define EVNC_syslog(LEVEL, FORMAT, ...) \
240 EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld] " FORMAT, IO->ID, __VA_ARGS__)
242 #define EVNCM_syslog(LEVEL, FORMAT) EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID)
245 #define CDBGLOG() if (DebugCAres != 0)
246 #define CEDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugCAres != 0))
247 #define EV_DNS_LOG_START(a) \
248 CDBGLOG () {syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
251 #define EV_DNS_LOG_STOP(a) \
252 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
255 #define EV_DNS_LOG_INIT(a) \
256 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
259 #define EV_DNS_LOGT_START(a) \
260 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
263 #define EV_DNS_LOGT_STOP(a) \
264 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
267 #define EV_DNS_LOGT_INIT(a) \
268 CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %p", IO->ID, CCID, &IO->a); \
271 #define EV_DNS_syslog(LEVEL, FORMAT, ...) \
272 CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
274 #define EVM_DNS_syslog(LEVEL, FORMAT) \
275 CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
277 void FreeAsyncIOContents(AsyncIO *IO);
279 eNextState NextDBOperation(AsyncIO *IO, IO_CallBack CB);
280 eNextState QueueDBOperation(AsyncIO *IO, IO_CallBack CB);
281 eNextState EventQueueDBOperation(AsyncIO *IO, IO_CallBack CB);
282 void StopDBWatchers(AsyncIO *IO);
283 eNextState QueueEventContext(AsyncIO *IO, IO_CallBack CB);
284 eNextState QueueCurlContext(AsyncIO *IO);
285 eNextState DBQueueEventContext(AsyncIO *IO, IO_CallBack CB);
287 eNextState EvConnectSock(AsyncIO *IO,
289 double first_rw_timeout,
291 void IO_postdns_callback(struct ev_loop *loop, ev_idle *watcher, int revents);
293 int QueueQuery(ns_type Type,
296 DNSQueryParts *QueryParts,
297 IO_CallBack PostDNS);
299 void QueueGetHostByName(AsyncIO *IO,
300 const char *Hostname,
301 DNSQueryParts *QueryParts,
302 IO_CallBack PostDNS);
304 void QueryCbDone(AsyncIO *IO);
306 void StopClient(AsyncIO *IO);
308 void StopClientWatchers(AsyncIO *IO, int CloseFD);
310 void SetNextTimeout(AsyncIO *IO, double timeout);
312 #include <curl/curl.h>
316 sta = curl_easy_setopt(chnd, (CURLOPT_##s), (v)); \
318 EVQ_syslog(LOG_ERR, \
319 "error setting option " #s \
320 " on curl handle: %s", \
321 curl_easy_strerror(sta)); \
324 void InitIOStruct(AsyncIO *IO,
326 eNextState NextState,
327 IO_LineReaderCallback LineReader,
328 IO_CallBack DNS_Fail,
329 IO_CallBack SendDone,
330 IO_CallBack ReadDone,
331 IO_CallBack Terminate,
332 IO_CallBack DBTerminate,
333 IO_CallBack ConnFail,
335 IO_CallBack ShutdownAbort);
337 int InitcURLIOStruct(AsyncIO *IO,
340 IO_CallBack SendDone,
341 IO_CallBack Terminate,
342 IO_CallBack DBTerminate,
343 IO_CallBack ShutdownAbort);
344 void KillAsyncIOContext(AsyncIO *IO);
345 void StopCurlWatchers(AsyncIO *IO);
347 eNextState CurlQueueDBOperation(AsyncIO *IO, IO_CallBack CB);
349 eNextState ReAttachIO(AsyncIO *IO,
353 void EV_backtrace(AsyncIO *IO);
354 ev_tstamp ctdl_ev_now (void);
356 #endif /* __EVENT_CLIENT_H__ */