Documentation
¶
Index ¶
- Variables
- func Assert(err error, msg ...interface{})
- func AssertBytes(b []byte, err error) []byte
- func AssertIf(exp bool, msg string, args ...interface{})
- func AssertLength(n int, err error) int
- func AssertLong(n int64, err error) int64
- func CountOf(buffs [][]byte) (n int64)
- func MustToBytes(message interface{}) []byte
- func MustToReader(message interface{}) io.Reader
- func ToBytes(message interface{}) ([]byte, error)
- func ToReader(message interface{}) (io.Reader, error)
- type ByteReader
- type RingBuffer
- func (rb *RingBuffer) Cap() uint64
- func (rb *RingBuffer) Dispose()
- func (rb *RingBuffer) Get() (interface{}, error)
- func (rb *RingBuffer) IsDisposed() bool
- func (rb *RingBuffer) Len() uint64
- func (rb *RingBuffer) Offer(item interface{}) (bool, error)
- func (rb *RingBuffer) Poll(timeout time.Duration) (interface{}, error)
- func (rb *RingBuffer) Put(item interface{}) error
- type SpinLocker
Constants ¶
This section is empty.
Variables ¶
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`) // ErrEmpty is returned when an non-applicable queue operation was called // due to the queue's empty item state ErrEmpty = errors.New(`queue: empty queue`) )
Functions ¶
func MustToReader ¶
MustToReader any error to panic
Types ¶
type ByteReader ¶
type ByteReader interface {
io.Reader
io.ByteReader
}
ByteReader defines byte reader
func NewByteReader ¶
func NewByteReader(r io.Reader) ByteReader
NewByteReader create a ByteReader from io.Reader
type RingBuffer ¶ added in v1.1.0
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 ¶ added in v1.1.0
func NewRingBuffer(size uint64) *RingBuffer
NewRingBuffer will allocate, initialize, and return a ring buffer with the specified size.
func (*RingBuffer) Cap ¶ added in v1.1.0
func (rb *RingBuffer) Cap() uint64
Cap returns the capacity of this ring buffer.
func (*RingBuffer) Dispose ¶ added in v1.1.0
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 ¶ added in v1.1.0
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 ¶ added in v1.1.0
func (rb *RingBuffer) IsDisposed() bool
IsDisposed will return a bool indicating if this queue has been disposed.
func (*RingBuffer) Len ¶ added in v1.1.0
func (rb *RingBuffer) Len() uint64
Len returns the number of items in the queue.
func (*RingBuffer) Offer ¶ added in v1.1.0
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 ¶ added in v1.1.0
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 ¶ added in v1.1.0
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.
type SpinLocker ¶ added in v1.1.0
type SpinLocker int32
func (*SpinLocker) Lock ¶ added in v1.1.0
func (s *SpinLocker) Lock()
func (*SpinLocker) Unlock ¶ added in v1.1.0
func (s *SpinLocker) Unlock()
Source Files