pool

Documentation

Index

• type Config
• type Item
  • func (i *Item) Wait(ctx context.Context) error
• type Pool
  • func NewPool(cfg []Config) *Pool
  • func (p *Pool) GetItem() Item
  • func (p *Pool) GetItems() []Item

Types

type Config

type Config struct {
	// id is the RPC service ID.
	Id string
	// description of the item.
	Description string
	// priority is the priority of the item.
	Priority uint8
	// amount of request per minute
	RequestsPerMinute uint16
}

Config is the configuration of an pool item.

type Item

type Item struct {
	// Id is the item ID.
	Id string
	// description of the item.
	Description string
	// contains filtered or unexported fields
}

Item defines the item of the pool.

func (*Item) Wait

func (i *Item) Wait(ctx context.Context) error

Wait waits for the rate limiter to allow the next item request.

type Pool

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

Pool is a pool of items.

func NewPool

func NewPool(cfg []Config) *Pool

NewPool creates a new pool.

func (*Pool) GetItem

func (p *Pool) GetItem() Item

GetItem returns the next available item of the pool.

func (*Pool) GetItems

func (p *Pool) GetItems() []Item

GetItems returns the list of items sorted by score and priority. Once there is an event on the item, it must be notified using the method NotifyEvent.