By

在前面相关章节，我们知道nginx定义了ngx_connection_t数据结构来表示连接，这种连接通常表示由客户端主动发起、Nginx服务器被动接收的TCP连接（当然UDP连接也会用该结构来表示），称为被动连接。还有一类连接，在某些请求的处理过程中，Nginx会试图主动向其他上游服务器建立连接，并以此连接与上游服务器进行通信，Nginx定义ngx_peer_connection_t结构来表示，这类可以称为主动连接。本质上来说，主动连接是以ngx_connection_t结构体为基础实现的。

1. 相关函数指针

/*
 * Copyright (C) Igor Sysoev
 * Copyright (C) Nginx, Inc.
 */


#ifndef _NGX_EVENT_CONNECT_H_INCLUDED_
#define _NGX_EVENT_CONNECT_H_INCLUDED_


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


#define NGX_PEER_KEEPALIVE           1
#define NGX_PEER_NEXT                2
#define NGX_PEER_FAILED              4


typedef struct ngx_peer_connection_s  ngx_peer_connection_t;

typedef ngx_int_t (*ngx_event_get_peer_pt)(ngx_peer_connection_t *pc,
    void *data);
typedef void (*ngx_event_free_peer_pt)(ngx_peer_connection_t *pc, void *data,
    ngx_uint_t state);
#if (NGX_SSL)

typedef ngx_int_t (*ngx_event_set_peer_session_pt)(ngx_peer_connection_t *pc,
    void *data);
typedef void (*ngx_event_save_peer_session_pt)(ngx_peer_connection_t *pc,
    void *data);
#endif

ngx_peer_connection_t在使用过程中会有不同状态，这里定义相应的状态掩码：

  • NGX_PEER_KEEPALIVE: keepalive的状态掩码

  • NGX_PEER_NEXT: next状态掩码

  • NGX_PEER_FAILED: failed状态掩码

下面我们简要介绍一下上述的一些函数指针：

  • ngx_event_get_peer_pt: 通过该方法从连接池中获取一个新连接。一般会考虑采用round-robin、IP哈希或其他其他负载均衡的方式

  • ngx_event_free_peer_pt： 通过该方法将使用完毕的连接释放回连接池。

  • ngx_event_set_peer_session_pt： 通常用于SSL的连接，用于设置会话信息。当前我们支持NGX_SSL宏定义

  • ngx_event_save_peer_session_pt: 通常用于SSL的连接，用于保存会话信息。当前我们支持NGX_SSL宏定义

2. ngx_peer_connection_s数据结构

struct ngx_peer_connection_s {
    ngx_connection_t                *connection;

    struct sockaddr                 *sockaddr;
    socklen_t                        socklen;
    ngx_str_t                       *name;

    ngx_uint_t                       tries;
    ngx_msec_t                       start_time;

    ngx_event_get_peer_pt            get;
    ngx_event_free_peer_pt           free;
    void                            *data;

#if (NGX_SSL)
    ngx_event_set_peer_session_pt    set_session;
    ngx_event_save_peer_session_pt   save_session;
#endif

    ngx_addr_t                      *local;

    int                              type;
    int                              rcvbuf;

    ngx_log_t                       *log;

    unsigned                         cached:1;

                                     /* ngx_connection_log_error_e */
    unsigned                         log_error:2;
};

ngx_peer_connection_s用于代表一个Nginx向上游服务器的主动连接。下面我们简要介绍一下各字段的含义：

  • connection： 主动连接实际上需要被动连接结构的大部分成员，相当于重用

  • sockaddr: 远程服务器的socket地址

  • socklen: 远程服务器socket地址的长度

  • name: 远程服务器socket地址的字符串表示

  • tries: 连接失败可以重试的次数

  • start_time: 用于记录Nginx向上游服务器发起连接的初始时刻

  • get： 通过该方法从连接池中获取一个新连接。一般会考虑采用round-robin、IP哈希或其他其他负载均衡的方式

  • free: 通过该方法将使用完毕的连接释放回连接池。

  • data: 该data成员作为上面方法的传递参数

  • set_session: 通常用于SSL的连接，用于设置会话信息。当前我们支持NGX_SSL宏定义

  • save_session: 通常用于SSL的连接，用于保存会话信息。当前我们支持NGX_SSL宏定义

  • local: 用于保存连接的本地地址信息

  • rcvbuf: 接收缓冲区大小

  • log: 连接所关联的日志对象

  • cached: 标识该连接是一个缓存的连接

  • log_error: 取值为ngx_connection_log_error_e枚举中的值

3. 相关函数声明

//向上游服务器发起连接
ngx_int_t ngx_event_connect_peer(ngx_peer_connection_t *pc);

//此函数作为一个dummy函数，一般如果我们不需要从连接池中获取连接，则可设置为此dummy函数
ngx_int_t ngx_event_get_peer(ngx_peer_connection_t *pc, void *data);



[参看]

  1. Nginx学习笔记(十九)：Nginx连接