libevent
include/event2/http_struct.h
Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2000-2007 Niels Provos <provos@citi.umich.edu>
00003  * Copyright (c) 2007-2010 Niels Provos and Nick Mathewson
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. The name of the author may not be used to endorse or promote products
00014  *    derived from this software without specific prior written permission.
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00017  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00018  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00019  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
00020  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00021  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00022  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00023  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00024  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00025  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026  */
00027 #ifndef _EVENT2_HTTP_STRUCT_H_
00028 #define _EVENT2_HTTP_STRUCT_H_
00029 
00037 #ifdef __cplusplus
00038 extern "C" {
00039 #endif
00040 
00041 #include <event2/event-config.h>
00042 #ifdef _EVENT_HAVE_SYS_TYPES_H
00043 #include <sys/types.h>
00044 #endif
00045 #ifdef _EVENT_HAVE_SYS_TIME_H
00046 #include <sys/time.h>
00047 #endif
00048 
00049 /* For int types. */
00050 #include <event2/util.h>
00051 
00057 struct evhttp_request {
00058 #if defined(TAILQ_ENTRY)
00059         TAILQ_ENTRY(evhttp_request) next;
00060 #else
00061 struct {
00062         struct evhttp_request *tqe_next;
00063         struct evhttp_request **tqe_prev;
00064 }       next;
00065 #endif
00066 
00067         /* the connection object that this request belongs to */
00068         struct evhttp_connection *evcon;
00069         int flags;
00071 #define EVHTTP_REQ_OWN_CONNECTION       0x0001
00072 
00073 #define EVHTTP_PROXY_REQUEST            0x0002
00074 
00075 #define EVHTTP_USER_OWNED               0x0004
00076 
00077 #define EVHTTP_REQ_DEFER_FREE           0x0008
00078 
00079 #define EVHTTP_REQ_NEEDS_FREE           0x0010
00080 
00081         struct evkeyvalq *input_headers;
00082         struct evkeyvalq *output_headers;
00083 
00084         /* address of the remote host and the port connection came from */
00085         char *remote_host;
00086         ev_uint16_t remote_port;
00087 
00088         /* cache of the hostname for evhttp_request_get_host */
00089         char *host_cache;
00090 
00091         enum evhttp_request_kind kind;
00092         enum evhttp_cmd_type type;
00093 
00094         size_t headers_size;
00095         size_t body_size;
00096 
00097         char *uri;                      /* uri after HTTP request was parsed */
00098         struct evhttp_uri *uri_elems;   /* uri elements */
00099 
00100         char major;                     /* HTTP Major number */
00101         char minor;                     /* HTTP Minor number */
00102 
00103         int response_code;              /* HTTP Response code */
00104         char *response_code_line;       /* Readable response */
00105 
00106         struct evbuffer *input_buffer;  /* read data */
00107         ev_int64_t ntoread;
00108         unsigned chunked:1,             /* a chunked request */
00109             userdone:1;                 /* the user has sent all data */
00110 
00111         struct evbuffer *output_buffer; /* outgoing post or data */
00112 
00113         /* Callback */
00114         void (*cb)(struct evhttp_request *, void *);
00115         void *cb_arg;
00116 
00117         /*
00118          * Chunked data callback - call for each completed chunk if
00119          * specified.  If not specified, all the data is delivered via
00120          * the regular callback.
00121          */
00122         void (*chunk_cb)(struct evhttp_request *, void *);
00123 };
00124 
00125 #ifdef __cplusplus
00126 }
00127 #endif
00128 
00129 #endif /* _EVENT2_HTTP_STRUCT_H_ */
00130 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines