Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BaseHeuristic ¶
type BaseHeuristic struct {
// contains filtered or unexported fields
}
BaseHeuristic ... Base heuristic implementation
func (*BaseHeuristic) Assess ¶
func (bi *BaseHeuristic) Assess(core.TransitData) (*core.Activation, bool, error)
Assess ... Determines if a heuristic activation has occurred; defaults to no-op
func (*BaseHeuristic) InputType ¶
func (bi *BaseHeuristic) InputType() core.RegisterType
InputType ... Returns the input type for the heuristic
func (*BaseHeuristic) SUUID ¶
func (bi *BaseHeuristic) SUUID() core.SUUID
SUUID ... Returns the heuristic session UUID
func (*BaseHeuristic) SetSUUID ¶
func (bi *BaseHeuristic) SetSUUID(sUUID core.SUUID)
SetSUUID ... Sets the heuristic session UUID
func (*BaseHeuristic) ValidateInput ¶
func (bi *BaseHeuristic) ValidateInput(td core.TransitData) error
ValidateInput ... Validates the input type for the heuristic
type BaseHeuristicOpt ¶
type BaseHeuristicOpt = func(bi *BaseHeuristic) *BaseHeuristic
BaseHeuristicOpt ... Functional option for BaseHeuristic
type DeployConfig ¶
type DeployConfig struct {
Stateful bool
StateKey *core.StateKey
Network core.Network
PUUID core.PUUID
Reuse bool
HeuristicType core.HeuristicType
Params *core.SessionParams
AlertingPolicy *core.AlertPolicy
}
DeployConfig ... Configuration for deploying a heuristic session
type ExecutionType ¶
type ExecutionType int
ExecutionType ... Enum for execution type
const ( // HardCoded ... Hard coded execution type (ie native application code) HardCoded ExecutionType = iota )
type Heuristic ¶
type Heuristic interface {
InputType() core.RegisterType
ValidateInput(core.TransitData) error
Assess(core.TransitData) (*core.Activation, bool, error)
SUUID() core.SUUID
SetSUUID(core.SUUID)
}
Heuristic ... Interface that all heuristic implementations must adhere to
func NewBaseHeuristic ¶
func NewBaseHeuristic(inType core.RegisterType, opts ...BaseHeuristicOpt) Heuristic
NewBaseHeuristic ... Initializer for BaseHeuristic This is a base type that's inherited by all hardcoded heuristic implementations
Source Files