event

Documentation

Index

• Variables
• type Reader
• type WindowIterator
• type Writer

Variables

var ErrEOF = errors.New("EOF")

Types

type Reader

type Reader interface {
	// Read returns the next event. Returns EOF when finished.
	Read(context.Context) (model.MXPGVKEvent, error)
	// Close closes the reader.
	Close() error
}

Reader is the interface for reading usage events. Read() must return EOF when there is nothing more to read. Callers must call Close() when finished reading.

type WindowIterator

type WindowIterator interface {
	// More returns true if there are more windows.
	More() bool
	// Next returns a reader and time range for the next window.
	Next() (Reader, time.Range, error)
}

WindowIterator is the interface for iterating through usage event readers for windows of time within a time range.

type Writer

type Writer interface {
	// Write writes an event.
	Write(model.MXPGVKEvent) error
}

Writer is the interface for reading usage events.