entry_cache

Documentation

Index

• func NewEntryCacheComponent() internal.Component
• type EntryCache
  • func (c *EntryCache) Configure(_ bool) error
  • func (c *EntryCache) Name() string
  • func (c *EntryCache) SetName(name string)
  • func (c *EntryCache) SetNextComponent(nc internal.Component)
  • func (c *EntryCache) Start(ctx context.Context) error
  • func (c *EntryCache) Stop() error
  • func (c *EntryCache) StreamDir(options internal.StreamDirOptions) ([]*internal.ObjAttr, string, error)
• type EntryCacheOptions

Functions

func NewEntryCacheComponent

func NewEntryCacheComponent() internal.Component

Pipeline will call this method to create your object, initialize your variables here << DO NOT DELETE ANY AUTO GENERATED CODE HERE >>

Types

type EntryCache

type EntryCache struct {
	internal.BaseComponent
	// contains filtered or unexported fields
}

Common structure for Component

func (*EntryCache) Configure

func (c *EntryCache) Configure(_ bool) error

Configure : Pipeline will call this method after constructor so that you can read config and initialize yourself

Return failure if any config is not valid to exit the process

func (*EntryCache) Name

func (c *EntryCache) Name() string

func (*EntryCache) SetName

func (c *EntryCache) SetName(name string)

func (*EntryCache) SetNextComponent

func (c *EntryCache) SetNextComponent(nc internal.Component)

func (*EntryCache) Start

func (c *EntryCache) Start(ctx context.Context) error

Start : Pipeline calls this method to start the component functionality

this shall not block the call otherwise pipeline will not start

func (*EntryCache) Stop

func (c *EntryCache) Stop() error

Stop : Stop the component functionality and kill all threads started

func (*EntryCache) StreamDir

func (c *EntryCache) StreamDir(options internal.StreamDirOptions) ([]*internal.ObjAttr, string, error)

StreamDir : Optionally cache entries of the list

type EntryCacheOptions

type EntryCacheOptions struct {
	Timeout uint32 `config:"timeout-sec" yaml:"timeout-sec,omitempty"`
}

Structure defining your config parameters