One Level Up Top Level

src/core/ngx_connection.h - nginx

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;
  27.     int                 protocol;

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

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

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

  43.     ngx_log_t           log;
  44.     ngx_log_t          *logp;

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

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

  53.     ngx_rbtree_t        rbtree;
  54.     ngx_rbtree_node_t   sentinel;

  56.     ngx_uint_t          worker;

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

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

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

  79.     unsigned            change_protocol:1;

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

  91. #if (NGX_HAVE_TCP_FASTOPEN)
  92.     int                 fastopen;
  93. #endif

  95. };


  98. ‌typedef enum {
  99.     NGX_ERROR_ALERT = 0,
  100.     NGX_ERROR_ERR,
  101.     NGX_ERROR_INFO,
  102.     NGX_ERROR_IGNORE_ECONNRESET,
  103.     NGX_ERROR_IGNORE_EINVAL,
  104.     NGX_ERROR_IGNORE_EMSGSIZE
  105. ‌} ngx_connection_log_error_e;


  108. ‌typedef enum {
  109.     NGX_TCP_NODELAY_UNSET = 0,
  110.     NGX_TCP_NODELAY_SET,
  111.     NGX_TCP_NODELAY_DISABLED
  112. ‌} ngx_connection_tcp_nodelay_e;


  115. ‌typedef enum {
  116.     NGX_TCP_NOPUSH_UNSET = 0,
  117.     NGX_TCP_NOPUSH_SET,
  118.     NGX_TCP_NOPUSH_DISABLED
  119. ‌} ngx_connection_tcp_nopush_e;


  122. ‌#define NGX_LOWLEVEL_BUFFERED  0x0f
  123. ‌#define NGX_SSL_BUFFERED       0x01
  124. ‌#define NGX_HTTP_V2_BUFFERED   0x02


  127. ‌struct ngx_connection_s {
  128.     void               *data;
  129.     ngx_event_t        *read;
  130.     ngx_event_t        *write;

  132.     ngx_socket_t        fd;

  134.     ngx_recv_pt         recv;
  135.     ngx_send_pt         send;
  136.     ngx_recv_chain_pt   recv_chain;
  137.     ngx_send_chain_pt   send_chain;

  139.     ngx_listening_t    *listening;

  141.     off_t               sent;

  143.     ngx_log_t          *log;

  145.     ngx_pool_t         *pool;

  147.     int                 type;

  149.     struct sockaddr    *sockaddr;
  150.     socklen_t           socklen;
  151.     ngx_str_t           addr_text;

  153.     ngx_proxy_protocol_t  *proxy_protocol;

  155. #if (NGX_QUIC || NGX_COMPAT)
  156.     ngx_quic_stream_t     *quic;
  157. #endif

  159. #if (NGX_SSL || NGX_COMPAT)
  160.     ngx_ssl_connection_t  *ssl;
  161. #endif

  163.     ngx_udp_connection_t  *udp;

  165.     struct sockaddr    *local_sockaddr;
  166.     socklen_t           local_socklen;

  168.     ngx_buf_t          *buffer;

  170.     ngx_queue_t         queue;

  172.     ngx_atomic_uint_t   number;

  174.     ngx_msec_t          start_time;
  175.     ngx_uint_t          requests;

  177.     unsigned            buffered:8;

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

  181.     unsigned            timedout:1;
  182.     unsigned            error:1;
  183.     unsigned            destroyed:1;
  184.     unsigned            pipeline:1;

  186.     unsigned            idle:1;
  187.     unsigned            reusable:1;
  188.     unsigned            close:1;
  189.     unsigned            shared:1;

  191.     unsigned            sendfile:1;
  192.     unsigned            sndlowat:1;
  193.     unsigned            tcp_nodelay:2;   /* ngx_connection_tcp_nodelay_e */
  194.     unsigned            tcp_nopush:2;    /* ngx_connection_tcp_nopush_e */

  196.     unsigned            need_last_buf:1;
  197.     unsigned            need_flush_buf:1;

  199. #if (NGX_HAVE_SENDFILE_NODISKIO || NGX_COMPAT)
  200.     unsigned            busy_count:2;
  201. #endif

  203. #if (NGX_THREADS || NGX_COMPAT)
  204.     ngx_thread_task_t  *sendfile_task;
  205. #endif
  206. };


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


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

  234. ngx_connection_t *ngx_get_connection(ngx_socket_t s, ngx_log_t *log);
  235. void ngx_free_connection(ngx_connection_t *c);

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

  239. #endif /* _NGX_CONNECTION_H_INCLUDED_ */

One Level Up Top Level