period

package

v0.10.0 Latest Latest Go to latest Published: Mar 29, 2025 License: MIT Imports: 20 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type AggregateFunc[T any, AggregateT json.Marshaler] func(entries []*T, query url.Values) (total int, result AggregateT)

type Entries[T any] struct {
	// contains filtered or unexported fields
}

func (e *Entries[T]) Add(now time.Time, info *T)

func (e *Entries[T]) Get() []*T

func (e *Entries[T]) MarshalJSON() ([]byte, error)

func (e *Entries[T]) UnmarshalJSON(data []byte) error

type Filter string

type FilterFunc[T any] func(entries []*T, keyword string) (filtered []*T)

type Period[T any] struct {
	Entries map[Filter]*Entries[T] `json:"entries"`
	// contains filtered or unexported fields
}

func NewPeriod[T any]() *Period[T]

func (p *Period[T]) Add(info *T)

func (p *Period[T]) Get(filter Filter) ([]*T, bool)

func (p *Period[T]) Total() int

type PollFunc[T any] func(ctx context.Context, lastResult *T) (*T, error)

type Poller[T any, AggregateT json.Marshaler] struct {
	// contains filtered or unexported fields
}

func NewPoller[T any, AggregateT json.Marshaler](
	name string,
	poll PollFunc[T],
	aggregator AggregateFunc[T, AggregateT],
) *Poller[T, AggregateT]

func (p *Poller[T, AggregateT]) Get(filter Filter) ([]*T, bool)

func (p *Poller[T, AggregateT]) GetLastResult() *T

func (p *Poller[T, AggregateT]) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP serves the data for the given period.

If the period is not specified, it serves the last result.

If the period is specified, it serves the data for the given period.

If the period is invalid, it returns a 400 error.

If the data is not found, it returns a 204 error.

If the request is a websocket request, it serves the data for the given period for every interval.

func (p *Poller[T, AggregateT]) Start()

func (p *Poller[T, AggregateT]) WithResultFilter(filter FilterFunc[T]) *Poller[T, AggregateT]