api

Documentation

Index

• Variables
• type Queue
  • func GetQueue(config plugin.Config) Queue
• type SequenceEvent

Variables

var (
	ErrEmpty  = errors.New("cannot read data when the queue is empty")
	ErrFull   = errors.New("cannot write data when the queue is full")
	ErrClosed = errors.New("cannot enqueue or dequeue when the queue is closed")
)

Types

type Queue

type Queue interface {
	plugin.Plugin

	// Initialize creates the queue.
	Initialize() error

	// Enqueue a inputEvent into the queue.
	Enqueue(event *v1.SniffData) error

	// Dequeue returns a SequenceEvent when Queue is not empty,
	Dequeue() (*SequenceEvent, error)

	// Close would close the queue.
	Close() error

	// Ack the lastOffset
	Ack(lastOffset *event.Offset)

	// TotalSize total capacity of queue
	TotalSize() int64

	// UsedCount used count of queue
	UsedCount() int64

	// IsFull the queue is full
	IsFull() bool
}

Queue is a plugin interface, that defines new queues.

func GetQueue

func GetQueue(config plugin.Config) Queue

GetQueue an initialized filter plugin.

type SequenceEvent

type SequenceEvent struct {
	Event  *v1.SniffData
	Offset event.Offset
}

SequenceEvent is a wrapper to pass the event and the offset.