channel

Documentation

Index

• type OutletFactory
  • func NewOutletFactory(done <-chan struct{}, pipeline publisher.Publisher, wgEvents eventCounter) *OutletFactory
  • func (f *OutletFactory) Create(cfg *common.Config) (Outleter, error)
• type Outleter
  • func CloseOnSignal(outlet Outleter, sig <-chan struct{}) Outleter
  • func SubOutlet(out Outleter) Outleter
• type OutleterFactory

Types

type OutletFactory

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

func NewOutletFactory

func NewOutletFactory(
	done <-chan struct{},
	pipeline publisher.Publisher,
	wgEvents eventCounter,
) *OutletFactory

NewOutletFactory creates a new outlet factory for connecting a prospector to the publisher pipeline.

func (*OutletFactory) Create

func (f *OutletFactory) Create(cfg *common.Config) (Outleter, error)

Create builds a new Outleter, while applying common prospector settings. Prospectors and all harvesters use the same pipeline client instance. This guarantees ordering between events as required by the registrar for file.State updates

type Outleter

type Outleter interface {
	Close() error
	OnEvent(data *util.Data) bool
}

Outleter is the outlet for a prospector

func CloseOnSignal

func CloseOnSignal(outlet Outleter, sig <-chan struct{}) Outleter

CloseOnSignal closes the outlet, once the signal triggers.

func SubOutlet

func SubOutlet(out Outleter) Outleter

SubOutlet create a sub-outlet, which can be closed individually, without closing the underlying outlet.

type OutleterFactory

type OutleterFactory func(*common.Config) (Outleter, error)

OutletFactory is used to create a new Outlet instance