ruleset

Documentation

Overview

# The MIT License (MIT) # # Copyright (c) 2019 Carbon Black # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in all # copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE.

Index

• func RunProjection(r *Rulebase, record string, ruleProperty string) (result bool, outbound []byte, err error)
• func RunRecordGeneration(r *Rulebase, fatalErr chan error) (err error)
• func RunRule(r *Rulebase, shardId string, outbound []byte) (bool, error)
• type Base
• type Dest
• type ResultInterface
• type Rulebase
• type Step

Functions

func RunProjection

func RunProjection(r *Rulebase, record string, ruleProperty string) (result bool, outbound []byte, err error)

does all the projects of a record that will be further processed gets a JSON formatted byte array and passes it back

func RunRecordGeneration

func RunRecordGeneration(r *Rulebase, fatalErr chan error) (err error)

func RunRule

func RunRule(r *Rulebase, shardId string, outbound []byte) (bool, error)

This runs a rule give the record

Types

type Base

type Base struct {
	Line *list.List
}

type Dest

type Dest struct {
	Plugin  *plg.IOPluginInterface
	Pointer interface{}
}

type ResultInterface

type ResultInterface interface{}

type Rulebase

type Rulebase struct {
	RuleName     string
	MetricSender *metrics.SfxClient
	Predicate    *list.List
	Projection   *list.List
	Cache        *list.List
	Destination  *Dest
	Checkpoint   bool
}

type Step

type Step struct {
	ID        *string
	Plugin    *plg.PluginInterface
	Value     *string
	MultiArgs *list.List
	Result    ResultInterface
	GetPrev   bool
}