Skip to content
This repository has been archived by the owner on Mar 11, 2020. It is now read-only.

Commit

Permalink
feat(spec): update the dial interface to cope with new pull additions
Browse files Browse the repository at this point in the history
  • Loading branch information
daviddias committed Sep 5, 2016
1 parent 02b3210 commit 2e12166
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 2e12166

Please sign in to comment.