One Level Up Top Level

src/http/ngx_http.h - nginx source code

Data types defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Igor Sysoev
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #ifndef _NGX_HTTP_H_INCLUDED_
  9. ‌#define _NGX_HTTP_H_INCLUDED_


  12. #include <ngx_config.h>
  13. #include <ngx_core.h>


  16. ‌typedef struct ngx_http_request_s     ngx_http_request_t;
  17. ‌typedef struct ngx_http_upstream_s    ngx_http_upstream_t;
  18. ‌typedef struct ngx_http_cache_s       ngx_http_cache_t;
  19. ‌typedef struct ngx_http_file_cache_s  ngx_http_file_cache_t;
  20. ‌typedef struct ngx_http_log_ctx_s     ngx_http_log_ctx_t;
  21. ‌typedef struct ngx_http_chunked_s     ngx_http_chunked_t;
  22. ‌typedef struct ngx_http_v2_stream_s   ngx_http_v2_stream_t;
  23. ‌typedef struct ngx_http_v3_parse_s    ngx_http_v3_parse_t;
  24. ‌typedef struct ngx_http_v3_session_s  ngx_http_v3_session_t;

  26. ‌typedef ngx_int_t (*ngx_http_header_handler_pt)(ngx_http_request_t *r,
  27.     ngx_table_elt_t *h, ngx_uint_t offset);
  28. ‌typedef u_char *(*ngx_http_log_handler_pt)(ngx_http_request_t *r,
  29.     ngx_http_request_t *sr, u_char *buf, size_t len);


  32. #include <ngx_http_variables.h>
  33. #include <ngx_http_config.h>
  34. #include <ngx_http_request.h>
  35. #include <ngx_http_script.h>
  36. #include <ngx_http_upstream.h>
  37. #include <ngx_http_upstream_round_robin.h>
  38. #include <ngx_http_core_module.h>

  40. #if (NGX_HTTP_V2)
  41. #include <ngx_http_v2.h>
  42. #endif
  43. #if (NGX_HTTP_V3)
  44. #include <ngx_http_v3.h>
  45. #endif
  46. #if (NGX_HTTP_CACHE)
  47. #include <ngx_http_cache.h>
  48. #endif
  49. #if (NGX_HTTP_SSI)
  50. #include <ngx_http_ssi_filter_module.h>
  51. #endif
  52. #if (NGX_HTTP_SSL)
  53. #include <ngx_http_ssl_module.h>
  54. #endif


  57. ‌struct ngx_http_log_ctx_s {
  58.     ngx_connection_t    *connection;
  59.     ngx_http_request_t  *request;
  60.     ngx_http_request_t  *current_request;
  61. };


  64. ‌struct ngx_http_chunked_s {
  65.     ngx_uint_t           state;
  66.     off_t                size;
  67.     off_t                length;
  68. };


  71. ‌typedef struct {
  72.     ngx_uint_t           http_version;
  73.     ngx_uint_t           code;
  74.     ngx_uint_t           count;
  75.     u_char              *start;
  76.     u_char              *end;
  77. ‌} ngx_http_status_t;


  80. ‌#define ngx_http_get_module_ctx(r, module)  (r)->ctx[module.ctx_index]
  81. ‌#define ngx_http_set_ctx(r, c, module)      r->ctx[module.ctx_index] = c;


  84. ngx_int_t ngx_http_add_location(ngx_conf_t *cf, ngx_queue_t **locations,
  85.     ngx_http_core_loc_conf_t *clcf);
  86. ngx_int_t ngx_http_add_listen(ngx_conf_t *cf, ngx_http_core_srv_conf_t *cscf,
  87.     ngx_http_listen_opt_t *lsopt);


  90. void ngx_http_init_connection(ngx_connection_t *c);
  91. void ngx_http_close_connection(ngx_connection_t *c);

  93. #if (NGX_HTTP_SSL && defined SSL_CTRL_SET_TLSEXT_HOSTNAME)
  94. int ngx_http_ssl_servername(ngx_ssl_conn_t *ssl_conn, int *ad, void *arg);
  95. #endif
  96. #if (NGX_HTTP_SSL && defined SSL_R_CERT_CB_ERROR)
  97. int ngx_http_ssl_certificate(ngx_ssl_conn_t *ssl_conn, void *arg);
  98. #endif


  101. ngx_int_t ngx_http_parse_request_line(ngx_http_request_t *r, ngx_buf_t *b);
  102. ngx_int_t ngx_http_parse_uri(ngx_http_request_t *r);
  103. ngx_int_t ngx_http_parse_complex_uri(ngx_http_request_t *r,
  104.     ngx_uint_t merge_slashes);
  105. ngx_int_t ngx_http_parse_status_line(ngx_http_request_t *r, ngx_buf_t *b,
  106.     ngx_http_status_t *status);
  107. ngx_int_t ngx_http_parse_unsafe_uri(ngx_http_request_t *r, ngx_str_t *uri,
  108.     ngx_str_t *args, ngx_uint_t *flags);
  109. ngx_int_t ngx_http_parse_header_line(ngx_http_request_t *r, ngx_buf_t *b,
  110.     ngx_uint_t allow_underscores);
  111. ngx_table_elt_t *ngx_http_parse_multi_header_lines(ngx_http_request_t *r,
  112.     ngx_table_elt_t *headers, ngx_str_t *name, ngx_str_t *value);
  113. ngx_table_elt_t *ngx_http_parse_set_cookie_lines(ngx_http_request_t *r,
  114.     ngx_table_elt_t *headers, ngx_str_t *name, ngx_str_t *value);
  115. ngx_int_t ngx_http_arg(ngx_http_request_t *r, u_char *name, size_t len,
  116.     ngx_str_t *value);
  117. void ngx_http_split_args(ngx_http_request_t *r, ngx_str_t *uri,
  118.     ngx_str_t *args);
  119. ngx_int_t ngx_http_parse_chunked(ngx_http_request_t *r, ngx_buf_t *b,
  120.     ngx_http_chunked_t *ctx, ngx_uint_t keep_trailers);


  123. ngx_http_request_t *ngx_http_create_request(ngx_connection_t *c);
  124. ngx_int_t ngx_http_process_request_uri(ngx_http_request_t *r);
  125. ngx_int_t ngx_http_process_request_header(ngx_http_request_t *r);
  126. void ngx_http_process_request(ngx_http_request_t *r);
  127. void ngx_http_update_location_config(ngx_http_request_t *r);
  128. void ngx_http_handler(ngx_http_request_t *r);
  129. void ngx_http_run_posted_requests(ngx_connection_t *c);
  130. ngx_int_t ngx_http_post_request(ngx_http_request_t *r,
  131.     ngx_http_posted_request_t *pr);
  132. ngx_int_t ngx_http_set_virtual_server(ngx_http_request_t *r,
  133.     ngx_str_t *host);
  134. ngx_int_t ngx_http_validate_host(ngx_str_t *host, ngx_pool_t *pool,
  135.     ngx_uint_t alloc);
  136. void ngx_http_close_request(ngx_http_request_t *r, ngx_int_t rc);
  137. void ngx_http_finalize_request(ngx_http_request_t *r, ngx_int_t rc);
  138. void ngx_http_free_request(ngx_http_request_t *r, ngx_int_t rc);

  140. void ngx_http_empty_handler(ngx_event_t *wev);
  141. void ngx_http_request_empty_handler(ngx_http_request_t *r);


  144. ‌#define NGX_HTTP_LAST   1
  145. ‌#define NGX_HTTP_FLUSH  2

  147. ngx_int_t ngx_http_send_special(ngx_http_request_t *r, ngx_uint_t flags);


  150. ngx_int_t ngx_http_read_client_request_body(ngx_http_request_t *r,
  151.     ngx_http_client_body_handler_pt post_handler);
  152. ngx_int_t ngx_http_read_unbuffered_request_body(ngx_http_request_t *r);

  154. ngx_int_t ngx_http_send_header(ngx_http_request_t *r);
  155. ngx_int_t ngx_http_special_response_handler(ngx_http_request_t *r,
  156.     ngx_int_t error);
  157. ngx_int_t ngx_http_filter_finalize_request(ngx_http_request_t *r,
  158.     ngx_module_t *m, ngx_int_t error);
  159. void ngx_http_clean_header(ngx_http_request_t *r);


  162. ngx_int_t ngx_http_discard_request_body(ngx_http_request_t *r);
  163. void ngx_http_discarded_request_body_handler(ngx_http_request_t *r);
  164. void ngx_http_block_reading(ngx_http_request_t *r);
  165. void ngx_http_test_reading(ngx_http_request_t *r);


  168. char *ngx_http_types_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  169. char *ngx_http_merge_types(ngx_conf_t *cf, ngx_array_t **keys,
  170.     ngx_hash_t *types_hash, ngx_array_t **prev_keys,
  171.     ngx_hash_t *prev_types_hash, ngx_str_t *default_types);
  172. ngx_int_t ngx_http_set_default_types(ngx_conf_t *cf, ngx_array_t **types,
  173.     ngx_str_t *default_type);

  175. #if (NGX_HTTP_DEGRADATION)
  176. ngx_uint_t  ngx_http_degraded(ngx_http_request_t *);
  177. #endif


  180. #if (NGX_HTTP_V2 || NGX_HTTP_V3)
  181. ngx_int_t ngx_http_huff_decode(u_char *state, u_char *src, size_t len,
  182.     u_char **dst, ngx_uint_t last, ngx_log_t *log);
  183. size_t ngx_http_huff_encode(u_char *src, size_t len, u_char *dst,
  184.     ngx_uint_t lower);
  185. #endif


  188. extern ngx_module_t  ngx_http_module;

  190. extern ngx_str_t  ngx_http_html_default_types[];


  193. extern ngx_http_output_header_filter_pt  ngx_http_top_header_filter;
  194. extern ngx_http_output_body_filter_pt    ngx_http_top_body_filter;
  195. extern ngx_http_request_body_filter_pt   ngx_http_top_request_body_filter;


  198. #endif /* _NGX_HTTP_H_INCLUDED_ */

One Level Up Top Level