transmission

package module
v0.0.0-...-c999c1b Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 15, 2026 License: MIT Imports: 11 Imported by: 0

README

Go Transmission

Golang lib for Transmission API

Installation
$ go get github.com/licryle/go-transmission
Usage
package main

import (
	"log"

	"github.com/licryle/go-transmission"
)

func main() {
	client := transmission.New("http://127.0.0.1:9091", "", "")

	torrents, err := client.GetTorrents()
	if err != nil {
		log.Panic(err)
	}

	for _, torrent := range torrents {
		log.Println("Torrent:")
		log.Println("   ID:            ", torrent.ID)
		log.Println("   Name:          ", torrent.Name)
		log.Println("   Status:        ", torrent.Status)
		log.Println("   LeftUntilDone: ", torrent.LeftUntilDone)
		log.Println("   Eta:           ", torrent.Eta)
		log.Println("   UploadRatio:   ", torrent.UploadRatio)
		log.Println("   RateDownload:  ", torrent.RateDownload)
		log.Println("   RateUpload:    ", torrent.RateUpload)
		log.Println("   DownloadDir:   ", torrent.DownloadDir)
		log.Println("   IsFinished:    ", torrent.IsFinished)
		log.Println("   PercentDone:   ", torrent.PercentDone)
		log.Println("   SeedRatioMode: ", torrent.SeedRatioMode)
	}
}
Original author

Long Nguyen (https://github.com/longnguyen11288/go-transmission)

Documentation

Index

Constants

View Source 
const (
	StatusStopped = iota
	StatusCheckPending
	StatusChecking
	StatusDownloadPending
	StatusDownloading
	StatusSeedPending
	StatusSeeding
)
View Source 
const (
	DownloadLimitType = "downloadlimit"
	UploadLimitType   = "uploadlimit"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiClient 

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

func NewClient 

func NewClient(url, username, password string) *ApiClient

func (*ApiClient) CreateClient 

func (ac *ApiClient) CreateClient(apiToken string)

func (*ApiClient) Post 

func (ac *ApiClient) Post(body string) ([]byte, error)

type Command 

type Command struct {
	Method    string    `json:"method,omitempty"`
	Arguments arguments `json:"arguments,omitempty"`
	Result    string    `json:"result,omitempty"`
}

func NewAddCmd 

func NewAddCmd() *Command

func NewAddCmdByFile 

func NewAddCmdByFile(file string) (*Command, error)

func NewAddCmdByFilename 

func NewAddCmdByFilename(filename string) *Command

func NewAddCmdByURL 

func NewAddCmdByURL(url string) *Command

URL or magnet

func NewGetTorrentsCmd 

func NewGetTorrentsCmd() *Command

func NewSessionSetCommand 

func NewSessionSetCommand() *Command

func NewSpeedLimitCommand 

func NewSpeedLimitCommand(limitType SpeedLimitType, limit uint) *Command

newSpeedLimitCommand creates a new command that mutates either a download or upload limit.

func (*Command) SetDownloadDir 

func (cmd *Command) SetDownloadDir(dir string)

type Sorting 

type Sorting int
const (
	SortID Sorting = iota
	SortRevID
	SortName
	SortRevName
	SortAge
	SortRevAge
	SortSize
	SortRevSize
	SortProgress
	SortRevProgress
	SortDownSpeed
	SortRevDownSpeed
	SortUpSpeed
	SortRevUpSpeed
	SortDownloaded
	SortRevDownloaded
	SortUploaded
	SortRevUploaded
	SortRatio
	SortRevRatio
)

type SpeedLimitType 

type SpeedLimitType string

type Stats 

type Stats struct {
	ActiveTorrentCount int
	CumulativeStats    cumulativeStats
	CurrentStats       currentStats
	DownloadSpeed      uint64
	PausedTorrentCount int
	TorrentCount       int
	UploadSpeed        uint64
}

session-stats

func (*Stats) CumulativeActiveTime 

func (s *Stats) CumulativeActiveTime() string

func (*Stats) CurrentActiveTime 

func (s *Stats) CurrentActiveTime() string

type Torrent 

type Torrent struct {
	ID             int           `json:"id"`
	Name           string        `json:"name"`
	Status         int           `json:"status"`
	AddedDate      int64         `json:"addedDate"`
	LeftUntilDone  uint64        `json:"leftUntilDone"`
	SizeWhenDone   uint64        `json:"sizeWhenDone"`
	Eta            time.Duration `json:"eta"`
	UploadRatio    float64       `json:"uploadRatio"`
	RateDownload   uint64        `json:"rateDownload"`
	RateUpload     uint64        `json:"rateUpload"`
	DownloadDir    string        `json:"downloadDir"`
	DownloadedEver uint64        `json:"downloadedEver"`
	UploadedEver   uint64        `json:"uploadedEver"`
	HashString     string        `json:"hashString"`
	HaveUnchecked  uint64        `json:"haveUnchecked"`
	HaveValid      uint64        `json:"haveValid"`
	IsFinished     bool          `json:"isFinished"`
	PercentDone    float64       `json:"percentDone"`
	SeedRatioMode  int           `json:"seedRatioMode"`
	Trackers       []tracker     `json:"trackers"`
	Error          int           `json:"error"`
	ErrorString    string        `json:"errorString"`
}

Torrent struct for torrents

func (*Torrent) ETA 

func (t *Torrent) ETA() string

ETA returns the time left for the download to finish

func (*Torrent) GetTrackers 

func (t *Torrent) GetTrackers() string

GetTrackers combines the torrent's trackers in one string

func (*Torrent) Have 

func (t *Torrent) Have() uint64

Have returns haveValid + haveUnchecked

func (*Torrent) Ratio 

func (t *Torrent) Ratio() string

Ratio returns the upload ratio of the torrent

func (*Torrent) TorrentStatus 

func (t *Torrent) TorrentStatus() string

Status translates the status of the torrent

type TorrentAdded 

type TorrentAdded struct {
	HashString string `json:"hashString"`
	ID         int    `json:"id"`
	Name       string `json:"name"`
}

TorrentAdded data returning

type Torrents 

type Torrents []*Torrent

Torrents represent []Torrent

func (Torrents) GetHashes 

func (t Torrents) GetHashes() []string

GetHashes returns []string of all the hashes

func (Torrents) GetIDs 

func (t Torrents) GetIDs() []int

GetIDs returns []int of all the ids

func (Torrents) SortAge 

func (t Torrents) SortAge(reverse bool)

func (Torrents) SortDownSpeed 

func (t Torrents) SortDownSpeed(reverse bool)

func (Torrents) SortDownloaded 

func (t Torrents) SortDownloaded(reverse bool)

func (Torrents) SortID 

func (t Torrents) SortID(reverse bool)

func (Torrents) SortName 

func (t Torrents) SortName(reverse bool)

func (Torrents) SortProgress 

func (t Torrents) SortProgress(reverse bool)

func (Torrents) SortRatio 

func (t Torrents) SortRatio(reverse bool)

func (Torrents) SortSize 

func (t Torrents) SortSize(reverse bool)

func (Torrents) SortUpSpeed 

func (t Torrents) SortUpSpeed(reverse bool)

func (Torrents) SortUploaded 

func (t Torrents) SortUploaded(reverse bool)

type TransmissionClient 

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

TransmissionClient to talk to transmission

func New 

func New(url string, username string, password string) (*TransmissionClient, error)

New create new transmission torrent

func (*TransmissionClient) DeleteTorrent 

func (ac *TransmissionClient) DeleteTorrent(identifier any, wd bool) (string, error)

Delete takes a bool, if true it will delete with data; returns the name of the deleted torrent if it succeed

func (*TransmissionClient) ExecuteAddCommand 

func (ac *TransmissionClient) ExecuteAddCommand(addCmd *Command) (TorrentAdded, error)

func (*TransmissionClient) ExecuteCommand 

func (ac *TransmissionClient) ExecuteCommand(cmd *Command) (*Command, error)

func (*TransmissionClient) GetStats 

func (ac *TransmissionClient) GetStats() (*Stats, error)

GetStats returns "session-stats"

func (*TransmissionClient) GetTorrent 

func (ac *TransmissionClient) GetTorrent(identifier any) (*Torrent, error)

GetTorrent takes an id and returns *Torrent

func (*TransmissionClient) GetTorrents 

func (ac *TransmissionClient) GetTorrents() (Torrents, error)

GetTorrents get a list of torrents

func (*TransmissionClient) SetSort 

func (ac *TransmissionClient) SetSort(st Sorting)

SetSort takes a 'Sorting' to set 'sortType'

func (*TransmissionClient) StartAll 

func (ac *TransmissionClient) StartAll() error

StartAll starts all the torrents

func (*TransmissionClient) StartTorrent 

func (ac *TransmissionClient) StartTorrent(identifier any) (string, error)

StartTorrent start the torrent

func (*TransmissionClient) StopAll 

func (ac *TransmissionClient) StopAll() error

StopAll stops all torrents

func (*TransmissionClient) StopTorrent 

func (ac *TransmissionClient) StopTorrent(identifier any) (string, error)

StopTorrent start the torrent

func (*TransmissionClient) VerifyAll 

func (ac *TransmissionClient) VerifyAll() error

VerifyAll verfies all torrents

func (*TransmissionClient) VerifyTorrent 

func (ac *TransmissionClient) VerifyTorrent(identifier any) (string, error)

VerifyTorrent verifies a torrent

func (*TransmissionClient) Version 

func (ac *TransmissionClient) Version() string

Version returns transmission's version

Source Files

View all Source files

Directories

Path Synopsis
examples
lookup command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.