coreutil

Documentation

Overview

package coreutil provides utilities for core interfaces, that can be useful not only for engine, but other core importers too. coreutil MUST NOT depend on any core subpackage, because they may import coreutil.

Index

• Constants
• func NewCallbackOnFinishSchedule(s core.Schedule, onFinish func()) core.Schedule
• func ResetReusedAmmo(ammo core.Ammo)
• func ReturnSampleIfBorrowed(s core.Sample)
• type BufferSizeConfig
  • func (conf BufferSizeConfig) BufferSizeOrDefault() int
• type DataSinkFunc
  • func (f DataSinkFunc) OpenSink() (wc io.WriteCloser, err error)
• type DataSourceFunc
  • func (f DataSourceFunc) OpenSource() (rc io.ReadCloser, err error)
• type Waiter
  • func NewWaiter(sched core.Schedule, ctx context.Context) *Waiter
  • func (w *Waiter) IsFinished() (ok bool)
  • func (w *Waiter) Wait() (ok bool)

Constants

const DefaultBufferSize = 512 * 1024

const MinimalBufferSize = 4 * 1024

Functions

func NewCallbackOnFinishSchedule

func NewCallbackOnFinishSchedule(s core.Schedule, onFinish func()) core.Schedule

NewCallbackOnFinishSchedule returns schedule that calls back once onFinish just before first callee could know, that schedule is finished. That is, calls onFinish once, first time, whet Next() returns ok == false or Left() returns 0.

func ResetReusedAmmo

func ResetReusedAmmo(ammo core.Ammo)

ResetReusedAmmo sets to zero any ammo. Used by core.Provider implementations that accepts generic type, and need to clean reused ammo before fill with fresh data.

func ReturnSampleIfBorrowed

func ReturnSampleIfBorrowed(s core.Sample)

Types

type BufferSizeConfig

type BufferSizeConfig struct {
	BufferSize datasize.ByteSize `config:"buffer-size"`
}

BufferSizeConfig SHOULD be used to configure buffer size. That makes buffer size configuration consistent among all Aggregators.

func (BufferSizeConfig) BufferSizeOrDefault

func (conf BufferSizeConfig) BufferSizeOrDefault() int

type DataSinkFunc

type DataSinkFunc func() (wc io.WriteCloser, err error)

func (DataSinkFunc) OpenSink

func (f DataSinkFunc) OpenSink() (wc io.WriteCloser, err error)

type DataSourceFunc

type DataSourceFunc func() (wc io.ReadCloser, err error)

func (DataSourceFunc) OpenSource

func (f DataSourceFunc) OpenSource() (rc io.ReadCloser, err error)

type Waiter

type Waiter struct {
	// contains filtered or unexported fields
}

Waiter goroutine unsafe wrapper for efficient waiting schedule.

func NewWaiter

func NewWaiter(sched core.Schedule, ctx context.Context) *Waiter

func (*Waiter) IsFinished

func (w *Waiter) IsFinished() (ok bool)

IsFinished is quick check, that wait context is not canceled and there are some tokens left in schedule.

func (*Waiter) Wait

func (w *Waiter) Wait() (ok bool)

Wait waits for next waiter schedule event. Returns true, if event successfully waited, or false if waiter context is done, or schedule finished.