api

package

v0.0.8 Latest Latest Go to latest Published: Apr 2, 2021 License: MIT Imports: 15 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

This section is empty.

This section is empty.

func CORSMiddleware(origin string) gin.HandlerFunc

func Logger(logger *logging.Logger) gin.HandlerFunc

func Routes(config *settings.Settings, service *bittorrent.Service, origin string) *gin.Engine

Routes defines all the routes of the server

type ErrorResponse struct {
	Error string `json:"error" example:"Houston, we have a problem!"`
}

func NewErrorResponse(err interface{}) *ErrorResponse

type FileHash struct {
	Hash string `json:"hash"`
}

type FileInfoResponse struct {
	*bittorrent.FileInfo
	Status *bittorrent.FileStatus `json:"status,omitempty"`
}

type MessageResponse struct {
	Message string `json:"message" example:"done"`
}

func NewMessageResponse(format string, a ...interface{}) *MessageResponse

type NewTorrentResponse struct {
	InfoHash string `json:"info_hash" example:"000102030405060708090a0b0c0d0e0f10111213"`
}

type TorrentInfoResponse struct {
	*bittorrent.TorrentInfo
	Status *bittorrent.TorrentStatus `json:"status,omitempty"`
}