core

README

Core functionality

This contains various parts of the core application, including:

• Module definition
• ResponseWriter definition
• Input definition
• Default Response object
• Default input object
• Scheduling and control functionality
• Various utility functions commonly used by modules

As the codebase grows, this will probably be split out into various sub libs.

Documentation

Index

• func ConvertByte(in interface{}) ([]byte, error)
• func ConvertInt(in interface{}) (int64, error)
• type ConfigInput
  • func NewConfigInput(in map[string]interface{}) *ConfigInput
  • func (c *ConfigInput) Data(val string) (interface{}, error)
  • func (c *ConfigInput) Type(val string) (string, error)
  • func (c *ConfigInput) Validate(schema InputSchema) error
• type Input
• type InputSchema
  • func NewInputSchema(in []byte) (InputSchema, error)
• type Module
• type Response
  • func NewResponse() *Response
  • func (r *Response) Changed(ok bool)
  • func (r *Response) Message(level string, messages ...interface{})
  • func (r *Response) Success(ok bool)
• type ResponseWriter
• type RunControl
  • func NewRunControl() *RunControl
  • func (r RunControl) Register() func()
  • func (r RunControl) Start()
  • func (r RunControl) Wait()

Functions

func ConvertByte

func ConvertByte(in interface{}) ([]byte, error)

func ConvertInt

func ConvertInt(in interface{}) (int64, error)

Types

type ConfigInput

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

func NewConfigInput

func NewConfigInput(in map[string]interface{}) *ConfigInput

func (*ConfigInput) Data

func (c *ConfigInput) Data(val string) (interface{}, error)

func (*ConfigInput) Type

func (c *ConfigInput) Type(val string) (string, error)

func (*ConfigInput) Validate

func (c *ConfigInput) Validate(schema InputSchema) error

type Input

type Input interface {
	Data(string) (interface{}, error)
	Type(string) (string, error)
	Validate(InputSchema) error
}

type InputSchema

type InputSchema map[string]struct {
	Types    []string
	Required bool
	Values   []interface{}
}

func NewInputSchema

func NewInputSchema(in []byte) (InputSchema, error)

type Module

type Module interface {
	Name() string
	Configure(Input) error
	Run(rwvfs.FileSystem, ResponseWriter)
}

type Response

type Response struct {
	Ok     bool
	Notify bool
	Fields log.Fields
}

func NewResponse

func NewResponse() *Response

func (*Response) Changed

func (r *Response) Changed(ok bool)

func (*Response) Message

func (r *Response) Message(level string, messages ...interface{})

func (*Response) Success

func (r *Response) Success(ok bool)

type ResponseWriter

type ResponseWriter interface {
	Success(bool)
	Changed(bool)
	Message(string, ...interface{})
}

type RunControl

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

func NewRunControl

func NewRunControl() *RunControl

func (RunControl) Register

func (r RunControl) Register() func()

func (RunControl) Start

func (r RunControl) Start()

func (RunControl) Wait

func (r RunControl) Wait()