stream-throttle

WebJar for stream-throttle

License	BSD-3-Clause
GroupId	org.webjars.npm
ArtifactId	stream-throttle
Last Version	0.1.3
Release Date	May 26, 2015
Type	jar
Description	stream-throttle WebJar for stream-throttle
Project URL	http://webjars.org
Source Code Management	http://github.com/tjgq/node-stream-throttle

Download stream-throttle

Filename	Size
stream-throttle-0.1.3.pom
stream-throttle-0.1.3.jar	8 KB
stream-throttle-0.1.3-sources.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/stream-throttle/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>stream-throttle</artifactId>
    <version>0.1.3</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/stream-throttle/
implementation 'org.webjars.npm:stream-throttle:0.1.3'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/stream-throttle/
implementation ("org.webjars.npm:stream-throttle:0.1.3")

Apache Buildr

'org.webjars.npm:stream-throttle:jar:0.1.3'

Apache Ivy

<dependency org="org.webjars.npm" name="stream-throttle" rev="0.1.3">
  <artifact name="stream-throttle" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='stream-throttle', version='0.1.3')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "stream-throttle" % "0.1.3"

Leiningen

[org.webjars.npm/stream-throttle "0.1.3"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : commander	jar	[2.2.0,3)
org.webjars.npm : limiter	jar	[1.0.5,2)

Project Modules

There are no modules declared in this project.

stream-throttle

A rate limiter for Node.js streams.

API usage

This module exports two classes, Throttle and ThrottleGroup.

Throttle creates a single throttled stream, based on stream.Transform. It accepts an opts parameter with the following keys:

• opts.rate is the throttling rate, in bytes per second.
• opts.chunksize (optional) is the maximum chunk size into which larger writes are decomposed; the default is opts.rate/10.

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)

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:

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());

// 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.

Contributing

Feel free to open an issue or send a pull request.

License

BSD-style. See the LICENSE file.

Author

Copyright © 2013 Tiago Quelhas. Contact me at <[email protected]>.

Versions

Version
0.1.3 May 26, 2015