One Level Up Top Level

src/core/ngx_connection.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_CONNECTION_H_INCLUDED_
  9. ‌#define _NGX_CONNECTION_H_INCLUDED_


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


  16. ‌typedef struct ngx_listening_s  ngx_listening_t;

  18. ‌struct ngx_listening_s {
  19.     ngx_socket_t        fd;

  21.     struct sockaddr    *sockaddr;
  22.     socklen_t           socklen;    /* size of sockaddr */
  23.     size_t              addr_text_max_len;
  24.     ngx_str_t           addr_text;

  26.     int                 type;

  28.     int                 backlog;
  29.     int                 rcvbuf;
  30.     int                 sndbuf;
  31. #if (NGX_HAVE_KEEPALIVE_TUNABLE)
  32.     int                 keepidle;
  33.     int                 keepintvl;
  34.     int                 keepcnt;
  35. #endif

  37.     /* handler of accepted connection */
  38.     ngx_connection_handler_pt   handler;

  40.     void               *servers;  /* array of ngx_http_in_addr_t, for example */

  42.     ngx_log_t           log;
  43.     ngx_log_t          *logp;

  45.     size_t              pool_size;
  46.     /* should be here because of the AcceptEx() preread */
  47.     size_t              post_accept_buffer_size;

  49.     ngx_listening_t    *previous;
  50.     ngx_connection_t   *connection;

  52.     ngx_rbtree_t        rbtree;
  53.     ngx_rbtree_node_t   sentinel;

  55.     ngx_uint_t          worker;

  57.     unsigned            open:1;
  58.     unsigned            remain:1;
  59.     unsigned            ignore:1;

  61.     unsigned            bound:1;       /* already bound */
  62.     unsigned            inherited:1;   /* inherited from previous process */
  63.     unsigned            nonblocking_accept:1;
  64.     unsigned            listen:1;
  65.     unsigned            nonblocking:1;
  66.     unsigned            shared:1;    /* shared between threads or processes */
  67.     unsigned            addr_ntop:1;
  68.     unsigned            wildcard:1;

  70. #if (NGX_HAVE_INET6)
  71.     unsigned            ipv6only:1;
  72. #endif
  73.     unsigned            reuseport:1;
  74.     unsigned            add_reuseport:1;
  75.     unsigned            keepalive:2;
  76.     unsigned            quic:1;

  78.     unsigned            deferred_accept:1;
  79.     unsigned            delete_deferred:1;
  80.     unsigned            add_deferred:1;
  81. #if (NGX_HAVE_DEFERRED_ACCEPT && defined SO_ACCEPTFILTER)
  82.     char               *accept_filter;
  83. #endif
  84. #if (NGX_HAVE_SETFIB)
  85.     int                 setfib;
  86. #endif

  88. #if (NGX_HAVE_TCP_FASTOPEN)
  89.     int                 fastopen;
  90. #endif

  92. };


  95. ‌typedef enum {
  96.     NGX_ERROR_ALERT = 0,
  97.     NGX_ERROR_ERR,
  98.     NGX_ERROR_INFO,
  99.     NGX_ERROR_IGNORE_ECONNRESET,
  100.     NGX_ERROR_IGNORE_EINVAL,
  101.     NGX_ERROR_IGNORE_EMSGSIZE
  102. ‌} ngx_connection_log_error_e;


  105. ‌typedef enum {
  106.     NGX_TCP_NODELAY_UNSET = 0,
  107.     NGX_TCP_NODELAY_SET,
  108.     NGX_TCP_NODELAY_DISABLED
  109. ‌} ngx_connection_tcp_nodelay_e;


  112. ‌typedef enum {
  113.     NGX_TCP_NOPUSH_UNSET = 0,
  114.     NGX_TCP_NOPUSH_SET,
  115.     NGX_TCP_NOPUSH_DISABLED
  116. ‌} ngx_connection_tcp_nopush_e;


  119. ‌#define NGX_LOWLEVEL_BUFFERED  0x0f
  120. ‌#define NGX_SSL_BUFFERED       0x01
  121. ‌#define NGX_HTTP_V2_BUFFERED   0x02


  124. ‌struct ngx_connection_s {
  125.     void               *data;
  126.     ngx_event_t        *read;
  127.     ngx_event_t        *write;

  129.     ngx_socket_t        fd;

  131.     ngx_recv_pt         recv;
  132.     ngx_send_pt         send;
  133.     ngx_recv_chain_pt   recv_chain;
  134.     ngx_send_chain_pt   send_chain;

  136.     ngx_listening_t    *listening;

  138.     off_t               sent;

  140.     ngx_log_t          *log;

  142.     ngx_pool_t         *pool;

  144.     int                 type;

  146.     struct sockaddr    *sockaddr;
  147.     socklen_t           socklen;
  148.     ngx_str_t           addr_text;

  150.     ngx_proxy_protocol_t  *proxy_protocol;

  152. #if (NGX_QUIC || NGX_COMPAT)
  153.     ngx_quic_stream_t     *quic;
  154. #endif

  156. #if (NGX_SSL || NGX_COMPAT)
  157.     ngx_ssl_connection_t  *ssl;
  158. #endif

  160.     ngx_udp_connection_t  *udp;

  162.     struct sockaddr    *local_sockaddr;
  163.     socklen_t           local_socklen;

  165.     ngx_buf_t          *buffer;

  167.     ngx_queue_t         queue;

  169.     ngx_atomic_uint_t   number;

  171.     ngx_msec_t          start_time;
  172.     ngx_uint_t          requests;

  174.     unsigned            buffered:8;

  176.     unsigned            log_error:3;     /* ngx_connection_log_error_e */

  178.     unsigned            timedout:1;
  179.     unsigned            error:1;
  180.     unsigned            destroyed:1;
  181.     unsigned            pipeline:1;

  183.     unsigned            idle:1;
  184.     unsigned            reusable:1;
  185.     unsigned            close:1;
  186.     unsigned            shared:1;

  188.     unsigned            sendfile:1;
  189.     unsigned            sndlowat:1;
  190.     unsigned            tcp_nodelay:2;   /* ngx_connection_tcp_nodelay_e */
  191.     unsigned            tcp_nopush:2;    /* ngx_connection_tcp_nopush_e */

  193.     unsigned            need_last_buf:1;
  194.     unsigned            need_flush_buf:1;

  196. #if (NGX_HAVE_SENDFILE_NODISKIO || NGX_COMPAT)
  197.     unsigned            busy_count:2;
  198. #endif

  200. #if (NGX_THREADS || NGX_COMPAT)
  201.     ngx_thread_task_t  *sendfile_task;
  202. #endif
  203. };


  206. ‌#define ngx_set_connection_log(c, l)                                         \
  207.                                                                              \
  208.     c->log->file = l->file;                                                  \
  209.     c->log->next = l->next;                                                  \
  210.     c->log->writer = l->writer;                                              \
  211.     c->log->wdata = l->wdata;                                                \
  212.     if (!(c->log->log_level & NGX_LOG_DEBUG_CONNECTION)) {                   \
  213.         c->log->log_level = l->log_level;                                    \
  214.     }


  217. ngx_listening_t *ngx_create_listening(ngx_conf_t *cf, struct sockaddr *sockaddr,
  218.     socklen_t socklen);
  219. ngx_int_t ngx_clone_listening(ngx_cycle_t *cycle, ngx_listening_t *ls);
  220. ngx_int_t ngx_set_inherited_sockets(ngx_cycle_t *cycle);
  221. ngx_int_t ngx_open_listening_sockets(ngx_cycle_t *cycle);
  222. void ngx_configure_listening_sockets(ngx_cycle_t *cycle);
  223. void ngx_close_listening_sockets(ngx_cycle_t *cycle);
  224. void ngx_close_connection(ngx_connection_t *c);
  225. void ngx_close_idle_connections(ngx_cycle_t *cycle);
  226. ngx_int_t ngx_connection_local_sockaddr(ngx_connection_t *c, ngx_str_t *s,
  227.     ngx_uint_t port);
  228. ngx_int_t ngx_tcp_nodelay(ngx_connection_t *c);
  229. ngx_int_t ngx_connection_error(ngx_connection_t *c, ngx_err_t err, char *text);

  231. ngx_connection_t *ngx_get_connection(ngx_socket_t s, ngx_log_t *log);
  232. void ngx_free_connection(ngx_connection_t *c);

  234. void ngx_reusable_connection(ngx_connection_t *c, ngx_uint_t reusable);

  236. #endif /* _NGX_CONNECTION_H_INCLUDED_ */

One Level Up Top Level