sync

Documentation

Index

• Constants
• type Cron
• type DefaultEventType
• type Event
• type FilePathSync
  • func (fs *FilePathSync) Fetch(_ context.Context) (string, error)
  • func (fs *FilePathSync) Notify(ctx context.Context, w chan<- INotify)
  • func (fs *FilePathSync) Source() string
• type HTTPClient
• type HTTPSync
  • func (fs *HTTPSync) Fetch(ctx context.Context) (string, error)
  • func (fs *HTTPSync) Notify(ctx context.Context, w chan<- INotify)
  • func (fs *HTTPSync) Source() string
• type INotify
• type ISync
• type Notifier
  • func (w *Notifier) GetEvent() Event[DefaultEventType]
• type ProviderArgs

Constants

const (
	DefaultEventTypeCreate = iota
	DefaultEventTypeModify = 1
	DefaultEventTypeDelete = 2
	DefaultEventTypeReady  = 3
)

Types

type Cron

type Cron interface {
	AddFunc(spec string, cmd func()) error
	Start()
}

Cron defines the behaviour required of a cron

type DefaultEventType

type DefaultEventType int32

type Event

type Event[T any] struct {
	EventType T
}

Event is a struct that represents a single event. It is a generic struct that can be cast to a more specific struct.

type FilePathSync

type FilePathSync struct {
	URI          string
	Logger       *log.Entry
	ProviderArgs ProviderArgs
}

func (*FilePathSync) Fetch

func (fs *FilePathSync) Fetch(_ context.Context) (string, error)

func (*FilePathSync) Notify

func (fs *FilePathSync) Notify(ctx context.Context, w chan<- INotify)

func (*FilePathSync) Source

func (fs *FilePathSync) Source() string

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient defines the behaviour required of a http client

type HTTPSync

type HTTPSync struct {
	URI          string
	Client       HTTPClient
	Cron         Cron
	BearerToken  string
	LastBodySHA  string
	Logger       *log.Entry
	ProviderArgs ProviderArgs
}

func (*HTTPSync) Fetch

func (fs *HTTPSync) Fetch(ctx context.Context) (string, error)

func (*HTTPSync) Notify

func (fs *HTTPSync) Notify(ctx context.Context, w chan<- INotify)

func (*HTTPSync) Source

func (fs *HTTPSync) Source() string

type INotify

type INotify interface {
	GetEvent() Event[DefaultEventType]
}

type ISync

type ISync interface {
	Fetch(ctx context.Context) (string, error)
	Notify(ctx context.Context, c chan<- INotify)
	Source() string
}

type Notifier

type Notifier struct {
	Event Event[DefaultEventType]
}

func (*Notifier) GetEvent

func (w *Notifier) GetEvent() Event[DefaultEventType]

type ProviderArgs

type ProviderArgs map[string]string