filexl

Documentation

Overview

Package filexl provides a xlistd.List implementation that uses a file as source for its checks.

This package is a work in progress and makes no API stability promises.

Index

• Constants
• func Builder(defaultCfg Config) xlistd.BuildListFn
• type Config
  • func DefaultConfig() Config
• type List
  • func New(id, filename string, resources []xlist.Resource, cfg Config, ...) *List
  • func (l *List) Check(ctx context.Context, name string, resource xlist.Resource) (xlist.Response, error)
  • func (l *List) Class() string
  • func (l *List) Close()
  • func (l *List) ID() string
  • func (l *List) Open() error
  • func (l *List) Ping() error
  • func (l *List) Reload() error
  • func (l *List) Resources(ctx context.Context) ([]xlist.Resource, error)

Constants

const ComponentClass = "file"

ComponentClass defines default class for component builder

Functions

func Builder

func Builder(defaultCfg Config) xlistd.BuildListFn

Builder returns a builder function.

Types

type Config

type Config struct {
	ForceValidation bool
	Reason          string
	UnsafeReload    bool
	Autoreload      bool
	ReloadTime      time.Duration
}

Config options

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns default configuration

type List

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

List loads list from a file using internally a memxl.List

func New

func New(id, filename string, resources []xlist.Resource, cfg Config, logger yalogi.Logger) *List

New creates a new List with the filename passed

func (*List) Check

func (l *List) Check(ctx context.Context, name string, resource xlist.Resource) (xlist.Response, error)

Check implements xlist.Checker interface

func (*List) Class

func (l *List) Class() string

Class implements xlistd.List interface

func (*List) Close

func (l *List) Close()

Close release memory

func (*List) ID

func (l *List) ID() string

ID implements xlistd.List interface

func (*List) Open

func (l *List) Open() error

Open loads file to memory

func (*List) Ping

func (l *List) Ping() error

Ping implements xlistd.Ping interface

func (*List) Reload

func (l *List) Reload() error

Reload forces a reload from the file

func (*List) Resources

func (l *List) Resources(ctx context.Context) ([]xlist.Resource, error)

Resources implements xlist.Checker interface