Skip to content

Commit d109bd0

Browse files
committed
add readme for server usage
1 parent 15fa30d commit d109bd0

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,39 @@ client.stop()
6868
```js
6969
var Server = require('bittorrent-tracker').Server
7070

71-
// TODO
71+
var server = new Server()
72+
73+
// you must add an 'error' event handler!
74+
server.on('error', function (err) {
75+
console.log(err.message)
76+
})
77+
78+
server.on('listening', function () {
79+
console.log('tracker server is listening!')
80+
})
81+
82+
// listen for individual tracker messages from peers:
83+
84+
server.on('start', function (addr, params) {
85+
console.log('got start message from ' + addr)
86+
console.log('params in the message: ' + JSON.stringify(params))
87+
})
88+
89+
server.on('complete', function (addr, params) {})
90+
server.on('update', function (addr, params) {})
91+
server.on('stop', function (addr, params) {})
92+
93+
// get info hashes for all torrents in the tracker server
94+
Object.keys(server.torrents)
95+
96+
// get the number of seeders for a particular torrent
97+
server.torrents[infoHash].complete
98+
99+
// get the number of leechers for a particular torrent
100+
server.torrents[infoHash].incomplete
101+
102+
// get the peers who are in a particular torrent swarm
103+
server.torrents[infoHash].peers
72104
```
73105

74106
## license

0 commit comments

Comments
 (0)