queue

Documentation

Index

• type LRUQueue
  • func NewLRUQueue(capacity int) *LRUQueue
  • func (q *LRUQueue) Delete(key string) interface{}
  • func (q *LRUQueue) Get(key string) (interface{}, error)
  • func (q *LRUQueue) GetFront(count int) []interface{}
  • func (q *LRUQueue) GetItemByKey(key string) (interface{}, error)
  • func (q *LRUQueue) Put(key string, data interface{}) (obsoleteKey string, obsoleteData interface{})
• type Queue
  • func NewQueue(capacity int) Queue

Types

type LRUQueue

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

LRUQueue is implementation of LRU.

func NewLRUQueue

func NewLRUQueue(capacity int) *LRUQueue

func (*LRUQueue) Delete

func (q *LRUQueue) Delete(key string) interface{}

Delete deletes the item by key, return the deleted item if item exists.

func (*LRUQueue) Get

func (q *LRUQueue) Get(key string) (interface{}, error)

Get will return the item by key. And it will put the item to front.

func (*LRUQueue) GetFront

func (q *LRUQueue) GetFront(count int) []interface{}

GetFront will get several items from front and not poll out them.

func (*LRUQueue) GetItemByKey

func (q *LRUQueue) GetItemByKey(key string) (interface{}, error)

GetItemByKey will return the item by key. But it will not put the item to front.

func (*LRUQueue) Put

func (q *LRUQueue) Put(key string, data interface{}) (obsoleteKey string, obsoleteData interface{})

Put puts item to front, return the obsolete item

type Queue

type Queue interface {
	// Put puts item into the queue and keeps blocking if the queue is full.
	// It will return immediately and do nothing if the item is nil.
	Put(item interface{})

	// PutTimeout puts item into the queue and waits for timeout if the queue is full.
	// If timeout <= 0, it will return false immediately when queue is full.
	// It will return immediately and do nothing if the item is nil.
	PutTimeout(item interface{}, timeout time.Duration) bool

	// Poll gets an item from the queue and keeps blocking if the queue is empty.
	Poll() interface{}

	// PollTimeout gets an item from the queue and waits for timeout if the queue is empty.
	// If timeout <= 0, it will return (nil, bool) immediately when queue is empty.
	PollTimeout(timeout time.Duration) (interface{}, bool)

	// Len returns the current size of the queue.
	Len() int
}

Queue blocking queue. The items putted into queue mustn't be nil.

func NewQueue

func NewQueue(capacity int) Queue

NewQueue creates a blocking queue. If capacity <= 0, the queue capacity is infinite.