routers

package
v0.40.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 25, 2019 License: AGPL-3.0 Imports: 13 Imported by: 2

Documentation

Index

Constants

View Source 
const TypeRandom string = "random"

TypeRandom is the type for a random router

View Source 
const TypeSwitch string = "switch"

TypeSwitch is the constant for our switch router

Variables

This section is empty.

Functions

func ReadRouter added in v0.11.0 

func ReadRouter(data json.RawMessage) (flows.Router, error)

ReadRouter reads a router from the given JSON

func RegisterType added in v0.11.0 

func RegisterType(name string, f readFunc)

RegisterType registers a new type of router

func RegisteredTypes added in v0.29.7 

func RegisteredTypes() []string

RegisteredTypes gets the registered types of router

Types

type BaseRouter 

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

BaseRouter is the base class for all our router classes

func (*BaseRouter) AllowTimeout added in v0.33.0 

func (r *BaseRouter) AllowTimeout() bool

AllowTimeout returns whether this router can be resumed at with a timeout

func (*BaseRouter) EnumerateDependencies added in v0.29.0 

func (r *BaseRouter) EnumerateDependencies(localization flows.Localization, include func(assets.Reference))

EnumerateDependencies enumerates all dependencies on this object

func (*BaseRouter) EnumerateResults added in v0.30.2 

func (r *BaseRouter) EnumerateResults(include func(*flows.ResultInfo))

EnumerateResults enumerates all potential results on this object

func (*BaseRouter) EnumerateTemplates added in v0.29.0 

func (r *BaseRouter) EnumerateTemplates(include flows.TemplateIncluder)

EnumerateTemplates enumerates all expressions on this object and its children

func (*BaseRouter) ResultName 

func (r *BaseRouter) ResultName() string

ResultName returns the name which the result of this router should be saved as (if any)

func (*BaseRouter) RouteTimeout added in v0.33.5 

func (r *BaseRouter) RouteTimeout(run flows.FlowRun, step flows.Step, logEvent flows.EventCallback) (flows.ExitUUID, error)

RouteTimeout routes in the case that this router's wait timed out

func (*BaseRouter) Type added in v0.22.0 

func (r *BaseRouter) Type() string

Type returns the type of this router

func (*BaseRouter) Wait added in v0.32.1 

func (r *BaseRouter) Wait() flows.Wait

Wait returns the optional wait on this router

type Case 

type Case struct {
	UUID         utils.UUID         `json:"uuid"                   validate:"required"`
	Type         string             `json:"type"                   validate:"required"`
	Arguments    []string           `json:"arguments,omitempty"`
	CategoryUUID flows.CategoryUUID `json:"category_uuid"          validate:"required"`
}

Case represents a single case and test in our switch

func NewCase added in v0.23.0 

func NewCase(uuid utils.UUID, type_ string, arguments []string, categoryUUID flows.CategoryUUID) *Case

NewCase creates a new case

func (*Case) EnumerateDependencies added in v0.29.0 

func (c *Case) EnumerateDependencies(localization flows.Localization, include func(assets.Reference))

EnumerateDependencies enumerates all dependencies on this object and its children

func (*Case) EnumerateResults added in v0.30.2 

func (c *Case) EnumerateResults(include func(*flows.ResultInfo))

EnumerateResults enumerates all potential results on this object

func (*Case) EnumerateTemplates added in v0.29.0 

func (c *Case) EnumerateTemplates(include flows.TemplateIncluder)

EnumerateTemplates enumerates all expressions on this object and its children

func (*Case) Inspect added in v0.29.0 

func (c *Case) Inspect(inspect func(flows.Inspectable))

Inspect inspects this object and any children

func (*Case) LocalizationUUID added in v0.29.0 

func (c *Case) LocalizationUUID() utils.UUID

LocalizationUUID gets the UUID which identifies this object for localization

type Category added in v0.30.2 

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

func NewCategory added in v0.30.2 

func NewCategory(uuid flows.CategoryUUID, name string, exit flows.ExitUUID) *Category

NewCategory creates a new category

func (*Category) ExitUUID added in v0.30.2 

func (c *Category) ExitUUID() flows.ExitUUID

func (*Category) LocalizationUUID added in v0.30.2 

func (c *Category) LocalizationUUID() utils.UUID

LocalizationUUID gets the UUID which identifies this object for localization

func (*Category) MarshalJSON added in v0.30.2 

func (c *Category) MarshalJSON() ([]byte, error)

MarshalJSON marshals this node category into JSON

func (*Category) Name added in v0.30.2 

func (c *Category) Name() string

func (*Category) UUID added in v0.30.2 

func (c *Category) UUID() flows.CategoryUUID

func (*Category) UnmarshalJSON added in v0.30.2 

func (c *Category) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals a node category from the given JSON

type RandomRouter 

type RandomRouter struct {
	BaseRouter
}

RandomRouter is a router which will exit out a random exit

func NewRandomRouter added in v0.4.0 

func NewRandomRouter(wait flows.Wait, resultName string, categories []*Category) *RandomRouter

NewRandomRouter creates a new random router

func (*RandomRouter) Inspect added in v0.29.0 

func (r *RandomRouter) Inspect(inspect func(flows.Inspectable))

Inspect inspects this object and any children

func (*RandomRouter) MarshalJSON added in v0.32.1 

func (r *RandomRouter) MarshalJSON() ([]byte, error)

MarshalJSON marshals this resume into JSON

func (*RandomRouter) Route added in v0.33.0 

func (r *RandomRouter) Route(run flows.FlowRun, step flows.Step, logEvent flows.EventCallback) (flows.ExitUUID, error)

Route determines which exit to take from a node

func (*RandomRouter) Validate 

func (r *RandomRouter) Validate(exits []flows.Exit) error

Validate validates that the fields on this router are valid

type SwitchRouter 

type SwitchRouter struct {
	BaseRouter
	// contains filtered or unexported fields
}

SwitchRouter is a router which allows specifying 0-n cases which should each be tested in order, following whichever case returns true, or if none do, then taking the default category

func NewSwitchRouter added in v0.4.0 

func NewSwitchRouter(wait flows.Wait, resultName string, categories []*Category, operand string, cases []*Case, defaultCategory flows.CategoryUUID) *SwitchRouter

NewSwitchRouter creates a new switch router

func (*SwitchRouter) Cases 

func (r *SwitchRouter) Cases() []*Case

func (*SwitchRouter) EnumerateDependencies added in v0.29.0 

func (r *SwitchRouter) EnumerateDependencies(localization flows.Localization, include func(assets.Reference))

EnumerateDependencies enumerates all dependencies on this object and its children

func (*SwitchRouter) EnumerateTemplates added in v0.29.0 

func (r *SwitchRouter) EnumerateTemplates(include flows.TemplateIncluder)

EnumerateTemplates enumerates all expressions on this object and its children

func (*SwitchRouter) Inspect added in v0.29.0 

func (r *SwitchRouter) Inspect(inspect func(flows.Inspectable))

Inspect inspects this object and any children

func (*SwitchRouter) MarshalJSON added in v0.32.1 

func (r *SwitchRouter) MarshalJSON() ([]byte, error)

MarshalJSON marshals this resume into JSON

func (*SwitchRouter) Route added in v0.33.0 

func (r *SwitchRouter) Route(run flows.FlowRun, step flows.Step, logEvent flows.EventCallback) (flows.ExitUUID, error)

Route determines which exit to take from a node

func (*SwitchRouter) Validate 

func (r *SwitchRouter) Validate(exits []flows.Exit) error

Validate validates the arguments for this router

Source Files

View all Source files

Directories

Path Synopsis
hints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.