relaylib

Documentation

Index

• Variables
• func Get(cl *client.Client, url string) (*json.RawMessage, error)
• func NewRelayStatus(cl *client.Client, scurl texturl.URL, cfg *relayentryext.T) (rs relayStatus, err error)
• func SubmitST(cl *client.Client, url string, st *sharetoken.T) error
• func SubmitSTFromFile(cl *client.Client, url, shares string) error
• func Withdraw(cl *client.Client, url string, destination string, amount int64) (*json.RawMessage, error)
• type Controller
  • func NewController(cl *client.Client, callback chan *status.T) *Controller
  • func (c *Controller) Contracts() (l []string)
  • func (c *Controller) Disable(contractId string) error
  • func (c *Controller) Disenroll(contractId string) error
  • func (c *Controller) DisenrollAll() (err error)
  • func (c *Controller) Enroll(contractId string) error
  • func (c *Controller) EnrollAll() (err error)
  • func (c *Controller) Load(scfg *relaycfg.C) (err error)
  • func (c *Controller) NetCap() (m map[string]uint64)
  • func (c *Controller) NewConn(contractId string) (ctx context.Context, err error)
  • func (c *Controller) Reload(scfg *relaycfg.C) (err error)
  • func (c *Controller) SCS() (m map[string]string)
  • func (c *Controller) Start() error
  • func (c *Controller) StartWithList(contractIds ...string) error
  • func (c *Controller) Started() bool
  • func (c *Controller) Status() (m map[string]RelayStatus)
  • func (c *Controller) Stop() error
• type RelayFlags
• type RelayStatus

Variables

var (
	ErrNotStarted           = errors.New("controller not started")
	ErrAlreadyStarted       = errors.New("controller already started")
	ErrContractNotFound     = errors.New("relay contract not found")
	ErrContractNotAvailable = errors.New("relay contract not available")
	ErrDisenroll            = errors.New("disenrollment patially failed, couldn't disenroll the following contracts")
)

var (
	ErrFetchDirUrl = errors.New("could not get directory URL")
	ErrRequest     = errors.New("could not create enrollment request")
	ErrReloadCfg   = errors.New("forbidden change, could not apply new relay config")
)

Functions

func Get

func Get(cl *client.Client, url string) (*json.RawMessage, error)

func NewRelayStatus

func NewRelayStatus(cl *client.Client, scurl texturl.URL, cfg *relayentryext.T) (rs relayStatus, err error)

func SubmitST

func SubmitST(cl *client.Client, url string, st *sharetoken.T) error

func SubmitSTFromFile

func SubmitSTFromFile(cl *client.Client, url, shares string) error

func Withdraw

func Withdraw(cl *client.Client, url string, destination string, amount int64) (*json.RawMessage, error)

Types

type Controller

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

Controller is the serverlib relay handler Interaction with the relays is always done through the controller

func NewController

func NewController(cl *client.Client, callback chan *status.T) *Controller

Create new controller instance

func (*Controller) Contracts

func (c *Controller) Contracts() (l []string)

Returns current contractIds

func (*Controller) Disable

func (c *Controller) Disable(contractId string) error

Disenroll relay by contractId

func (*Controller) Disenroll

func (c *Controller) Disenroll(contractId string) error

Disenroll relay by contractId

func (*Controller) DisenrollAll

func (c *Controller) DisenrollAll() (err error)

Disenroll all the relays

func (*Controller) Enroll

func (c *Controller) Enroll(contractId string) error

Enroll relay by contractId

func (*Controller) EnrollAll

func (c *Controller) EnrollAll() (err error)

Enroll all the relays

func (*Controller) Load

func (c *Controller) Load(scfg *relaycfg.C) (err error)

Load current relays configuration

func (*Controller) NetCap

func (c *Controller) NetCap() (m map[string]uint64)

Returns current relays Netcaps, by contractId

func (*Controller) NewConn

func (c *Controller) NewConn(contractId string) (ctx context.Context, err error)

Returns if a new connection should be accepted Relays accept new connections meanwhile they're enrolled

func (*Controller) Reload

func (c *Controller) Reload(scfg *relaycfg.C) (err error)

Reload current relays configuration

func (*Controller) SCS

func (c *Controller) SCS() (m map[string]string)

Returns current relays SC, by contractId

func (*Controller) Start

func (c *Controller) Start() error

Controller starter Enrolls relays and starts heartbeat goroutine

func (*Controller) StartWithList

func (c *Controller) StartWithList(contractIds ...string) error

Controller starter, with custom list Enrolls relays and starts heartbeat goroutine

func (*Controller) Started

func (c *Controller) Started() bool

Returns current Controller status

func (*Controller) Status

func (c *Controller) Status() (m map[string]RelayStatus)

Returns current relays status, by contractId

func (*Controller) Stop

func (c *Controller) Stop() error

Controller finisher

type RelayFlags

type RelayFlags struct {
	Enrolled      bool
	NetCapReached bool
}

type RelayStatus

type RelayStatus struct {
	Addr  *texturl.URL
	Role  string
	Flags RelayFlags
}

RelayStatus minified version of relayStatus