api

Documentation

Overview

Package api implements a RESTful HTTP JSON API server for a BitTorrent tracker.

Index

• type ResponseHandler
• type Server
  • func NewServer(cfg *config.Config, tkr *tracker.Tracker) *Server
  • func (s *Server) Serve()
  • func (s *Server) Setup() error
  • func (s *Server) Stop()

Types

type ResponseHandler

type ResponseHandler func(http.ResponseWriter, *http.Request, httprouter.Params) (int, error)

ResponseHandler is an HTTP handler that returns a status code.

type Server

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

Server represents an API server for a torrent tracker.

func NewServer

func NewServer(cfg *config.Config, tkr *tracker.Tracker) *Server

NewServer returns a new API server for a given configuration and tracker instance.

func (*Server) Serve

func (s *Server) Serve()

Serve runs an API server, blocking until the server has shut down.

func (*Server) Setup

func (s *Server) Setup() error

func (*Server) Stop

func (s *Server) Stop()

Stop cleanly shuts down the server.