q

Documentation

Index

• Variables
• type Option
  • func WithSize(num int) Option
• type Q
  • func NewQ(options ...Option) *Q
  • func (a *Q) AddPriorReq(req interface{}) error
  • func (a *Q) AddReq(req interface{}) error
  • func (a *Q) AddReqAnyway(req interface{}, ts time.Duration) error
  • func (a *Q) Close()
  • func (a *Q) Pop() (interface{}, error)
  • func (a *Q) PopAnyway() (interface{}, error)

Variables

var (
	//ErrClosed close
	ErrClosed = errors.New("pipe.q.closed")

	//ErrReqQFull req q full
	ErrReqQFull = errors.New("pipe.q.req.full")

	//ErrSync never gonna happen
	ErrSync = errors.New("never.gonna.happen.crazy")
)

Types

type Option

type Option func(o *_Option)

Option : option function

func WithSize

func WithSize(num int) Option

WithSize setup max queue number of request queue if max is 0, which means no limit

type Q

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

Q actor queue structure define

func NewQ

func NewQ(options ...Option) *Q

NewQ new queue

func (*Q) AddPriorReq

func (a *Q) AddPriorReq(req interface{}) error

AddPriorReq add normal request to the normal queue first place.

func (*Q) AddReq

func (a *Q) AddReq(req interface{}) error

AddReq add normal request to the normal queue end place.

func (*Q) AddReqAnyway

func (a *Q) AddReqAnyway(req interface{}, ts time.Duration) error

AddReqAnyway add normal request to the normal queue end place anyway if queue full, sleep then try

func (*Q) Close

func (a *Q) Close()

Close : close the queue

func (*Q) Pop

func (a *Q) Pop() (interface{}, error)

Pop consume an item, if list is empty, it's been blocked

func (*Q) PopAnyway

func (a *Q) PopAnyway() (interface{}, error)

PopAnyway consume an item like Pop, but it can consume even the queue is closed.