queue

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

type Factory interface {
	// Create a new queue if name does not exist
	// If name already exists, return the existing queue
	GetOrCreate(name string, options ...func(*QueueOptions)) (Queue, error)
}

type Handler func([]byte) error

type Kind uint8

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

type MemoryQueue struct {
	*BaseQueue
	// contains filtered or unexported fields
}

type Queue interface {
	Kind() Kind

	Name() string

	// Reports max size of queue
	// -1 for unlimited
	MaxSize() int

	// Push data to end of queue
	// Failed if queue is full or closed
	Enqueue([]byte) error

	// Pop data from beginning of queue without message confirmation
	// Failed if queue is empty
	Dequeue() ([]byte, error)

	// Subscribe queue with message confirmation.
	// Once handler returns error, it'll automatically put message back to queue using `Recover` mechanism internally.
	Subscribe(h Handler)

	Close()
}

type QueueOptions struct {
	MaxSize      int
	PollInterval time.Duration
	MaxRetries   int

	// Specify how many consumers are consuming the queue using `Subscribe`.
	// Be aware that too many consumers can cause order of messages to be changed.
	// If you want to ensure the order of messages, please use FIFO queue and set ConsumerCount to 1
	ConsumerCount int
}

type Recoverable interface {

	// or just does not implement it
	Recover([]byte) error
}

type RecoverableQueue interface {
	Queue

	Recoverable
}

type RedisQueue struct {
	*BaseQueue
	// contains filtered or unexported fields
}

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

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