pool

Documentation

Index

• Constants
• Variables
• type Config
• type Initializer
• type ObjectFactory
• type ObjectPool
  • func NewSimpleObjectPool(cfg Config) (ObjectPool, error)
• type ResUsage
  • func (r *ResUsage) GetID() string
  • func (r *ResUsage) GetStatus() types.ResStatus
  • func (r *ResUsage) GetType() string
• type ResourceHolder
• type Usage
  • func (u *Usage) GetLocal() map[string]types.Res
  • func (u *Usage) GetRemote() map[string]types.Res

Constants

const (
	// CheckIdleInterval the interval of check and process idle eni
	CheckIdleInterval = 2 * time.Minute
)

Variables

var (
	ErrNoAvailableResource = errors.New("no available resource")
	ErrInvalidState        = errors.New("invalid state")
	ErrNotFound            = errors.New("not found")
	ErrContextDone         = errors.New("context done")
	ErrInvalidArguments    = errors.New("invalid arguments")
)

Errors of pool

Types

type Config

type Config struct {
	Name        string
	Type        string
	Factory     ObjectFactory
	Initializer Initializer
	MinIdle     int
	MaxIdle     int
	Capacity    int
}

Config configuration of pool

type Initializer

type Initializer func(holder ResourceHolder) error

Initializer of pool

type ObjectFactory

type ObjectFactory interface {
	// Create res with count
	Create(count int) ([]types.NetworkResource, error)
	Dispose(types.NetworkResource) error
	ListResource() (map[string]types.NetworkResource, error)
	Check(types.NetworkResource) error
	// Reconcile run periodicity
	Reconcile()
}

ObjectFactory interface of network resource object factory

type ObjectPool

type ObjectPool interface {
	Acquire(ctx context.Context, resID, idempotentKey string) (types.NetworkResource, error)
	ReleaseWithReservation(resID string, reservation time.Duration) error
	Release(resID string) error
	AcquireAny(ctx context.Context, idempotentKey string) (types.NetworkResource, error)
	Stat(resID string) (types.NetworkResource, error)
	GetName() string
	tracing.ResourceMappingHandler
}

ObjectPool object pool interface

func NewSimpleObjectPool

func NewSimpleObjectPool(cfg Config) (ObjectPool, error)

NewSimpleObjectPool return an object pool implement

type ResUsage

type ResUsage struct {
	ID     string
	Type   string
	Status types.ResStatus
}

ResUsage ResUsage

func (*ResUsage) GetID

func (r *ResUsage) GetID() string

func (*ResUsage) GetStatus

func (r *ResUsage) GetStatus() types.ResStatus

func (*ResUsage) GetType

func (r *ResUsage) GetType() string

type ResourceHolder

type ResourceHolder interface {
	AddIdle(resource types.NetworkResource)
	AddInvalid(resource types.NetworkResource)
	AddInuse(resource types.NetworkResource, idempotentKey string)
}

ResourceHolder interface to initialize pool

type Usage

type Usage struct {
	Local  map[string]types.Res
	Remote map[string]types.Res
}

Usage store res booth local and remote

func (*Usage) GetLocal

func (u *Usage) GetLocal() map[string]types.Res

func (*Usage) GetRemote

func (u *Usage) GetRemote() map[string]types.Res