diff options
| author | Loic Guegan <manzerbredes@mailbox.org> | 2022-06-09 21:57:21 +0200 |
|---|---|---|
| committer | Loic Guegan <manzerbredes@mailbox.org> | 2022-06-09 21:57:21 +0200 |
| commit | 266292a66ae113dc409a2e0428c05d15a0e9e160 (patch) | |
| tree | 104ac9661e332a58feaae1c5e18ca75272179ced /README.md | |
| parent | 03eab9f6b34e3469229c8135b7533f1328e3f4d2 (diff) | |
Update the API in Readme.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 10 insertions, 8 deletions
@@ -17,14 +17,16 @@ It is a short learning curve and coarse-grain network simulator. It contains the **Current API:** - `api.args` -- `api.send(interface, data,size, dst)` -- `api.sendt(interface, data,size, dst,timeout)` -- `api.receive(interface)` -- `api.receivet(interface,timeout)` -- `api.clock()` -- `api.log(msg)` -- `api.wait(duration)` -- `api.turn_off(duration)` +- `api.send(<int>,<data>,<size>,<dst>)` +- `api.sendt(<int>,<data>,<size>,<dst>,<t>)` +- `api.receive(<int>)` +- `api.receivet(<int>,<t>)` +- `api.wait(<t>)` +- `api.wait_end()` +- `api.log(<message>)` +- `api.read(<register>)` +- `api.turn_on()` +- `api.turn_off()` - *More details in [example/sender.py](example/sender.py)* **Documentation:** cf. `example/` and `tests/` |
