Skip to content

Commit 776e80a

Browse files
Clean up README.md.
1 parent 079fe11 commit 776e80a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
High-performance TCP proxy implemented in C.
44

5+
## Usage
6+
cproxy -l <local addr>:<local port> [-l <local addr>:<local port>...]
7+
-r <remote addr>:<remote port> [-b <buf size>] [-n] [-t <num io threads>]
8+
Arguments:
9+
-l <local addr>:<local port>: specify listen address and port
10+
-r <remote addr>:<remote port>: specify remote address and port
11+
-b <buf size>: specify session buffer size in bytes
12+
-n: enable TCP no delay
13+
-t: <num io threads>: specify number of I/O threads
14+
515
## Theory of Operation
616
* 1 acceptor thread to accept incoming client connections.
717
* Pool of 1 to N I/O threads to handle read, write, and connect operations. Pool size is configurable with -t option. Client sessions assigned to I/O threads using round robin.

0 commit comments

Comments
 (0)