rpc

Documentation

Index

• func ApplyRouter() func(chi.Router)
• func Post(w http.ResponseWriter, r *http.Request)
• func WebSocket(w http.ResponseWriter, r *http.Request)
• type Args
• type NoArgs
• type Pending
• type Running
• type Service
  • func Container(db *internal.MemoryDB, mq *internal.MessageQueue, lm *livestream.Monitor) *Service
  • func (s *Service) Clear(args string, killed *string) error
  • func (s *Service) DirectoryTree(args NoArgs, tree *[]string) error
  • func (s *Service) Exec(args internal.DownloadRequest, result *string) error
  • func (s *Service) ExecLivestream(args internal.DownloadRequest, result *string) error
  • func (s *Service) ExecPlaylist(args internal.DownloadRequest, result *string) error
  • func (s *Service) Formats(args Args, meta *internal.DownloadFormats) error
  • func (s *Service) FreeSpace(args NoArgs, free *uint64) error
  • func (s *Service) Kill(args string, killed *string) error
  • func (s *Service) KillAll(args NoArgs, killed *string) error
  • func (s *Service) KillAllLivestream(args NoArgs, result *struct{}) error
  • func (s *Service) KillLivestream(args string, result *struct{}) error
  • func (s *Service) Pending(args NoArgs, pending *Pending) error
  • func (s *Service) Progess(args Args, progress *internal.DownloadProgress) error
  • func (s *Service) ProgressLivestream(args NoArgs, result *livestream.LiveStreamStatus) error
  • func (s *Service) Running(args NoArgs, running *Running) error
  • func (s *Service) UpdateExecutable(args NoArgs, updated *bool) error

Functions

func ApplyRouter

func ApplyRouter() func(chi.Router)

RPC service must be registered before applying this router!

func Post

func Post(w http.ResponseWriter, r *http.Request)

HTTP-POST JSON-RPC handler

func WebSocket

func WebSocket(w http.ResponseWriter, r *http.Request)

WebSockets JSON-RPC handler

Types

type Args

type Args struct {
	Id     string
	URL    string
	Params []string
}

type NoArgs

type NoArgs struct{}

type Pending

type Pending []string

type Running

type Running []internal.ProcessResponse

type Service

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

func Container

func Container(db *internal.MemoryDB, mq *internal.MessageQueue, lm *livestream.Monitor) *Service

Dependency injection container.

func (*Service) Clear

func (s *Service) Clear(args string, killed *string) error

Remove a process from the db rendering it unusable if active

func (*Service) DirectoryTree

func (s *Service) DirectoryTree(args NoArgs, tree *[]string) error

Return a flattned tree of the download directory

func (*Service) Exec

func (s *Service) Exec(args internal.DownloadRequest, result *string) error

Exec spawns a Process. The result of the execution is the newly spawned process Id.

func (*Service) ExecLivestream

func (s *Service) ExecLivestream(args internal.DownloadRequest, result *string) error

TODO: docs

func (*Service) ExecPlaylist

func (s *Service) ExecPlaylist(args internal.DownloadRequest, result *string) error

Exec spawns a Process. The result of the execution is the newly spawned process Id.

func (*Service) Formats

func (s *Service) Formats(args Args, meta *internal.DownloadFormats) error

Progess retrieves available format for a given resource

func (*Service) FreeSpace

func (s *Service) FreeSpace(args NoArgs, free *uint64) error

FreeSpace gets the available from package sys util

func (*Service) Kill

func (s *Service) Kill(args string, killed *string) error

Kill kills a process given its id and remove it from the memoryDB

func (*Service) KillAll

func (s *Service) KillAll(args NoArgs, killed *string) error

KillAll kills all process unconditionally and removes them from the memory db

func (*Service) KillAllLivestream

func (s *Service) KillAllLivestream(args NoArgs, result *struct{}) error

TODO: docs

func (*Service) KillLivestream

func (s *Service) KillLivestream(args string, result *struct{}) error

TODO: docs

func (*Service) Pending

func (s *Service) Pending(args NoArgs, pending *Pending) error

Pending retrieves a slice of all Pending/Running processes ids

func (*Service) Progess

func (s *Service) Progess(args Args, progress *internal.DownloadProgress) error

Progess retrieves the Progress of a specific Process given its Id

func (*Service) ProgressLivestream

func (s *Service) ProgressLivestream(args NoArgs, result *livestream.LiveStreamStatus) error

TODO: docs

func (*Service) Running

func (s *Service) Running(args NoArgs, running *Running) error

Running retrieves a slice of all Processes progress

func (*Service) UpdateExecutable

func (s *Service) UpdateExecutable(args NoArgs, updated *bool) error

Updates the yt-dlp binary using its builtin function