Blame libevent/http-internal.h

Packit e9ba0d
/*
Packit e9ba0d
 * Copyright 2001-2007 Niels Provos <provos@citi.umich.edu>
Packit e9ba0d
 * Copyright 2007-2012 Niels Provos and Nick Mathewson
Packit e9ba0d
 *
Packit e9ba0d
 * This header file contains definitions for dealing with HTTP requests
Packit e9ba0d
 * that are internal to libevent.  As user of the library, you should not
Packit e9ba0d
 * need to know about these.
Packit e9ba0d
 */
Packit e9ba0d
Packit e9ba0d
#ifndef _HTTP_INTERNAL_H_
Packit e9ba0d
#define _HTTP_INTERNAL_H_
Packit e9ba0d
Packit e9ba0d
#include "event2/event_struct.h"
Packit e9ba0d
#include "util-internal.h"
Packit e9ba0d
#include "defer-internal.h"
Packit e9ba0d
Packit e9ba0d
#define HTTP_CONNECT_TIMEOUT	45
Packit e9ba0d
#define HTTP_WRITE_TIMEOUT	50
Packit e9ba0d
#define HTTP_READ_TIMEOUT	50
Packit e9ba0d
Packit e9ba0d
#define HTTP_PREFIX		"http://"
Packit e9ba0d
#define HTTP_DEFAULTPORT	80
Packit e9ba0d
Packit e9ba0d
enum message_read_status {
Packit e9ba0d
	ALL_DATA_READ = 1,
Packit e9ba0d
	MORE_DATA_EXPECTED = 0,
Packit e9ba0d
	DATA_CORRUPTED = -1,
Packit e9ba0d
	REQUEST_CANCELED = -2,
Packit e9ba0d
	DATA_TOO_LONG = -3
Packit e9ba0d
};
Packit e9ba0d
Packit e9ba0d
enum evhttp_connection_error {
Packit e9ba0d
	EVCON_HTTP_TIMEOUT,
Packit e9ba0d
	EVCON_HTTP_EOF,
Packit e9ba0d
	EVCON_HTTP_INVALID_HEADER,
Packit e9ba0d
	EVCON_HTTP_BUFFER_ERROR,
Packit e9ba0d
	EVCON_HTTP_REQUEST_CANCEL
Packit e9ba0d
};
Packit e9ba0d
Packit e9ba0d
struct evbuffer;
Packit e9ba0d
struct addrinfo;
Packit e9ba0d
struct evhttp_request;
Packit e9ba0d
Packit e9ba0d
/* Indicates an unknown request method. */
Packit e9ba0d
#define _EVHTTP_REQ_UNKNOWN (1<<15)
Packit e9ba0d
Packit e9ba0d
enum evhttp_connection_state {
Packit e9ba0d
	EVCON_DISCONNECTED,	/**< not currently connected not trying either*/
Packit e9ba0d
	EVCON_CONNECTING,	/**< tries to currently connect */
Packit e9ba0d
	EVCON_IDLE,		/**< connection is established */
Packit e9ba0d
	EVCON_READING_FIRSTLINE,/**< reading Request-Line (incoming conn) or
Packit e9ba0d
				 **< Status-Line (outgoing conn) */
Packit e9ba0d
	EVCON_READING_HEADERS,	/**< reading request/response headers */
Packit e9ba0d
	EVCON_READING_BODY,	/**< reading request/response body */
Packit e9ba0d
	EVCON_READING_TRAILER,	/**< reading request/response chunked trailer */
Packit e9ba0d
	EVCON_WRITING		/**< writing request/response headers/body */
Packit e9ba0d
};
Packit e9ba0d
Packit e9ba0d
struct event_base;
Packit e9ba0d
Packit e9ba0d
/* A client or server connection. */
Packit e9ba0d
struct evhttp_connection {
Packit e9ba0d
	/* we use this tailq only if this connection was created for an http
Packit e9ba0d
	 * server */
Packit e9ba0d
	TAILQ_ENTRY(evhttp_connection) next;
Packit e9ba0d
Packit e9ba0d
	evutil_socket_t fd;
Packit e9ba0d
	struct bufferevent *bufev;
Packit e9ba0d
Packit e9ba0d
	struct event retry_ev;		/* for retrying connects */
Packit e9ba0d
Packit e9ba0d
	char *bind_address;		/* address to use for binding the src */
Packit e9ba0d
	u_short bind_port;		/* local port for binding the src */
Packit e9ba0d
Packit e9ba0d
	char *address;			/* address to connect to */
Packit e9ba0d
	u_short port;
Packit e9ba0d
Packit e9ba0d
	size_t max_headers_size;
Packit e9ba0d
	ev_uint64_t max_body_size;
Packit e9ba0d
Packit e9ba0d
	int flags;
Packit e9ba0d
#define EVHTTP_CON_INCOMING	0x0001	/* only one request on it ever */
Packit e9ba0d
#define EVHTTP_CON_OUTGOING	0x0002  /* multiple requests possible */
Packit e9ba0d
#define EVHTTP_CON_CLOSEDETECT  0x0004  /* detecting if persistent close */
Packit e9ba0d
Packit e9ba0d
	int timeout;			/* timeout in seconds for events */
Packit e9ba0d
	int retry_cnt;			/* retry count */
Packit e9ba0d
	int retry_max;			/* maximum number of retries */
Packit e9ba0d
Packit e9ba0d
	enum evhttp_connection_state state;
Packit e9ba0d
Packit e9ba0d
	/* for server connections, the http server they are connected with */
Packit e9ba0d
	struct evhttp *http_server;
Packit e9ba0d
Packit e9ba0d
	TAILQ_HEAD(evcon_requestq, evhttp_request) requests;
Packit e9ba0d
Packit e9ba0d
	void (*cb)(struct evhttp_connection *, void *);
Packit e9ba0d
	void *cb_arg;
Packit e9ba0d
Packit e9ba0d
	void (*closecb)(struct evhttp_connection *, void *);
Packit e9ba0d
	void *closecb_arg;
Packit e9ba0d
Packit e9ba0d
	struct deferred_cb read_more_deferred_cb;
Packit e9ba0d
Packit e9ba0d
	struct event_base *base;
Packit e9ba0d
	struct evdns_base *dns_base;
Packit e9ba0d
};
Packit e9ba0d
Packit e9ba0d
/* A callback for an http server */
Packit e9ba0d
struct evhttp_cb {
Packit e9ba0d
	TAILQ_ENTRY(evhttp_cb) next;
Packit e9ba0d
Packit e9ba0d
	char *what;
Packit e9ba0d
Packit e9ba0d
	void (*cb)(struct evhttp_request *req, void *);
Packit e9ba0d
	void *cbarg;
Packit e9ba0d
};
Packit e9ba0d
Packit e9ba0d
/* both the http server as well as the rpc system need to queue connections */
Packit e9ba0d
TAILQ_HEAD(evconq, evhttp_connection);
Packit e9ba0d
Packit e9ba0d
/* each bound socket is stored in one of these */
Packit e9ba0d
struct evhttp_bound_socket {
Packit e9ba0d
	TAILQ_ENTRY(evhttp_bound_socket) next;
Packit e9ba0d
Packit e9ba0d
	struct evconnlistener *listener;
Packit e9ba0d
};
Packit e9ba0d
Packit e9ba0d
/* server alias list item. */
Packit e9ba0d
struct evhttp_server_alias {
Packit e9ba0d
	TAILQ_ENTRY(evhttp_server_alias) next;
Packit e9ba0d
Packit e9ba0d
	char *alias; /* the server alias. */
Packit e9ba0d
};
Packit e9ba0d
Packit e9ba0d
struct evhttp {
Packit e9ba0d
	/* Next vhost, if this is a vhost. */
Packit e9ba0d
	TAILQ_ENTRY(evhttp) next_vhost;
Packit e9ba0d
Packit e9ba0d
	/* All listeners for this host */
Packit e9ba0d
	TAILQ_HEAD(boundq, evhttp_bound_socket) sockets;
Packit e9ba0d
Packit e9ba0d
	TAILQ_HEAD(httpcbq, evhttp_cb) callbacks;
Packit e9ba0d
Packit e9ba0d
	/* All live connections on this host. */
Packit e9ba0d
	struct evconq connections;
Packit e9ba0d
Packit e9ba0d
	TAILQ_HEAD(vhostsq, evhttp) virtualhosts;
Packit e9ba0d
Packit e9ba0d
	TAILQ_HEAD(aliasq, evhttp_server_alias) aliases;
Packit e9ba0d
Packit e9ba0d
	/* NULL if this server is not a vhost */
Packit e9ba0d
	char *vhost_pattern;
Packit e9ba0d
Packit e9ba0d
	int timeout;
Packit e9ba0d
Packit e9ba0d
	size_t default_max_headers_size;
Packit e9ba0d
	ev_uint64_t default_max_body_size;
Packit e9ba0d
Packit e9ba0d
	/* Bitmask of all HTTP methods that we accept and pass to user
Packit e9ba0d
	 * callbacks. */
Packit e9ba0d
	ev_uint16_t allowed_methods;
Packit e9ba0d
Packit e9ba0d
	/* Fallback callback if all the other callbacks for this connection
Packit e9ba0d
	   don't match. */
Packit e9ba0d
	void (*gencb)(struct evhttp_request *req, void *);
Packit e9ba0d
	void *gencbarg;
Packit e9ba0d
Packit e9ba0d
	struct event_base *base;
Packit e9ba0d
};
Packit e9ba0d
Packit e9ba0d
/* XXX most of these functions could be static. */
Packit e9ba0d
Packit e9ba0d
/* resets the connection; can be reused for more requests */
Packit e9ba0d
void evhttp_connection_reset(struct evhttp_connection *);
Packit e9ba0d
Packit e9ba0d
/* connects if necessary */
Packit e9ba0d
int evhttp_connection_connect(struct evhttp_connection *);
Packit e9ba0d
Packit e9ba0d
/* notifies the current request that it failed; resets connection */
Packit e9ba0d
void evhttp_connection_fail(struct evhttp_connection *,
Packit e9ba0d
    enum evhttp_connection_error error);
Packit e9ba0d
Packit e9ba0d
enum message_read_status;
Packit e9ba0d
Packit e9ba0d
enum message_read_status evhttp_parse_firstline(struct evhttp_request *, struct evbuffer*);
Packit e9ba0d
enum message_read_status evhttp_parse_headers(struct evhttp_request *, struct evbuffer*);
Packit e9ba0d
Packit e9ba0d
void evhttp_start_read(struct evhttp_connection *);
Packit e9ba0d
Packit e9ba0d
/* response sending HTML the data in the buffer */
Packit e9ba0d
void evhttp_response_code(struct evhttp_request *, int, const char *);
Packit e9ba0d
void evhttp_send_page(struct evhttp_request *, struct evbuffer *);
Packit e9ba0d
Packit e9ba0d
#endif /* _HTTP_H */