signal

package

v0.6.0 Latest Latest Go to latest Published: May 13, 2026 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tiny-systems/common-module

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	ComponentName        = "signal"
	OutPort       string = "out"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Component ¶

type Component struct {
	module.Base
	// contains filtered or unexported fields
}

func (*Component) GetInfo ¶

func (t *Component) GetInfo() module.ComponentInfo

func (*Component) Handle ¶

func (t *Component) Handle(_ context.Context, _ module.Handler, port string, _ any) module.Result

Handle is unreachable: OutPort is source-only, no business input.

func (*Component) Instance ¶

func (t *Component) Instance() module.Component

func (*Component) OnControl ¶ added in v0.2.0

func (t *Component) OnControl(ctx context.Context, msg any) error

OnControl handles Send/Reset dashboard clicks.

func (*Component) OnReconcile ¶ added in v0.2.0

func (t *Component) OnReconcile(ctx context.Context, node v1alpha1.TinyNode) error

OnReconcile restores send context from metadata and resumes any orphaned blocking call (pod restart while OutPort was still pending).

func (*Component) OnSettings ¶ added in v0.2.0

func (t *Component) OnSettings(_ context.Context, msg any) error

OnSettings receives Settings from the SettingsPort and marks settingsFromPort to suppress later reconciles from restoring stale data.

func (*Component) Ports ¶

func (t *Component) Ports() []module.Port

type Context ¶

type Context any

type ControlRunning ¶ added in v0.1.215

type ControlRunning struct {
	Context Context `json:"context" required:"true" title:"Context" readonly:"true"`
	Reset   bool    `json:"reset" format:"button" title:"Reset" required:"true"`
}

ControlRunning is the _control port schema when the signal is running

type ControlStopped ¶ added in v0.1.215

type ControlStopped struct {
	Context Context `json:"context" required:"true" title:"Context"`
	Send    bool    `json:"send" format:"button" title:"Send" required:"true"`
}

ControlStopped is the _control port schema when the signal is not running

type Settings ¶

type Settings struct {
	Context Context `json:"context" required:"true" configurable:"true" title:"Context" description:"Arbitrary message to send"`
}

Source Files ¶

View all Source files

signal.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL