ngx_tcp.h

#ifndef _NGX_TCP_H_INCLUDED_
#define _NGX_TCP_H_INCLUDED_


#include <nginx.h>
#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_event.h>
#include <ngx_event_connect.h>


typedef struct ngx_tcp_protocol_s  ngx_tcp_protocol_t;
typedef struct ngx_tcp_upstream_s  ngx_tcp_upstream_t;
typedef struct ngx_tcp_cleanup_s  ngx_tcp_cleanup_t;

typedef struct ngx_tcp_core_srv_conf_s ngx_tcp_core_srv_conf_t;

typedef struct ngx_tcp_upstream_srv_conf_s  ngx_tcp_upstream_srv_conf_t;
typedef struct ngx_tcp_upstream_resolved_s  ngx_tcp_upstream_resolved_t;

typedef struct ngx_tcp_check_peer_conf_s ngx_tcp_check_peer_conf_t;
typedef struct ngx_tcp_check_peers_conf_s ngx_tcp_check_peers_conf_t;
typedef struct check_conf_s check_conf_t;

/* make nginx-0.8.22+ happy */
#if defined(nginx_version) && nginx_version >= 8022
typedef ngx_addr_t ngx_peer_addr_t; 
#endif

#include <ngx_tcp_session.h>
#include <ngx_tcp_upstream.h>
#include <ngx_tcp_upstream_check.h>
#include <ngx_tcp_upstream_round_robin.h>

#if (NGX_TCP_SSL)
#include <ngx_tcp_ssl_module.h>
#endif


typedef struct {
    void                  **main_conf;
    void                  **srv_conf;
} ngx_tcp_conf_ctx_t;


typedef struct {
    u_char                  sockaddr[NGX_SOCKADDRLEN];
    socklen_t               socklen;

    /* server ctx */
    ngx_tcp_conf_ctx_t     *ctx;

    unsigned                default_port:1;
    unsigned                bind:1;
    unsigned                wildcard:1;
#if (NGX_TCP_SSL)
    unsigned                ssl:1;
#endif
#if (NGX_HAVE_INET6 && defined IPV6_V6ONLY)
    unsigned                ipv6only:2;
#endif
    ngx_tcp_core_srv_conf_t *conf;
} ngx_tcp_listen_t;


typedef struct {
    ngx_str_t                name;
} ngx_tcp_server_name_t;


typedef struct {
    ngx_uint_t               hash;
    ngx_str_t                name;
    ngx_tcp_listen_t        *listen;
    ngx_tcp_conf_ctx_t      *ctx;
} ngx_tcp_virtual_server_t;


typedef struct {
    ngx_str_t                name;
} ngx_tcp_core_loc_t;


typedef struct {
    ngx_tcp_conf_ctx_t      *ctx;
    ngx_tcp_conf_ctx_t      *default_ctx;
    ngx_str_t                addr_text;
#if (NGX_TCP_SSL)
    ngx_uint_t               ssl;    /* unsigned   ssl:1; */
#endif
} ngx_tcp_addr_conf_t;

typedef struct {
    in_addr_t                addr;
    ngx_tcp_addr_conf_t      conf;
} ngx_tcp_in_addr_t;


#if (NGX_HAVE_INET6)

typedef struct {
    struct in6_addr          addr6;
    ngx_tcp_addr_conf_t      conf;
} ngx_tcp_in6_addr_t;

#endif


typedef struct {
    /* ngx_tcp_in_addr_t or ngx_tcp_in6_addr_t */
    void                    *addrs;
    ngx_uint_t               naddrs;
} ngx_tcp_port_t;


typedef struct {
    int                      family;
    in_port_t                port;
    ngx_array_t              addrs;       /* array of ngx_tcp_conf_addr_t */
} ngx_tcp_conf_port_t;


typedef struct {
    struct sockaddr         *sockaddr;
    socklen_t                socklen;

    ngx_tcp_conf_ctx_t      *ctx;
    ngx_tcp_conf_ctx_t      *default_ctx;

    unsigned                 bind:1;
    unsigned                 wildcard:1;
#if (NGX_TCP_SSL)
    unsigned                 ssl:1;
#endif
#if (NGX_HAVE_INET6 && defined IPV6_V6ONLY)
    unsigned                 ipv6only:2;
#endif
} ngx_tcp_conf_addr_t;

typedef struct {
    in_addr_t                mask;
    in_addr_t                addr;
    ngx_uint_t               deny;      /* unsigned  deny:1; */
} ngx_tcp_access_rule_t;

typedef struct {
    ngx_array_t              servers;         /* ngx_tcp_core_srv_conf_t */
    ngx_array_t              listen;          /* ngx_tcp_listen_t */
    ngx_array_t              virtual_servers; /* ngx_tcp_virtual_server_t */
} ngx_tcp_core_main_conf_t;

typedef struct {
    ngx_open_file_t         *file;
    time_t                   disk_full_time;
    time_t                   error_log_time;
} ngx_tcp_log_t;

typedef struct {
    u_char                  *start;
    u_char                  *pos;
    u_char                  *last;
} ngx_tcp_log_buf_t;

typedef struct {
    ngx_array_t             *logs;       /* array of ngx_tcp_log_t */

    ngx_open_file_cache_t   *open_file_cache;
    time_t                   open_file_cache_valid;
    ngx_uint_t               open_file_cache_min_uses;

    ngx_uint_t               off;        /* unsigned  off:1 */
} ngx_tcp_log_srv_conf_t;


#define NGX_TCP_GENERIC_PROTOCOL    0
#define NGX_TCP_WEBSOCKET_PROTOCOL  1


struct ngx_tcp_core_srv_conf_s {
    /* array of the ngx_tcp_server_name_t, "server_name" directive */
    ngx_array_t              server_names;

    /* array of the ngx_tcp_core_loc_t, "location" directive */
    ngx_array_t              locations;

    ngx_tcp_protocol_t      *protocol;

    ngx_msec_t               timeout;
    ngx_msec_t               resolver_timeout;

    ngx_flag_t               so_keepalive;
    ngx_flag_t               tcp_nodelay;

    ngx_str_t                server_name;

    u_char                  *file_name;
    ngx_int_t                line;

    ngx_resolver_t          *resolver;

    /*ACL rules*/
    ngx_array_t             *rules;

    ngx_tcp_log_srv_conf_t  *access_log;

    /* server ctx */
    ngx_tcp_conf_ctx_t      *ctx;
};


typedef struct {
    ngx_str_t              *client;
    ngx_tcp_session_t      *session;
} ngx_tcp_log_ctx_t;


typedef void (*ngx_tcp_init_session_pt)(ngx_tcp_session_t *s);
typedef void (*ngx_tcp_init_protocol_pt)(ngx_event_t *rev);
typedef void (*ngx_tcp_parse_protocol_pt)(ngx_event_t *rev);


struct ngx_tcp_protocol_s {
    ngx_str_t                   name;
    in_port_t                   port[4];
    ngx_uint_t                  type;

    ngx_tcp_init_session_pt     init_session;
    ngx_tcp_init_protocol_pt    init_protocol;
    ngx_tcp_parse_protocol_pt   parse_protocol;

    ngx_str_t                   internal_server_error;
};


typedef struct {
    ngx_tcp_protocol_t         *protocol;

    void                       *(*create_main_conf)(ngx_conf_t *cf);
    char                       *(*init_main_conf)(ngx_conf_t *cf, void *conf);

    void                       *(*create_srv_conf)(ngx_conf_t *cf);
    char                       *(*merge_srv_conf)(ngx_conf_t *cf, void *prev,
                                      void *conf);
} ngx_tcp_module_t;


#define NGX_TCP_MODULE         0x00504354     /* "TCP" */

#define NGX_TCP_MAIN_CONF      0x02000000
#define NGX_TCP_SRV_CONF       0x04000000
#define NGX_TCP_LOC_CONF       0x08000000
#define NGX_TCP_UPS_CONF       0x10000000


#define NGX_TCP_MAIN_CONF_OFFSET  offsetof(ngx_tcp_conf_ctx_t, main_conf)
#define NGX_TCP_SRV_CONF_OFFSET   offsetof(ngx_tcp_conf_ctx_t, srv_conf)


#define ngx_tcp_get_module_ctx(s, module)     (s)->ctx[module.ctx_index]
#define ngx_tcp_set_ctx(s, c, module)         s->ctx[module.ctx_index] = c;
#define ngx_tcp_delete_ctx(s, module)         s->ctx[module.ctx_index] = NULL;


#define ngx_tcp_get_module_main_conf(s, module)                             \
    (s)->main_conf[module.ctx_index]
#define ngx_tcp_get_module_srv_conf(s, module)  (s)->srv_conf[module.ctx_index]

#define ngx_tcp_conf_get_module_main_conf(cf, module)                       \
    ((ngx_tcp_conf_ctx_t *) cf->ctx)->main_conf[module.ctx_index]
#define ngx_tcp_conf_get_module_srv_conf(cf, module)                        \
    ((ngx_tcp_conf_ctx_t *) cf->ctx)->srv_conf[module.ctx_index]

#define ngx_tcp_cycle_get_module_main_conf(cycle, module)                   \
    (cycle->conf_ctx[ngx_tcp_module.index] ?                                \
        ((ngx_tcp_conf_ctx_t *) cycle->conf_ctx[ngx_tcp_module.index])      \
            ->main_conf[module.ctx_index]:                                  \
        NULL)

extern ngx_uint_t    ngx_tcp_max_module;
extern ngx_module_t  ngx_tcp_core_module;
extern ngx_module_t  ngx_tcp_module;

#endif /* _NGX_TCP_H_INCLUDED_ */