resource

Documentation

Index

• func NewPMClient(ctx context.Context) (api.API, error)
• type PM
  • func PMDynamic(name string, config func(context.Context) (*api.Child, error)) *PM
  • func PMStatic(config api.Child) *PM
  • func PMStaticInfra(config api.Child) *PM
  • func (p *PM) ID() string
  • func (p *PM) Ready(ctx context.Context) (bool, error)
  • func (p *PM) Start(ctx context.Context) error
  • func (p *PM) Stop(ctx context.Context) error
  • func (p *PM) WithWaitOnStart() *PM

Functions

func NewPMClient

func NewPMClient(ctx context.Context) (api.API, error)

Create a new PM client, auto-starting the PM daemon if necessary.

Do not use this function directly, with the PM addon registered, this will be registered as a resource context value provider, fetch the existing client from the resource context.

Types

type PM

type PM struct {
	Name          string
	Config        func(context.Context) (*api.Child, error)
	LimitRestarts bool
	WaitOnStart   bool
}

func PMDynamic

func PMDynamic(name string, config func(context.Context) (*api.Child, error)) *PM

func PMStatic

func PMStatic(config api.Child) *PM

func PMStaticInfra

func PMStaticInfra(config api.Child) *PM

func (*PM) ID

func (p *PM) ID() string

ID implements Resource.

func (*PM) Ready

func (p *PM) Ready(ctx context.Context) (bool, error)

Ready implements Resource

func (*PM) Start

func (p *PM) Start(ctx context.Context) error

Start implements Resource.

func (*PM) Stop

func (p *PM) Stop(ctx context.Context) error

Stop implements Resource.

func (*PM) WithWaitOnStart

func (p *PM) WithWaitOnStart() *PM