Home | History | Annotate | Line # | Download | only in dist
http-internal.h revision 1.1 
      1 /*	$NetBSD: http-internal.h,v 1.1 2009/11/02 10:00:59 plunky Exp $	*/
      2 /*
      3  * Copyright 2001 Niels Provos <provos (at) citi.umich.edu>
      4  * All rights reserved.
      5  *
      6  * This header file contains definitions for dealing with HTTP requests
      7  * that are internal to libevent.  As user of the library, you should not
      8  * need to know about these.
      9  */
     10 
     11 #ifndef _HTTP_H_
     12 #define _HTTP_H_
     13 
     14 #define HTTP_CONNECT_TIMEOUT	45
     15 #define HTTP_WRITE_TIMEOUT	50
     16 #define HTTP_READ_TIMEOUT	50
     17 
     18 #define HTTP_PREFIX		"http://"
     19 #define HTTP_DEFAULTPORT	80
     20 
     21 enum message_read_status {
     22 	ALL_DATA_READ = 1,
     23 	MORE_DATA_EXPECTED = 0,
     24 	DATA_CORRUPTED = -1,
     25 	REQUEST_CANCELED = -2
     26 };
     27 
     28 enum evhttp_connection_error {
     29 	EVCON_HTTP_TIMEOUT,
     30 	EVCON_HTTP_EOF,
     31 	EVCON_HTTP_INVALID_HEADER
     32 };
     33 
     34 struct evbuffer;
     35 struct addrinfo;
     36 struct evhttp_request;
     37 
     38 /* A stupid connection object - maybe make this a bufferevent later */
     39 
     40 enum evhttp_connection_state {
     41 	EVCON_DISCONNECTED,	/**< not currently connected not trying either*/
     42 	EVCON_CONNECTING,	/**< tries to currently connect */
     43 	EVCON_IDLE,		/**< connection is established */
     44 	EVCON_READING_FIRSTLINE,/**< reading Request-Line (incoming conn) or
     45 				 **< Status-Line (outgoing conn) */
     46 	EVCON_READING_HEADERS,	/**< reading request/response headers */
     47 	EVCON_READING_BODY,	/**< reading request/response body */
     48 	EVCON_READING_TRAILER,	/**< reading request/response chunked trailer */
     49 	EVCON_WRITING		/**< writing request/response headers/body */
     50 };
     51 
     52 struct event_base;
     53 
     54 struct evhttp_connection {
     55 	/* we use tailq only if they were created for an http server */
     56 	TAILQ_ENTRY(evhttp_connection) (next);
     57 
     58 	int fd;
     59 	struct event ev;
     60 	struct event close_ev;
     61 	struct evbuffer *input_buffer;
     62 	struct evbuffer *output_buffer;
     63 
     64 	char *bind_address;		/* address to use for binding the src */
     65 	u_short bind_port;		/* local port for binding the src */
     66 
     67 	char *address;			/* address to connect to */
     68 	u_short port;
     69 
     70 	int flags;
     71 #define EVHTTP_CON_INCOMING	0x0001	/* only one request on it ever */
     72 #define EVHTTP_CON_OUTGOING	0x0002  /* multiple requests possible */
     73 #define EVHTTP_CON_CLOSEDETECT  0x0004  /* detecting if persistent close */
     74 
     75 	int timeout;			/* timeout in seconds for events */
     76 	int retry_cnt;			/* retry count */
     77 	int retry_max;			/* maximum number of retries */
     78 
     79 	enum evhttp_connection_state state;
     80 
     81 	/* for server connections, the http server they are connected with */
     82 	struct evhttp *http_server;
     83 
     84 	TAILQ_HEAD(evcon_requestq, evhttp_request) requests;
     85 
     86 						   void (*cb)(struct evhttp_connection *, void *);
     87 	void *cb_arg;
     88 
     89 	void (*closecb)(struct evhttp_connection *, void *);
     90 	void *closecb_arg;
     91 
     92 	struct event_base *base;
     93 };
     94 
     95 struct evhttp_cb {
     96 	TAILQ_ENTRY(evhttp_cb) next;
     97 
     98 	char *what;
     99 
    100 	void (*cb)(struct evhttp_request *req, void *);
    101 	void *cbarg;
    102 };
    103 
    104 /* both the http server as well as the rpc system need to queue connections */
    105 TAILQ_HEAD(evconq, evhttp_connection);
    106 
    107 /* each bound socket is stored in one of these */
    108 struct evhttp_bound_socket {
    109 	TAILQ_ENTRY(evhttp_bound_socket) (next);
    110 
    111 	struct event  bind_ev;
    112 };
    113 
    114 struct evhttp {
    115 	TAILQ_HEAD(boundq, evhttp_bound_socket) sockets;
    116 
    117 	TAILQ_HEAD(httpcbq, evhttp_cb) callbacks;
    118         struct evconq connections;
    119 
    120         int timeout;
    121 
    122 	void (*gencb)(struct evhttp_request *req, void *);
    123 	void *gencbarg;
    124 
    125 	struct event_base *base;
    126 };
    127 
    128 /* resets the connection; can be reused for more requests */
    129 void evhttp_connection_reset(struct evhttp_connection *);
    130 
    131 /* connects if necessary */
    132 int evhttp_connection_connect(struct evhttp_connection *);
    133 
    134 /* notifies the current request that it failed; resets connection */
    135 void evhttp_connection_fail(struct evhttp_connection *,
    136     enum evhttp_connection_error error);
    137 
    138 void evhttp_get_request(struct evhttp *, int, struct sockaddr *, socklen_t);
    139 
    140 int evhttp_hostportfile(char *, char **, u_short *, char **);
    141 
    142 int evhttp_parse_firstline(struct evhttp_request *, struct evbuffer*);
    143 int evhttp_parse_headers(struct evhttp_request *, struct evbuffer*);
    144 
    145 void evhttp_start_read(struct evhttp_connection *);
    146 void evhttp_make_header(struct evhttp_connection *, struct evhttp_request *);
    147 
    148 void evhttp_write_buffer(struct evhttp_connection *,
    149     void (*)(struct evhttp_connection *, void *), void *);
    150 
    151 /* response sending HTML the data in the buffer */
    152 void evhttp_response_code(struct evhttp_request *, int, const char *);
    153 void evhttp_send_page(struct evhttp_request *, struct evbuffer *);
    154 
    155 #endif /* _HTTP_H */
    156