Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ExclusivePool ¶
type ExclusivePool struct {
// contains filtered or unexported fields
}
ExclusivePool is a pool of non-identical instances that only one instance with same identity is in the pool at a time. In other words, only instances with different identities can be in the pool the same time. If another instance with same identity tries to get into the pool, it hangs until previous instance left the pool.
This pool is particularly useful for performing tasks on same resource on the file system in different goroutines.
func NewExclusivePool ¶
func NewExclusivePool() *ExclusivePool
NewExclusivePool initializes and returns a new ExclusivePool object.
func (*ExclusivePool) CheckIn ¶
func (p *ExclusivePool) CheckIn(identity string)
CheckIn checks in an instance to the pool and hangs while instance with same identity is using the lock.
func (*ExclusivePool) CheckOut ¶
func (p *ExclusivePool) CheckOut(identity string)
CheckOut checks out an instance from the pool and releases the lock to let other instances with same identity to grab the lock.
type StatusTable ¶
type StatusTable struct {
// contains filtered or unexported fields
}
StatusTable is a table maintains true/false values.
This table is particularly useful for un/marking and checking values in different goroutines.
func NewStatusTable ¶
func NewStatusTable() *StatusTable
NewStatusTable initializes and returns a new StatusTable object.
func (*StatusTable) IsRunning ¶
func (p *StatusTable) IsRunning(name string) bool
IsRunning checks if value of given name is set to true in the pool.
func (*StatusTable) Start ¶
func (p *StatusTable) Start(name string)
Start sets value of given name to true in the pool.
func (*StatusTable) StartIfNotRunning ¶ added in v1.2.0
func (p *StatusTable) StartIfNotRunning(name string) bool
StartIfNotRunning sets value of given name to true if not already in pool. Returns whether set value was set to true
func (*StatusTable) Stop ¶
func (p *StatusTable) Stop(name string)
Stop sets value of given name to false in the pool.
type UniqueQueue ¶
type UniqueQueue struct {
// contains filtered or unexported fields
}
UniqueQueue is a queue which guarantees only one instance of same identity is in the line. Instances with same identity will be discarded if there is already one in the line.
This queue is particularly useful for preventing duplicated task of same purpose.
func NewUniqueQueue ¶
func NewUniqueQueue(queueLength int) *UniqueQueue
NewUniqueQueue initializes and returns a new UniqueQueue object.
func (*UniqueQueue) Add ¶
func (q *UniqueQueue) Add(id interface{})
Add adds new instance to the queue.
func (*UniqueQueue) AddFunc ¶
func (q *UniqueQueue) AddFunc(id interface{}, fn func())
AddFunc adds new instance to the queue with a custom runnable function, the queue is blocked until the function exits.
func (*UniqueQueue) Exist ¶
func (q *UniqueQueue) Exist(id interface{}) bool
Exist returns true if there is an instance with given identity exists in the queue.
func (*UniqueQueue) Queue ¶
func (q *UniqueQueue) Queue() <-chan string
Queue returns channel of queue for retrieving instances.
func (*UniqueQueue) Remove ¶
func (q *UniqueQueue) Remove(id interface{})
Remove removes instance from the queue.
Source Files