util

package
v0.0.0-...-388aa53 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 9, 2020 License: Apache-2.0 Imports: 19 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrDisposed is returned when an operation is performed on a disposed
	// queue.
	ErrDisposed = errors.New(`queue: disposed`)

	// ErrTimeout is returned when an applicable queue operation times out.
	ErrTimeout = errors.New(`queue: poll timed out`)

	// ErrEmptyQueue is returned when an non-applicable queue operation was called
	// due to the queue's empty item state
	ErrEmptyQueue = errors.New(`queue: empty queue`)
)
View Source
var (
	GitCommit = ""
	BuildTime = ""
	GoVersion = ""
)

set on build time

Functions

func AcquireErrorRsp

func AcquireErrorRsp() *rpc.ErrResponse

AcquireErrorRsp returns a value from pool

func AcquireInsertReq

func AcquireInsertReq() *rpc.InsertRequest

AcquireInsertReq returns a value from pool

func AcquireInsertRsp

func AcquireInsertRsp() *rpc.InsertResponse

AcquireInsertRsp returns a value from pool

func AcquireRaftCMDRequest

func AcquireRaftCMDRequest() *raftpb.RaftCMDRequest

AcquireRaftCMDRequest returns a raft cmd request from pool

func AcquireRaftMessage

func AcquireRaftMessage() *raftpb.RaftMessage

AcquireRaftMessage returns a raft message from pool

func AcquireSearchReq

func AcquireSearchReq() *rpc.SearchRequest

AcquireSearchReq returns a value from pool

func AcquireSearchRsp

func AcquireSearchRsp() *rpc.SearchResponse

AcquireSearchRsp returns a value from pool

func AcquireUpdateReq

func AcquireUpdateReq() *rpc.UpdateRequest

AcquireUpdateReq returns a value from pool

func AcquireUpdateRsp

func AcquireUpdateRsp() *rpc.UpdateResponse

AcquireUpdateRsp returns a value from pool

func DefaultTimeoutWheel

func DefaultTimeoutWheel() *goetty.TimeoutWheel

DefaultTimeoutWheel returns default timeout wheel

func DiskStats

func DiskStats(path string) (*disk.UsageStat, error)

DiskStats returns the disk usage stats

func ExecuteInParallel

func ExecuteInParallel(q *Queue, fn func(interface{}))

ExecuteInParallel will (in parallel) call the provided function with each item in the queue until the queue is exhausted. When the queue is exhausted execution is complete and all goroutines will be killed. This means that the queue will be disposed so cannot be used again.

func GZIP

func GZIP(path string) error

GZIP compress a path to a gzip file

func GZIPTo

func GZIPTo(path string, dest string) error

GZIPTo gzip to a dest

func MemStats

func MemStats() (*mem.VirtualMemoryStat, error)

MemStats returns the mem usage stats

func PatchSaramaOffset

func PatchSaramaOffset(config *cluster.Config, committedOffset, committedIndex int64) error

PatchSaramaOffset add spec offset patch for sarama

func PrintVersion

func PrintVersion()

PrintVersion prints the current version

func ReleaseErrorRsp

func ReleaseErrorRsp(value *rpc.ErrResponse)

ReleaseErrorRsp returns a value to pool

func ReleaseInsertReq

func ReleaseInsertReq(value *rpc.InsertRequest)

ReleaseInsertReq returns a value to pool

func ReleaseInsertRsp

func ReleaseInsertRsp(value *rpc.InsertResponse)

ReleaseInsertRsp returns a value to pool

func ReleaseRaftCMDRequest

func ReleaseRaftCMDRequest(value *raftpb.RaftCMDRequest)

ReleaseRaftCMDRequest returns a raft cmd request to pool

func ReleaseRaftMessage

func ReleaseRaftMessage(value *raftpb.RaftMessage)

ReleaseRaftMessage returns a raft message to pool

func ReleaseSearchReq

func ReleaseSearchReq(value *rpc.SearchRequest)

ReleaseSearchReq returns a value to pool

func ReleaseSearchRsp

func ReleaseSearchRsp(value *rpc.SearchResponse)

ReleaseSearchRsp returns a value to pool

func ReleaseUpdateReq

func ReleaseUpdateReq(value *rpc.UpdateRequest)

ReleaseUpdateReq returns a value to pool

func ReleaseUpdateRsp

func ReleaseUpdateRsp(value *rpc.UpdateResponse)

ReleaseUpdateRsp returns a value to pool

func UnGZIP

func UnGZIP(file string, dest string) error

UnGZIP ungip file

Types

type Queue

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

Queue is the struct responsible for tracking the state of the queue.

func New

func New(hint int64) *Queue

New is a constructor for a new threadsafe queue.

func (*Queue) Dispose

func (q *Queue) Dispose() []interface{}

Dispose will dispose of this queue and returns the items disposed. Any subsequent calls to Get or Put will return an error.

func (*Queue) Disposed

func (q *Queue) Disposed() bool

Disposed returns a bool indicating if this queue has had disposed called on it.

func (*Queue) Empty

func (q *Queue) Empty() bool

Empty returns a bool indicating if this bool is empty.

func (*Queue) Get

func (q *Queue) Get(number int64, items []interface{}) (int64, error)

Get retrieves items from the queue. If there are some items in the queue, get will return a number UP TO the number passed in as a parameter. If no items are in the queue, this method will pause until items are added to the queue.

func (*Queue) Len

func (q *Queue) Len() int64

Len returns the number of items in this queue.

func (*Queue) Peek

func (q *Queue) Peek() (interface{}, error)

Peek returns a the first item in the queue by value without modifying the queue.

func (*Queue) Poll

func (q *Queue) Poll(number int64, items []interface{}, timeout time.Duration) (int64, error)

Poll retrieves items from the queue. If there are some items in the queue, Poll will return a number UP TO the number passed in as a parameter. If no items are in the queue, this method will pause until items are added to the queue or the provided timeout is reached. A non-positive timeout will block until items are added. If a timeout occurs, ErrTimeout is returned.

func (*Queue) Put

func (q *Queue) Put(items ...interface{}) error

Put will add the specified items to the queue.

func (*Queue) PutOrUpdate

func (q *Queue) PutOrUpdate(cmp func(interface{}, interface{}) bool, item interface{}) error

PutOrUpdate will add the specified item to the queue, update it if exists

type RingBuffer

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

RingBuffer is a MPMC buffer that achieves threadsafety with CAS operations only. A put on full or get on empty call will block until an item is put or retrieved. Calling Dispose on the RingBuffer will unblock any blocked threads with an error. This buffer is similar to the buffer described here: http://www.1024cores.net/home/lock-free-algorithms/queues/bounded-mpmc-queue with some minor additions.

func NewRingBuffer

func NewRingBuffer(size uint64) *RingBuffer

NewRingBuffer will allocate, initialize, and return a ring buffer with the specified size.

func (*RingBuffer) Cap

func (rb *RingBuffer) Cap() uint64

Cap returns the capacity of this ring buffer.

func (*RingBuffer) Dispose

func (rb *RingBuffer) Dispose()

Dispose will dispose of this queue and free any blocked threads in the Put and/or Get methods. Calling those methods on a disposed queue will return an error.

func (*RingBuffer) Get

func (rb *RingBuffer) Get() (interface{}, error)

Get will return the next item in the queue. This call will block if the queue is empty. This call will unblock when an item is added to the queue or Dispose is called on the queue. An error will be returned if the queue is disposed.

func (*RingBuffer) IsDisposed

func (rb *RingBuffer) IsDisposed() bool

IsDisposed will return a bool indicating if this queue has been disposed.

func (*RingBuffer) Len

func (rb *RingBuffer) Len() uint64

Len returns the number of items in the queue.

func (*RingBuffer) Offer

func (rb *RingBuffer) Offer(item interface{}) (bool, error)

Offer adds the provided item to the queue if there is space. If the queue is full, this call will return false. An error will be returned if the queue is disposed.

func (*RingBuffer) Poll

func (rb *RingBuffer) Poll(timeout time.Duration) (interface{}, error)

Poll will return the next item in the queue. This call will block if the queue is empty. This call will unblock when an item is added to the queue, Dispose is called on the queue, or the timeout is reached. An error will be returned if the queue is disposed or a timeout occurs. A non-positive timeout will block indefinitely.

func (*RingBuffer) Put

func (rb *RingBuffer) Put(item interface{}) error

Put adds the provided item to the queue. If the queue is full, this call will block until an item is added to the queue or Dispose is called on the queue. An error will be returned if the queue is disposed.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL