helpers

Documentation

Overview

Package helpers contains helper functions to be reused by multiple routers

Index

• type Helper
  • func New(db metadata.DB, provider p2plab.NodeProvider, client *httputil.Client) *Helper
  • func (h *Helper) CreateCluster(ctx context.Context, cdef metadata.ClusterDefinition, name string) (metadata.Cluster, error)
  • func (h *Helper) DeleteCluster(ctx context.Context, name string) error

Types

type Helper

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

Helper abstracts commonly used functions to be shared by any router

func New

func New(db metadata.DB, provider p2plab.NodeProvider, client *httputil.Client) *Helper

New instantiates our helper type

func (*Helper) CreateCluster

func (h *Helper) CreateCluster(ctx context.Context, cdef metadata.ClusterDefinition, name string) (metadata.Cluster, error)

CreateCluster enables creating the nodes in a cluster, waiting for them to be healthy before returning

func (*Helper) DeleteCluster

func (h *Helper) DeleteCluster(ctx context.Context, name string) error