astiencoder

May 1, 2023

Changes in this version

type BaseNode

+ func (n *BaseNode) NewChildCloser() *astikit.Closer

type Closer

+ NewChildCloser func() *astikit.Closer

Nov 2, 2022

Changes in this version

+ type NodeAutoStopOptions struct

+ WhenAllChildrenAreStopped bool

+ WhenAllParentsAreStopped bool

type NodeOptions

+ AutoStop *NodeAutoStopOptions

Oct 22, 2022

Changes in this version

+ type StatValueHostUsage struct

+ CPU StatValueHostUsageCPU

+ Memory StatValueHostUsageMemory

+ type StatValueHostUsageCPU struct

+ Individual []float64

+ Process float64

+ Total float64

+ type StatValueHostUsageMemory struct

+ Resident uint64

+ Total uint64

+ Used uint64

+ Virtual uint64

Oct 14, 2022

Changes in this version

+ type EventHandlerLogAdapter func(*EventHandler, *EventLogger)

+ func MessageMergingEventHandlerLogAdapter(period time.Duration) EventHandlerLogAdapter

+ type EventHandlerLogOptions struct

+ Adapters []EventHandlerLogAdapter

+ Logger astikit.StdLogger

+ LoggerLevels map[EventName]astikit.LoggerLevel

+ type EventName string

+ type EventType string

Oct 13, 2022

Changes in this version

type EventLogger

+ func (l *EventLogger) Writef(ll astikit.LoggerLevel, format string, v ...interface{})

+ func (l *EventLogger) Writek(ll astikit.LoggerLevel, key, msg string)

Sep 14, 2022

Changes in this version

type Workflow

+ func (w *Workflow) AddDefaultStats() (err error)

Aug 15, 2022

Changes in this version

type Server

+ func (s *Server) ServeWelcome() http.Handler

+ type ServerNotifierFunc func(eventName string, payload interface{})

type ServerOptions

+ NotifierFunc ServerNotifierFunc

May 27, 2022

Changes in this version

+ const StatusCreated

+ var EventNameNodeChildAdded = "astiencoder.node.child.added"

+ var EventNameNodeChildRemoved = "astiencoder.node.child.removed"

+ var EventNameWorkflowChildAdded = "astiencoder.workflow.child.added"

+ var EventNameWorkflowChildRemoved = "astiencoder.workflow.child.removed"

+ var EventTypeChildAdded = "child.added"

+ var EventTypeChildRemoved = "child.removed"

+ type ServerChildUpdate struct

+ Child string

+ Parent string

Mar 26, 2022

Changes in this version

type EventHandler

+ func (h *EventHandler) Log(i astikit.StdLogger, opts ...EventHandlerLogOption) (l *EventLogger)

+ type EventHandlerLogOption func(*EventHandler, *EventLogger)

+ func WithMessageMerging(period time.Duration) EventHandlerLogOption

+ type EventLogger struct

+ func (l *EventLogger) Close()

+ func (l *EventLogger) Debugk(key, msg string)

+ func (l *EventLogger) Errorf(format string, v ...interface{})

+ func (l *EventLogger) Errork(key, msg string)

+ func (l *EventLogger) Infof(format string, v ...interface{})

+ func (l *EventLogger) Infok(key, msg string)

+ func (l *EventLogger) Start(ctx context.Context) *EventLogger

+ func (l *EventLogger) Warnk(key, msg string)

Feb 20, 2022

Changes in this version

type BaseNode

+ func (n *BaseNode) AddClose(fn astikit.CloseFunc)

+ func (n *BaseNode) AddCloseWithError(fn astikit.CloseFuncWithError)

type Closer

+ AddClose func(astikit.CloseFunc)

+ AddCloseWithError func(astikit.CloseFuncWithError)

Dec 14, 2021

Changes in this version

+ var EventNameNodeClosed = "astiencoder.node.closed"

+ var EventNameWorkflowClosed = "astiencoder.workflow.closed"

+ var EventTypeClosed = "closed"

type BaseNode

+ func (n *BaseNode) AddCloseFunc(fn astikit.CloseFunc)

+ func (n *BaseNode) Close() error

+ func (n *BaseNode) DoWhenUnclosed(fn func())

+ func (n *BaseNode) IsClosed() bool

+ type Closer interface

+ AddCloseFunc func(astikit.CloseFunc)

+ Close func() error

+ DoWhenUnclosed func(func())

+ IsClosed func() bool

type ServerNode

+ Closed bool

Dec 2, 2021

Changes in this version

+ const StatNameHostUsage

Nov 21, 2021

Changes in this version

+ const StatNamePSUtil

type ServerStat

+ Name string

Nov 21, 2020

Changes in this version

+ var EventNameStats = "astiencoder.stats"

+ func EventTypeToNodeEventName(eventType string) string

+ func EventTypeToWorkflowEventName(eventType string) string

type BaseNode

+ func (n *BaseNode) AddStats(ss ...astikit.StatOptions)

type EventStat

+ Target interface{}

+ type EventTypeTransformer func(eventType string) string

type ServerStat

+ Target string

type Stater

+ func NewStater(period time.Duration, eh *EventHandler) (s *Stater)

+ func (s *Stater) AddStats(target interface{}, os ...astikit.StatOptions)

+ func (s *Stater) DelStats(target interface{}, os ...astikit.StatOptions)

+ func (s *Stater) Start(ctx context.Context)

+ func (s *Stater) Stop()

Sep 28, 2020

Changes in this version

type EventStat

+ Name string

type NodeMetadata

+ Tags []string

+ type Server struct

+ func NewServer(o ServerOptions) *Server

+ func (s *Server) EventHandlerAdapter(eh *EventHandler)

+ func (s *Server) Handler() http.Handler

+ func (s *Server) SetWorkflow(w *Workflow)

+ type ServerNode struct

+ Children []string

+ Description string

+ Label string

+ Name string

+ Parents []string

+ Status string

+ Tags []string

+ type ServerOptions struct

+ Logger astikit.StdLogger

+ type ServerStat struct

+ Description string

+ Label string

+ Unit string

+ Value interface{}

+ type ServerStats struct

+ Name string

+ Stats []ServerStat

+ type ServerWelcome struct

+ Workflow *ServerWorkflow

+ type ServerWorkflow struct

+ Name string

+ Nodes []ServerNode

+ Status string

type Workflow

+ func (w *Workflow) NewRecording(o WorkflowRecordingOptions) (r *WorkflowRecording)

+ type WorkflowRecording struct

+ func (r *WorkflowRecording) Start(ctx context.Context) (err error)

+ func (r *WorkflowRecording) Stop()

+ type WorkflowRecordingOptions struct

+ Dst string

+ Logger astikit.StdLogger

Dec 4, 2019

Changes in this version

+ const StatusPaused

+ const StatusRunning

+ const StatusStopped

+ var ErrWorkflowNotFound = errors.New("astiencoder: workflow.not.found")

+ var EventNameError = "astiencoder.error"

+ var EventNameNodeContinued = "astiencoder.node.continued"

+ var EventNameNodePaused = "astiencoder.node.paused"

+ var EventNameNodeStarted = "astiencoder.node.started"

+ var EventNameNodeStats = "astiencoder.node.stats"

+ var EventNameNodeStopped = "astiencoder.node.stopped"

+ var EventNameWorkflowContinued = "astiencoder.workflow.continued"

+ var EventNameWorkflowPaused = "astiencoder.workflow.paused"

+ var EventNameWorkflowStarted = "astiencoder.workflow.started"

+ var EventNameWorkflowStats = "astiencoder.workflow.stats"

+ var EventNameWorkflowStopped = "astiencoder.workflow.stopped"

+ var EventTypeContinued = "continued"

+ var EventTypePaused = "paused"

+ var EventTypeStarted = "started"

+ var EventTypeStats = "stats"

+ var EventTypeStopped = "stopped"

+ func ConnectNodes(parent, child Node)

+ func DisconnectNodes(parent, child Node)

+ func LoggerEventHandlerAdapter(h *EventHandler)

+ func WriteJSONError(rw http.ResponseWriter, code int, err error)

+ type BaseNode struct

+ func NewBaseNode(o NodeOptions, eg EventGenerator, eh *EventHandler) (n *BaseNode)

+ func (n *BaseNode) AddChild(i Node)

+ func (n *BaseNode) AddParent(i Node)

+ func (n *BaseNode) ChildIsStarted(m NodeMetadata)

+ func (n *BaseNode) ChildIsStopped(m NodeMetadata)

+ func (n *BaseNode) Children() (ns []Node)

+ func (n *BaseNode) Context() context.Context

+ func (n *BaseNode) Continue()

+ func (n *BaseNode) DelChild(i Node)

+ func (n *BaseNode) DelParent(i Node)

+ func (n *BaseNode) HandlePause()

+ func (n *BaseNode) Metadata() NodeMetadata

+ func (n *BaseNode) ParentIsStarted(m NodeMetadata)

+ func (n *BaseNode) ParentIsStopped(m NodeMetadata)

+ func (n *BaseNode) Parents() (ns []Node)

+ func (n *BaseNode) Pause()

+ func (n *BaseNode) Start(ctx context.Context, tc CreateTaskFunc, execFunc BaseNodeExecFunc)

+ func (n *BaseNode) Stater() *astistat.Stater

+ func (n *BaseNode) Status() string

+ func (n *BaseNode) Stop()

+ type BaseNodeExecFunc func(t *astiworker.Task)

+ type BaseNodeStartFunc func()

+ type CreateTaskFunc func() *astiworker.Task

+ type Event struct

+ Name string

+ Payload interface{}

+ Target interface{}

+ func EventError(target interface{}, err error) Event

+ type EventCallback func(e Event) (deleteListener bool)

+ type EventGenerator interface

+ Event func(eventType string, payload interface{}) Event

+ type EventGeneratorNode struct

+ func NewEventGeneratorNode(n Node) *EventGeneratorNode

+ func (g EventGeneratorNode) Event(eventType string, payload interface{}) Event

+ type EventGeneratorWorkflow struct

+ func NewEventGeneratorWorkflow(w *Workflow) *EventGeneratorWorkflow

+ func (g EventGeneratorWorkflow) Event(eventType string, payload interface{}) Event

+ type EventHandler struct

+ func NewEventHandler() *EventHandler

+ func (h *EventHandler) Add(target interface{}, eventName string, c EventCallback)

+ func (h *EventHandler) AddForAll(c EventCallback)

+ func (h *EventHandler) AddForEventName(eventName string, c EventCallback)

+ func (h *EventHandler) AddForTarget(target interface{}, c EventCallback)

+ func (h *EventHandler) Emit(e Event)

+ type EventStat struct

+ Description string

+ Label string

+ Unit string

+ Value interface{}

+ type ExposedError struct

+ Message string

+ type ExposedReferences struct

+ WsPingPeriod time.Duration

+ type ExposedStat struct

+ Description string

+ Label string

+ Unit string

+ Value interface{}

+ type ExposedStatMetadata struct

+ Description string

+ Label string

+ Unit string

+ type ExposedStats struct

+ Name string

+ Stats []ExposedStat

+ type ExposedWorkflow struct

+ Edges []ExposedWorkflowEdge

+ Nodes []ExposedWorkflowNode

+ type ExposedWorkflowBase struct

+ Name string

+ Status string

+ type ExposedWorkflowEdge struct

+ From string

+ To string

+ type ExposedWorkflowNode struct

+ Description string

+ Label string

+ Name string

+ Stats []ExposedStatMetadata

+ Status string

+ type Node interface

+ type NodeChild interface

+ ParentIsStarted func(m NodeMetadata)

+ ParentIsStopped func(m NodeMetadata)

+ type NodeChildMapper interface

+ AddParent func(n Node)

+ DelParent func(n Node)

+ Parents func() []Node

+ type NodeDescriptor interface

+ Metadata func() NodeMetadata

+ type NodeMetadata struct

+ Description string

+ Label string

+ Name string

+ func (m NodeMetadata) Extend(name, label, description string) NodeMetadata

+ type NodeOptions struct

+ Metadata NodeMetadata

+ NoIndirectStop bool

+ type NodeParent interface

+ ChildIsStarted func(m NodeMetadata)

+ ChildIsStopped func(m NodeMetadata)

+ type NodeParentMapper interface

+ AddChild func(n Node)

+ Children func() []Node

+ DelChild func(n Node)

+ type Starter interface

+ Continue func()

+ Pause func()

+ Start func(ctx context.Context, t CreateTaskFunc)

+ Status func() string

+ Stop func()

+ type Stater interface

+ Stater func() *astistat.Stater

+ type Workflow struct

+ func NewWorkflow(ctx context.Context, name string, e *EventHandler, tf CreateTaskFunc, ...) (w *Workflow)

+ func (w *Workflow) AddChild(n Node)

+ func (w *Workflow) Children() []Node

+ func (w *Workflow) Continue()

+ func (w *Workflow) DelChild(n Node)

+ func (w *Workflow) Name() string

+ func (w *Workflow) Pause()

+ func (w *Workflow) Start()

+ func (w *Workflow) StartNodes(ns ...Node)

+ func (w *Workflow) StartNodesInSubTask(ns ...Node) (t *astiworker.Task)

+ func (w *Workflow) StartWithOptions(o WorkflowStartOptions)

+ func (w *Workflow) Status() string

+ func (w *Workflow) Stop()

+ type WorkflowPool struct

+ func NewWorkflowPool() *WorkflowPool

+ func (wp *WorkflowPool) AddWorkflow(w *Workflow)

+ func (wp *WorkflowPool) Serve(eh *EventHandler, pathWeb string, fn func(http.Handler)) (err error)

+ func (wp *WorkflowPool) Workflow(name string) (w *Workflow, err error)

+ func (wp *WorkflowPool) Workflows() (ws []*Workflow)

+ type WorkflowStartGroup struct

+ Callback func(t *astiworker.Task)

+ Nodes []Node

+ type WorkflowStartOptions struct

+ Groups []WorkflowStartGroup