欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  后端开发

《深入理解Nginx》笔记之 ngx_mail相关结构体

程序员文章站 2022-05-12 17:17:06
...
Nginx mail相关模块结构体

ngx_mail_module_t

这是mail模块的抽象接口,即ngx_module_t中的ctx成员所指向的mail模块特有接口。每一个mail模块都会实现自己的ngx_mail_module_t结构体。

typedefstruct {
     // POP3 STMP IMAP邮件模块提取出的通用接口
    ngx_mail_protocol_t        *protocol;

     // 用于创建main级别配置项的结构体void                       *(*create_main_conf)(ngx_conf_t *cf);

    // 解析完main级别配置项后被回调的函数char                       *(*init_main_conf)(ngx_conf_t *cf, void *conf);

     // 用于创建srv级别配置项的结构体void                       *(*create_srv_conf)(ngx_conf_t *cf);

    // 根据具体模块处理srv下和main下同名的配置项char                       *(*merge_srv_conf)(ngx_conf_t *cf, void *prev,
                                      void *conf);
} ngx_mail_module_t;

ngx_protocol_s

typedefstruct ngx_mail_protocol_s ngx_mail_protocol_t;

// 四个POP3 SMTP IMAP等应用级别的邮件模块所需要实现的接口方法typedefvoid (*ngx_mail_init_session_pt)(ngx_mail_session_t *s,
    ngx_connection_t *c);
typedefvoid (*ngx_mail_init_protocol_pt)(ngx_event_t *rev);
typedefvoid (*ngx_mail_auth_state_pt)(ngx_event_t *rev);
typedef ngx_int_t (*ngx_mail_parse_command_pt)(ngx_mail_session_t *s);


struct ngx_mail_protocol_s {
     // 邮件模块名称
    ngx_str_t                   name;

    // 当前邮件模块中所要监听的最常用4个端口
    in_port_t                   port[4];

    // 邮件模块类型
    ngx_uint_t                  type;

     // 与客户端建立起TCP连接后的初始化方法
    ngx_mail_init_session_pt    init_session;

    // 接收、解析客户端请求的方法
    ngx_mail_init_protocol_pt   init_protocol;

    // 解析客户端邮件协议的接口方法
    ngx_mail_parse_command_pt   parse_command;
    ngx_mail_auth_state_pt      auth_state;

     // 当处理中没有遇到错误时,返回internal_server_error指定的响应给客户端
    ngx_str_t                   internal_server_error;
    ngx_str_t                   cert_error;
    ngx_str_t                   no_cert;
};

ngx_mail_session_t

Nginx与客户端建立TCP连接后,将会回调ngx_mail_init_connection函数初始化邮件协议。这个时候,会创建一个类似于HTTP请求中的ngx_http_request_t这样的核心结构体:ngx_mail_session_s。

typedefstruct {
    uint32_t                signature;         /* "MAIL" */// 下游客户端和Nginx之间的连接
    ngx_connection_t       *connection;

     // 可存需要向下游客户端发送的内容
    ngx_str_t               out;

    // 用于接收来自客户端的请求
    ngx_buf_t              *buffer;

     // 指向一个指针数组,保存着这个请求中各个邮件模块的上下文建构体指针void                  **ctx;

    // main级别配置结构体组成的指针数组void                  **main_conf;

    // srv级别配置结构体组成的指针数组void                  **srv_conf;

     // 解析主机域名
    ngx_resolver_ctx_t     *resolver_ctx;

     // proxy上下文,用于Nginx双向透传客户端与邮件服务器间的通信
    ngx_mail_proxy_ctx_t   *proxy;

     // 表示与邮件服务器交互时,当前处于哪种状态
    ngx_uint_t              mail_state;

     // 邮件协议类型unsigned                protocol:3;

    // 1:表示当前读或写操作需要被阻塞unsigned                blocked:1;

    // 1:请求需要结束unsigned                quit:1;

    // 一下三个标志位仅在解析具体邮件协议时由邮件框架使用unsigned                quoted:1;
    unsigned                backslash:1;
    unsigned                no_sync_literal:1;

    // 当使用SSL协议时才有意义unsigned                starttls:1;
    unsigned                esmtp:1;

    // 表示与认证服务器交互时的记录认证方式unsigned                auth_method:3;

    // 1:表示认证服务器要求暂缓接收响应,Nginx会继续等待认证服务器的后续响应unsigned                auth_wait:1;

     // 验证时的用户名
    ngx_str_t               login;

    // 验证时的密码
    ngx_str_t               passwd;

     // 作为Auth-Salt验证的信息
    ngx_str_t               salt;

    // 一下三个成员仅用于IMAP通信
    ngx_str_t               tag;
    ngx_str_t               tagged_line;
    ngx_str_t               text;

     // 当前连接上对应的Nginx服务器地址
    ngx_str_t              *addr_text;

    // 主机地址
    ngx_str_t               host;

    //一下四个成员仅用于SMTP通信
    ngx_str_t               smtp_helo;
    ngx_str_t               smtp_from;
    ngx_str_t               smtp_to;

    ngx_str_t               cmd;

     // 在于邮件服务器交互时,表示解析自邮件服务器的消息类型
    ngx_uint_t              command;

    // 存放来自下游客户端的邮件协议中的参数
    ngx_array_t             args;

     // 当前请求尝试访问服务器验证的次数
    ngx_uint_t              login_attempt;

    /* used to parse POP3/IMAP/SMTP command */    ngx_uint_t              state;
    u_char                 *cmd_start;
    u_char                 *arg_start;
    u_char                 *arg_end;
    ngx_uint_t              literal_len;
} ngx_mail_session_t;

版权声明:Pain is just in your mind.

以上就介绍了《深入理解Nginx》笔记之 ngx_mail相关结构体,包括了方面的内容,希望对PHP教程有兴趣的朋友有所帮助。

《深入理解Nginx》笔记之 ngx_mail相关结构体

声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn核实处理。

相关文章

相关视频