throughput

Documentation

Index

• func FormatSize(size int) string
• func Listen[T any](parent context.Context, sl StreamListener[T], sc StreamConfig) error
• type StreamConfig
  • func DefaultStreamConfig(name string) StreamConfig
• type StreamListener

Functions

func FormatSize

func FormatSize(size int) string

FormatSize turns a byte count into a human readable string.

func Listen

func Listen[T any](parent context.Context, sl StreamListener[T], sc StreamConfig) error

Types

type StreamConfig

type StreamConfig struct {
	Name          string
	TickInterval  time.Duration
	ChannelBuffer int
}

func DefaultStreamConfig

func DefaultStreamConfig(name string) StreamConfig

type StreamListener

type StreamListener[T any] interface {
	// Connect indicates how the stream listener should connect and setup its primary stream
	Connect(context.Context) error

	// Produce indicates how to receive a series of messages on the connection
	Produce() ([]T, error)

	// Filter applies to produced items to determine whether they should be counted
	Filter(T) bool

	// Size applies to produced items to indicate its byte size
	Size(T) int

	// OnUpdate is a flexible trigger that can fire on each produced item
	OnUpdate(T)
}