storage

Documentation

Index

• Variables
• func NewContext(ctx context.Context, d Driver) context.Context
• type AccumState
• type Driver
  • func FromContext(ctx context.Context) Driver
• type EnqueueMeta
• type EnqueueOptions
• type Envelope
  • func NewEnvelope() *Envelope
  • func (e *Envelope) AddMessage(m *Message)
  • func (e *Envelope) IsComposite() bool
• type Message
• type MultiDequeuer
• type MultiEnqueuer

Variables

var (
	DefaultRetry   = types.Retry(10)
	DefaultTimeout = types.Duration(30 * time.Second)
)

var (
	ErrEmpty              = errors.New("Error empty queue")
	ErrInvalidEphemeralID = errors.New("Error invalid ephemeral id")
)

Functions

func NewContext

func NewContext(ctx context.Context, d Driver) context.Context

Types

type AccumState

type AccumState int

const (
	AccumDisabled AccumState = iota
	AccumStarted
	AccumAdded
)

type Driver

type Driver interface {
	Enqueue(string, uid.ID, *Envelope, *EnqueueOptions) (*EnqueueMeta, error)
	Dequeue(string, uid.ID) (*Envelope, error)
	Ack(uid.ID) error
	Reset(uid.ID) error
	Close() error
}

func FromContext

func FromContext(ctx context.Context) Driver

type EnqueueMeta

type EnqueueMeta struct {
	AccumState AccumState
}

type EnqueueOptions

type EnqueueOptions struct {
	AccumTime types.Duration
}

type Envelope

type Envelope struct {
	ID       uid.ID
	Queue    string
	Retry    types.Retry
	Timeout  types.Duration
	Messages []*Message
}

func NewEnvelope

func NewEnvelope() *Envelope

func (*Envelope) AddMessage

func (e *Envelope) AddMessage(m *Message)

func (*Envelope) IsComposite

func (e *Envelope) IsComposite() bool

type Message

type Message struct {
	ContentType string
	Meta        map[string]interface{}
	Body        []byte
}

type MultiDequeuer

type MultiDequeuer interface {
	DequeueAny([]string, uid.ID) (*Envelope, error)
}

type MultiEnqueuer

type MultiEnqueuer interface {
	EnqueueAll([]*Envelope, []*EnqueueOptions) (map[string]*EnqueueMeta, error)
}