Mirror/bittorrent-tracker
1
0
Fork 0
mirror of https://github.com/webtorrent/bittorrent-tracker.git synced 2025-01-31 10:31:36 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

add tracker server jsdoc comment

Browse Source
This commit is contained in:
Feross Aboukhadijeh 2014-05-18 17:58:03 -07:00
parent dfd235d387
commit 418e996b81
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
index.js
View File

@ -453,6 +453,20 @@ Client.prototype.setInterval = function (intervalMs) {
inherits(Server, EventEmitter) inherits(Server, EventEmitter)
/**
* A BitTorrent tracker server.
*
* A "BitTorrent tracker" is an HTTP service which responds to GET requests from
* BitTorrent clients. The requests include metrics from clients that help the tracker
* keep overall statistics about the torrent. The response includes a peer list that
* helps the client participate in the torrent.
*
* @param {Object} opts options
* @param {Number} opts.interval interval in ms that clients should announce on
* @param {Number} opts.trustProxy Trust 'x-forwarded-for' header from reverse proxy
* @param {boolean} opts.http Start an http server? (default: true)
* @param {boolean} opts.udp Start a udp server? (default: true)
*/
function Server (opts) { function Server (opts) {
var self = this var self = this
if (!(self instanceof Server)) return new Server(opts) if (!(self instanceof Server)) return new Server(opts)