jackhadrill/ut_metadata
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated examples in readme

Browse Source
This commit is contained in:
Jimmy Wärting 2018-08-28 13:27:03 +02:00
parent 2034e9ed2c
commit 6a0f5aecbe
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -30,15 +30,15 @@ This package should be used with [bittorrent-protocol](https://www.npmjs.com/pac
Say you're already using `bittorrent-protocol`. Your code might look something like this: Say you're already using `bittorrent-protocol`. Your code might look something like this:
```js ```js
var Protocol = require('bittorrent-protocol') const Protocol = require('bittorrent-protocol')
var net = require('net') const net = require('net')
net.createServer(function (socket) { net.createServer(socket => {
var wire = new Protocol() var wire = new Protocol()
socket.pipe(wire).pipe(socket) socket.pipe(wire).pipe(socket)
// handle handshake // handle handshake
wire.on('handshake', function (infoHash, peerId) { wire.on('handshake', (infoHash, peerId) => {
wire.handshake(new Buffer('my info hash'), new Buffer('my peer id')) wire.handshake(new Buffer('my info hash'), new Buffer('my peer id'))
}) })
@ -48,12 +48,12 @@ net.createServer(function (socket) {
To add support for BEP 9, simply modify your code like this: To add support for BEP 9, simply modify your code like this:
```js ```js
var Protocol = require('bittorrent-protocol') const Protocol = require('bittorrent-protocol')
var net = require('net') const net = require('net')
var ut_metadata = require('ut_metadata') const ut_metadata = require('ut_metadata')
net.createServer(function (socket) { net.createServer(socket => {
var wire = new Protocol() const wire = new Protocol()
socket.pipe(wire).pipe(socket) socket.pipe(wire).pipe(socket)
// initialize the extension // initialize the extension
@ -65,7 +65,7 @@ net.createServer(function (socket) {
wire.ut_metadata.fetch() wire.ut_metadata.fetch()
// 'metadata' event will fire when the metadata arrives and is verified to be correct! // 'metadata' event will fire when the metadata arrives and is verified to be correct!
wire.ut_metadata.on('metadata', function (metadata) { wire.ut_metadata.on('metadata', metadata => {
// got metadata! // got metadata!
// Note: the event will not fire if the peer does not support ut_metadata, if they // Note: the event will not fire if the peer does not support ut_metadata, if they
@ -75,12 +75,12 @@ net.createServer(function (socket) {
// optionally, listen to the 'warning' event if you want to know that metadata is // optionally, listen to the 'warning' event if you want to know that metadata is
// probably not going to arrive for one of the above reasons. // probably not going to arrive for one of the above reasons.
wire.ut_metadata.on('warning', function (err) { wire.ut_metadata.on('warning', err => {
console.log(err.message) console.log(err.message)
}) })
// handle handshake // handle handshake
wire.on('handshake', function (infoHash, peerId) { wire.on('handshake', (infoHash, peerId) => {
wire.handshake(new Buffer('my info hash'), new Buffer('my peer id')) wire.handshake(new Buffer('my info hash'), new Buffer('my peer id'))
}) })
@ -95,7 +95,7 @@ Initialize the extension. If you have the torrent metadata (Buffer), pass it int
`ut_metadata` constructor so it's made available to the peer. `ut_metadata` constructor so it's made available to the peer.
```js ```js
var metadata = fs.readFileSync(__dirname + '/file.torrent') const metadata = fs.readFileSync(__dirname + '/file.torrent')
wire.use(ut_metadata(metadata)) wire.use(ut_metadata(metadata))
``` ```
@ -119,7 +119,7 @@ Fired when metadata is available and verified to be correct. Called with a singl
parameter of type Buffer. parameter of type Buffer.
```js ```js
wire.ut_metadata.on('metadata', function (metadata) { wire.ut_metadata.on('metadata', metadata => {
console.log(Buffer.isBuffer(metadata)) // true console.log(Buffer.isBuffer(metadata)) // true
}) })
``` ```
@ -136,7 +136,7 @@ Fired if:
- the peer repeatedly sent invalid data - the peer repeatedly sent invalid data
```js ```js
wire.ut_metadata.on('warning', function (err) { wire.ut_metadata.on('warning', err => {
console.log(err.message) console.log(err.message)
}) })
``` ```