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 as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #ifndef __EVENT_CLIENT_H__
21 #define __EVENT_CLIENT_H__
23 #include "sysconfig.h"
25 #include <sys/types.h>
26 #include <sys/socket.h>
28 #include <arpa/nameser.h>
30 #include <curl/curl.h>
32 typedef struct AsyncIO AsyncIO;
34 typedef enum _eNextState {
54 typedef eNextState (*IO_CallBack)(AsyncIO *IO);
55 typedef eReadState (*IO_LineReaderCallback)(AsyncIO *IO);
56 typedef void (*ParseDNSAnswerCb)(AsyncIO*, unsigned char*, int);
57 typedef void (*FreeDNSReply)(void *DNSData);
60 typedef struct __ReadAsyncMsg {
62 size_t maxlen; /* maximum message length */
64 const char *terminator; /* token signalling EOT */
69 /* if we read maxlen, read until nothing more arives and ignore this. */
71 int crlf; /* CRLF newlines instead of LF */
75 typedef struct _DNSQueryParts {
76 ParseDNSAnswerCb DNS_CB;
80 void *VParsedDNSReply;
81 FreeDNSReply DNSReplyFree;
85 typedef struct _evcurl_request_data
88 struct curl_slist *headers;
89 char errdesc[CURL_ERROR_SIZE];
94 long PlainPostDataLen;
99 } evcurl_request_data;
102 typedef struct __evcares_data {
106 ev_timer timeout; /* timeout while requesting ips */
108 short int SourcePort;
110 struct ares_options Options;
111 ares_channel Channel;
112 DNSQueryParts *Query;
114 IO_CallBack Fail; /* the dns lookup didn't work out. */
122 eNextState NextState;
124 /* connection related */
125 ParsedURL *ConnectMe;
127 /* read/send related... */
133 /* when sending from / reading into files, this is used. */
136 ev_cleanup abort_by_shutdown, /* server wants to go down... */
137 db_abort_by_shutdown; /* server wants to go down... */
138 ev_timer conn_fail, /* connection establishing timed out */
139 rw_timeout; /* timeout while sending data */
140 ev_idle unwind_stack, /* get c-ares out of the stack */
141 db_unwind_stack, /* wait for next db operation... */
142 conn_fail_immediate; /* unwind stack, but fail immediately. */
143 ev_io recv_event, /* receive data from the client */
144 send_event, /* send more data to the client */
145 conn_event; /* Connection successfully established */
147 StrBuf *ErrMsg; /* if we fail to connect, or lookup, error goes here. */
149 /* Citadel application callbacks... */
150 IO_CallBack ReadDone, /* Theres new data to read... */
151 SendDone, /* we may send more data */
152 Terminate, /* shutting down... */
153 DBTerminate, /* shutting down... */
154 Timeout, /* Timeout handler;may also be conn. timeout */
155 ConnFail, /* What to do when one connection failed? */
156 ShutdownAbort,/* we're going down. make your piece. */
157 NextDBOperation; /* Perform Database IO */
159 /* if we have linereaders, maybe we want to read more lines before
160 * the real application logic is called? */
161 IO_LineReaderCallback LineReader;
165 evcurl_request_data HttpReq;
167 /* Saving / loading a message async from / to disk */
168 ReadAsyncMsg *ReadMsg;
169 struct CtdlMessage *AsyncMsg;
170 struct recptypes *AsyncRcp;
172 /* Context specific data; Hint: put AsyncIO in there */
173 void *Data; /* application specific data */
174 void *CitContext; /* Citadel Session context... */
177 typedef struct _IOAddHandler {
182 #define CCID ((CitContext*)IO->CitContext)->cs_pid
184 #define EV_syslog(LEVEL, FORMAT, ...) \
185 syslog(LEVEL, "IO[%ld]CC[%d]" FORMAT, IO->ID, CCID, __VA_ARGS__)
187 #define EVM_syslog(LEVEL, FORMAT) \
188 syslog(LEVEL, "IO[%ld]CC[%d]" FORMAT, IO->ID, CCID)
190 #define EVNC_syslog(LEVEL, FORMAT, ...) \
191 syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID, __VA_ARGS__)
193 #define EVNCM_syslog(LEVEL, FORMAT) syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID)
196 #define EV_DNS_LOG_START(a) \
197 syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %p FD %d", IO->ID, CCID, &IO->a, IO->a.fd); \
200 #define EV_DNS_LOG_STOP(a) \
201 syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %p FD %d", IO->ID, CCID, &IO->a, IO->a.fd); \
204 #define EV_DNS_LOG_INIT(a) \
205 syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %p FD %d", IO->ID, CCID, &IO->a, IO->a.fd); \
208 #define EV_DNS_LOGT_START(a) \
209 syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %p", IO->ID, CCID, &IO->a); \
212 #define EV_DNS_LOGT_STOP(a) \
213 syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %p", IO->ID, CCID, &IO->a); \
216 #define EV_DNS_LOGT_INIT(a) \
217 syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %p", IO->ID, CCID, &IO->a); \
220 #define EV_DNS_LOG_START(a)
221 #define EV_DNS_LOG_STOP(a)
222 #define EV_DNS_LOG_INIT(a)
223 #define EV_DNS_LOGT_START(a)
224 #define EV_DNS_LOGT_STOP(a)
225 #define EV_DNS_LOGT_INIT(a)
228 void FreeAsyncIOContents(AsyncIO *IO);
230 eNextState NextDBOperation(AsyncIO *IO, IO_CallBack CB);
231 eNextState QueueDBOperation(AsyncIO *IO, IO_CallBack CB);
232 eNextState QueueEventContext(AsyncIO *IO, IO_CallBack CB);
233 eNextState QueueCurlContext(AsyncIO *IO);
235 eNextState EvConnectSock(AsyncIO *IO,
237 double first_rw_timeout,
239 void IO_postdns_callback(struct ev_loop *loop, ev_idle *watcher, int revents);
241 int QueueQuery(ns_type Type,
244 DNSQueryParts *QueryParts,
245 IO_CallBack PostDNS);
247 void QueueGetHostByName(AsyncIO *IO,
248 const char *Hostname,
249 DNSQueryParts *QueryParts,
250 IO_CallBack PostDNS);
252 void QueryCbDone(AsyncIO *IO);
254 void StopClient(AsyncIO *IO);
256 void StopClientWatchers(AsyncIO *IO);
258 void SetNextTimeout(AsyncIO *IO, double timeout);
260 #include <curl/curl.h>
264 sta = curl_easy_setopt(chnd, (CURLOPT_##s), (v)); \
267 "error setting option " #s \
268 " on curl handle: %s", \
269 curl_easy_strerror(sta)); \
272 void InitIOStruct(AsyncIO *IO,
274 eNextState NextState,
275 IO_LineReaderCallback LineReader,
276 IO_CallBack DNS_Fail,
277 IO_CallBack SendDone,
278 IO_CallBack ReadDone,
279 IO_CallBack Terminate,
280 IO_CallBack DBTerminate,
281 IO_CallBack ConnFail,
283 IO_CallBack ShutdownAbort);
285 int InitcURLIOStruct(AsyncIO *IO,
288 IO_CallBack SendDone,
289 IO_CallBack Terminate,
290 IO_CallBack DBTerminate,
291 IO_CallBack ShutdownAbort);
293 eNextState ReAttachIO(AsyncIO *IO,
297 void EV_backtrace(AsyncIO *IO);
298 ev_tstamp ctdl_ev_now (void);
300 #endif /* __EVENT_CLIENT_H__ */