bittorrent

package module

v0.0.0-...-101a212 Latest Latest Go to latest Published: Jan 1, 2022 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/alexchao26/bittorrent

Links

Open Source Insights

README ¶

BitTorrent client in Go

Initially based off of a blog post from Jesse Li to implement the OG BitTorrent protocol.

Public Domain (aka Legal) Torrents for Testing

Ubuntu Server LTS via torrent
- single file torrent
NASA Torrents, in particular these images from the Mars Viking Orbiter.
- multi-file torrent
- magnet link as well

Supports

Original Spec (BEP0003)
- Multi-file .torrent files
- Original and Compact Peer List formats (BEP0023)

TODO

Implement 'endgame mode' as described in BEP0003 for downloading the last few pieces
Seeding in OG .torrent protocol
Magnet links - might go w/ udp trackers
- UDP Trackers (BEP0015)
  - can acquire a list of peers (ip & port) from a UDP tracker url
- UDP Extensions (BEP0041)
- Extension to download metadata from peers (BEP0009)
DHT
PEX
Fast Extension (BEP0006)
Announce list - i.e. Multitracker Metadata Extension (BEP0012)
uTorrent Transport Protocol (BEP0029)
Some pretty terminal visual of pieces being downloaded?

Documentation ¶

Overview ¶

Package bittorrent implements the client side (downloads) of the BitTorrent protocol.

Index ¶

type Download
- func NewDownload(source string) (*Download, error)
- func (d *Download) Run(outDir string) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Download ¶

type Download struct {
	// contains filtered or unexported fields
}

func NewDownload ¶

func NewDownload(source string) (*Download, error)

NewDownload sets up a download given a source string (supports torrent file and magnet links. It attempts to get peer addresses from tracker servers, then gets metadata from peers if necessary (i.e. source is a magnet link). Once setup, the Download.Run() method will start the peer to peer download.

func (*Download) Run ¶

func (d *Download) Run(outDir string) error

Run the peer to peer download process, concurrently getting pieces from each connected peer.

The outDir defaults to the current directory, "./"

Source Files ¶

View all Source files

bittorrent.go

Directories ¶

Path	Synopsis
cmd
bittorrent
peer Package peer is a client implementation (TCP only) to peers in the swarm.	Package peer is a client implementation (TCP only) to peers in the swarm.
torrentfile Package torrentfile parses torrent files or magnet links.	Package torrentfile parses torrent files or magnet links.
tracker Package tracker gets peers from (HTTP/S and UDP) tracker servers.	Package tracker gets peers from (HTTP/S and UDP) tracker servers.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL