Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 04a1fe4

Browse files
kvapkelvich
authored andcommitted
Describe more methods in mmts readme.
1 parent 386eb6d commit 04a1fe4

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,19 @@ Manages the database nodes.
2828
* `deploy(driver, ...)` - deploys a cluster using the specified `driver` and
2929
other parameters specific to that driver. Returns a `cluster` instance that is
3030
used in other methods.
31-
* `
31+
* `cluster->up(id)` - adds a node named `id` to the `cluster`.
32+
* `cluster->down(id)` - removes a node named `id` from the `cluster`.
33+
* `cluster->drop(src, dst, ratio)` - drop `ratio` packets flowing from node
34+
`src` to node `dst`.
35+
* `cluster->delay(src, dst, msec)` - delay packets flowing from node `src` to
36+
node `dst` by `msec` milliseconds.
3237

3338
#### `troubleaux`
3439

3540
This is the troublemaker that messes with the network, nodes and time.
3641

37-
* `cause(cluster, trouble)` - causes the specified `trouble` in the specified
38-
`cluster`.
42+
* `cause(cluster, trouble, ...)` - causes the specified `trouble` in the
43+
specified `cluster` with some trouble-specific parameters.
3944
* `fix(cluster)` - fixes all troubles caused in the `cluster`.
4045

4146
#### `valideaux`

0 commit comments

Comments
 (0)