Skip to content

Commit c3a78e6

Browse files
committed
QUIC description
1 parent 9fbfbd1 commit c3a78e6

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.rst

+11-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
python-proxy
22
============
33

4-
|made-with-python| |PyPI-version| |Hit-Count| |Downloads|
4+
|made-with-python| |PyPI-version| |Hit-Count| |Downloads| |Downloads(month)| |Downloads(week)|
55

66
.. |made-with-python| image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
77
:target: https://www.python.org/
@@ -11,6 +11,10 @@ python-proxy
1111
:target: https://pypi.python.org/pypi/pproxy/
1212
.. |Downloads| image:: https://pepy.tech/badge/pproxy
1313
:target: https://pepy.tech/project/pproxy
14+
.. |Downloads(month)| image:: https://pepy.tech/badge/pproxy/month)
15+
:target: https://pepy.tech/project/pproxy
16+
.. |Downloads(week)| image:: https://pepy.tech/badge/pproxy/week)
17+
:target: https://pepy.tech/project/pproxy
1418

1519
HTTP/HTTP2/HTTP3/Socks4/Socks5/Shadowsocks/SSH/Redirect/Pf/QUIC TCP/UDP asynchronous tunnel proxy implemented in Python3 asyncio.
1620

@@ -101,7 +105,7 @@ Protocols
101105
+-------------------+------------+------------+------------+------------+--------------+
102106
| http v2 (connect) ||| | | h2:// |
103107
+-------------------+------------+------------+------------+------------+--------------+
104-
| http v3 (connect) | | | | | h3:// |
108+
| http v3 (connect) |by UDP |by UDP | | | h3:// |
105109
+-------------------+------------+------------+------------+------------+--------------+
106110
| https ||| | | http+ssl:// |
107111
+-------------------+------------+------------+------------+------------+--------------+
@@ -121,7 +125,7 @@ Protocols
121125
+-------------------+------------+------------+------------+------------+--------------+
122126
| ssh tunnel | || | | ssh:// |
123127
+-------------------+------------+------------+------------+------------+--------------+
124-
| quic | | ||| http+quic:// |
128+
| quic |by UDP |by UDP ||| http+quic:// |
125129
+-------------------+------------+------------+------------+------------+--------------+
126130
| iptables nat || | | | redir:// |
127131
+-------------------+------------+------------+------------+------------+--------------+
@@ -722,16 +726,17 @@ Examples
722726

723727
- QUIC protocol example
724728

725-
QUIC is a UDP stream protocol in HTTP/3. Library **aioquic** is required if you want to proxy via QUIC.
729+
QUIC is a UDP stream protocol used in HTTP/3. Library **aioquic** is required if you want to proxy via QUIC.
730+
QUIC is listened on UDP port, but can handle TCP or UDP traffic. If you want to handle TCP traffic, you should use "-l quic+http" instead of "-ul quic+http".
726731

727732
.. code:: rst
728733
729734
$ pip3 install aioquic
730-
$ pproxy --ssl ssl.crt,ssl.key -l quic://:1234
735+
$ pproxy --ssl ssl.crt,ssl.key -l quic+http://:1234
731736
732737
On the client:
733738

734-
$ pproxy -r quic://server:1234
739+
$ pproxy -r quic+http://server:1234
735740

736741
QUIC protocol can transfer a lot of TCP streams on one single UDP stream. If the connection number is hugh, QUIC can benefit by reducing TCP handshake time.
737742

0 commit comments

Comments
 (0)