client

Documentation

Index

• Constants
• func DecorateError(err error, action string, maySucceed bool) error
• func IsTimeout(err error) bool
• type Client
  • func New() Client
• type Session
  • func (s *Session) Connect()
  • func (s *Session) Disconnect()

Constants

const (
	DefaultConnectionTimeout = 30 * time.Second
	DefaultExecutionTimeout  = 5 * time.Minute
)

DefaultTimeout tells to use the timeout by default depending on context

Functions

func DecorateError

func DecorateError(err error, action string, maySucceed bool) error

DecorateError changes the error to something more comprehensible when timeout occured

func IsTimeout

func IsTimeout(err error) bool

IsTimeout tells if the err is a timeout kind

Types

type Client

type Client *Session

Client is a instance of Session used temporarily until the session logic in brokerd is implemented

func New

func New() Client

New returns an instance of broker Client

type Session

type Session struct {
	Bucket   *bucket
	Host     *host
	Share    *share
	Network  *network
	Ssh      *ssh
	Tenant   *tenant
	Volume   *volume
	Template *template
	Image    *image
	// contains filtered or unexported fields
}

Session units the different resources proposed by brokerd as broker client

func (*Session) Connect

func (s *Session) Connect()

Connect establishes connection with brokerd

func (*Session) Disconnect

func (s *Session) Disconnect()

Disconnect cuts the connection with brokerd