summaryrefslogtreecommitdiff
path: root/pod/nginx/stream_processing.pod
blob: 83d79497472a38b0bb721bc938cc0a6ec26f824f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
=encoding utf-8


=head1 Name


stream_processing - How nginx processes a TCP/UDP session


=head1



A TCPE<sol>UDP session from a client is processed
in successive steps called B<phases>:


=over



=item 
C<Post-accept>





The first phase after accepting a client connection.
The L<ngx_stream_realip_module|ngx_stream_realip_module>
module is invoked at this phase.



=item 
C<Pre-access>





Preliminary check for access.
The
L<ngx_stream_limit_conn_module|ngx_stream_limit_conn_module>
and
L<ngx_stream_set_module|ngx_stream_set_module>
modules are invoked at this phase.



=item 
C<Access>





Client access limitation before actual data processing.
At this phase,
the L<ngx_stream_access_module|ngx_stream_access_module>
module is invoked,
for L<njs|index>,
the L<ngx_stream_js_module> directive
is invoked.



=item 
C<SSL>





TLSE<sol>SSL termination.
The L<ngx_stream_ssl_module|ngx_stream_ssl_module>
module is invoked at this phase.



=item 
C<Preread>





Reading initial bytes of data into the
L<preread buffer|ngx_stream_core_module>
to allow modules such as
L<ngx_stream_ssl_preread_module|ngx_stream_ssl_preread_module>
analyze the data before its processing.
For L<njs|index>,
the L<ngx_stream_js_module> directive
is invoked at this phase.



=item 
C<Content>





Mandatory phase where data is actually processed, usually
L<proxied|ngx_stream_proxy_module> to
L<upstream|ngx_stream_upstream_module> servers,
or a specified value
is L<returned|ngx_stream_return_module> to a client.
For L<njs|index>,
the L<ngx_stream_js_module> directive
is invoked at this phase.



=item 
C<Log>





The final phase
where the result of a client session processing is recorded.
The L<ngx_stream_log_module|ngx_stream_log_module>
module is invoked at this phase.



=back