stacks

Documentation

Index

• Variables
• type Stack
  • func Create(name string, hosts ...string) (*Stack, error)
  • func Retrieve(name string) (*Stack, error)
  • func (stack *Stack) AddHost(host string) error
  • func (stack *Stack) CalculateBestHost() (string, error)
  • func (stack *Stack) Delete() error
  • func (stack *Stack) RemoveHost(host string) error
  • func (stack *Stack) Update() error

Variables

var (
	// ErrStackAlreadyExists occurs when a given stack name is already being used
	ErrStackAlreadyExists = errors.New("the given stack name is already being used")

	// ErrHostAlreadyExists occurs when a given host which should get added already exists in the current stack
	ErrHostAlreadyExists = errors.New("the given host already exists")

	// ErrHostDoesNotExist occurs when a given host does not exist in the current stack
	ErrHostDoesNotExist = errors.New("the given host does not exist")

	// ErrAllHostsOffline occurs when all hosts of the current stack are offline
	ErrAllHostsOffline = errors.New("all hosts of the current stack are offline")
)

Types

type Stack

type Stack struct {
	ID    primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
	Name  string             `bson:"name" json:"name"`
	Hosts []string           `bson:"hosts" json:"hosts"`
}

Stack represents a stack of API instances

func Create

func Create(name string, hosts ...string) (*Stack, error)

Create creates a new stack

func Retrieve

func Retrieve(name string) (*Stack, error)

Retrieve retrieves the stack with the given name

func (*Stack) AddHost

func (stack *Stack) AddHost(host string) error

AddHost adds the given host to the current stack

func (*Stack) CalculateBestHost

func (stack *Stack) CalculateBestHost() (string, error)

CalculateBestHost returns the host which has the best latency

func (*Stack) Delete

func (stack *Stack) Delete() error

Delete deletes the current stack

func (*Stack) RemoveHost

func (stack *Stack) RemoveHost(host string) error

RemoveHost removes the given host from the current stack

func (*Stack) Update

func (stack *Stack) Update() error

Update writes the current local variables of the current stack into the database