fluencelabs/js-libp2p-interfaces
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-interfaces synced 2025-04-22 20:22:24 +00:00
Code Issues Projects Releases Wiki Activity

feat(spec): update the dial interface to cope with new pull additions

Browse Source
This commit is contained in:
David Dias 2016-08-19 14:37:40 +01:00
parent 02b3210806
commit 2e12166ba8
1 changed files with 1 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -62,8 +62,6 @@ A valid (read: that follows the interface defined) transport, must implement the
- type: `Transport`
- `new Transport([options])`
- `transport.dial(multiaddr, [options, callback])`
- event: 'connect'
- event: 'error'
- `transport.createListener([options], handlerFunction)`
- type: `transport.Listener`
- event: 'listening'
@ -96,12 +94,7 @@ This method dials a transport to the Peer listening on `multiaddr`.
`callback` should follow the `function (err, conn)` signature.
`conn` is the same `conn` that gets returned by call, which should follow [`interface-connection`](https://github.com/diasdavid/interface-connection). This `conn` object can emit 3 extra events:
- `connect` -
- `timeout` -
- `error` -
`conn` is the same `conn` that gets returned by call, which should follow [`interface-connection`](https://github.com/diasdavid/interface-connection). `err` is an `Error` instance to signal that the dial was unsuccessful, this error can be a 'timeout' or simply 'error'.
### Create a listener