sdk

README

minion-sdk

Minion SDK allows you to integrate your app with the Minion Server enabling the auto-update feature for your Go based applications

Documentation

Index

• Constants
• Variables
• func NewUserAgentTransport(userAgent string, rt http.RoundTripper) *minionTransport
• type Minion
  • func New() *Minion
  • func (m *Minion) Apply(b []byte) error
  • func (m *Minion) Check(opts Options) (*UpdateResponse, error)
  • func (m *Minion) CurrentPath() (string, error)
  • func (m *Minion) Download(opts Options) ([]byte, error)
  • func (m *Minion) NewPath() (string, error)
  • func (m *Minion) OldPath() (string, error)
  • func (m *Minion) Reload() error
• type Options
• type ProgressReader
  • func (r *ProgressReader) Read(p []byte) (n int, err error)
• type UpdateResponse

Constants

const UserAgent = "minion-updater/1.0.0"

Variables

var UpdateNotAvailable = errors.New("no update available")

Functions

func NewUserAgentTransport

func NewUserAgentTransport(userAgent string, rt http.RoundTripper) *minionTransport

Types

type Minion

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

func New

func New() *Minion

func (*Minion) Apply

func (m *Minion) Apply(b []byte) error

func (*Minion) Check

func (m *Minion) Check(opts Options) (*UpdateResponse, error)

func (*Minion) CurrentPath

func (m *Minion) CurrentPath() (string, error)

func (*Minion) Download

func (m *Minion) Download(opts Options) ([]byte, error)

func (*Minion) NewPath

func (m *Minion) NewPath() (string, error)

func (*Minion) OldPath

func (m *Minion) OldPath() (string, error)

func (*Minion) Reload

func (m *Minion) Reload() error

type Options

type Options struct {
	AppId          string
	Version        string
	Channel        string
	UpdateCheckURL string
	NewVersion     string
}

type ProgressReader

type ProgressReader struct {
	io.Reader
	Reporter func(r int)
}

func (*ProgressReader) Read

func (r *ProgressReader) Read(p []byte) (n int, err error)

type UpdateResponse

type UpdateResponse struct {
	Success bool   `json:"success"`
	Version string `json:"version"`
}