Skip to content

Added syntax highlighting #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
glumb wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added syntax highlighting #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,24 @@ This module exports two classes, `Throttle` and `ThrottleGroup`.
The `opts` object may also contain options to be passed to the `stream.Transform` constructor.

For example, the following code throttles stdin to stdout at 10 bytes per second:

process.stdin.pipe(new Throttle({rate: 10})).pipe(process.stdout)

```js
process.stdin.pipe(new Throttle({rate: 10})).pipe(process.stdout)
```
`ThrottleGroup` allows the creation of a group of streams whose aggregate bandwidth is throttled. The constructor accepts the same `opts` argument as for `Throttle`. Call `throttle` on a `ThrottleGroup` object to create a new throttled stream belonging to the group.

For example, the following code creates two HTTP connections to `www.google.com:80`, and throttles their aggregate (downstream) bandwidth to 10 KB/s:
```js
var addr = { host: 'www.google.com', port: 80 };
var tg = new ThrottleGroup({rate: 10240});

var addr = { host: 'www.google.com', port: 80 };
var tg = new ThrottleGroup({rate: 10240});

var conn1 = net.createConnection(addr),
conn2 = net.createConnection(addr);

var thr1 = conn1.pipe(tg.throttle()),
thr2 = conn2.pipe(tg.throttle());
var conn1 = net.createConnection(addr),
conn2 = net.createConnection(addr);

// Reads from thr1 and thr2 are throttled to 10 KB/s in aggregate
var thr1 = conn1.pipe(tg.throttle()),
thr2 = conn2.pipe(tg.throttle());

// Reads from thr1 and thr2 are throttled to 10 KB/s in aggregate
```
## Command line usage

This package installs a `throttleproxy` binary which implements a command-line utility for throttling connections. Run `throttleproxy -h` for instructions.
Expand Down