Documentation
¶
Overview ¶
Package flowgraph_plugin supplies the Stream Echo Device node and its settings editor.
Index ¶
- Constants
- Variables
- func NewFactory(b bus.Bus) controller.Factory
- func Register(ctx context.Context, client *resource_client.Client, root srpc.Client, ...) (func() error, error)
- type Config
- func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *Config) CloneVT() *Config
- func (this *Config) EqualMessageVT(thatMsg any) bool
- func (this *Config) EqualVT(that *Config) bool
- func (c *Config) EqualsConfig(other config.Config) bool
- func (c *Config) GetConfigID() string
- func (x *Config) MarshalJSON() ([]byte, error)
- func (x *Config) MarshalProtoJSON(s *json.MarshalState)
- func (x *Config) MarshalProtoText() string
- func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Config) MarshalToVT(dAtA []byte) (int, error)
- func (m *Config) MarshalVT() (dAtA []byte, err error)
- func (*Config) ProtoMessage()
- func (x *Config) Reset()
- func (m *Config) SizeVT() (n int)
- func (x *Config) String() string
- func (x *Config) UnmarshalJSON(b []byte) error
- func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *Config) UnmarshalVT(dAtA []byte) error
- func (c *Config) Validate() error
- type Controller
- type StreamEcho
Constants ¶
const ConfigID = ControllerID
ConfigID selects the Stream Echo plugin controller.
const ControllerID = "plugin/flowgraph"
ControllerID selects the Stream Echo plugin controller.
const PluginID = "spacewave-flowgraph"
PluginID identifies the manifest shipping this node type and editor.
const StreamEchoNodeTypeID = "flowgraph/stream-echo"
StreamEchoNodeTypeID selects the plugin's echo service.
Variables ¶
var EditorEntrypoint bldr_web_bundler.WebBundlerOutput
EditorEntrypoint contains the editor asset URL supplied by the plugin builder.
var Version = controller.MustParseVersion("0.0.1")
Version is the plugin controller version.
Functions ¶
func NewFactory ¶
func NewFactory(b bus.Bus) controller.Factory
NewFactory constructs the plugin startup factory for Bldr's goPkgs discovery.
func Register ¶
func Register(ctx context.Context, client *resource_client.Client, root srpc.Client, editorPath string) (func() error, error)
Register publishes the Stream Echo compiler and editor through the core Resource client. The returned release withdraws both registrations and detaches the compiler.
Types ¶
type Config ¶
type Config struct {
// contains filtered or unexported fields
}
Config starts the Stream Echo node type plugin.
func (*Config) CloneMessageVT ¶
func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*Config) EqualMessageVT ¶
func (*Config) EqualsConfig ¶
EqualsConfig compares plugin startup configurations.
func (*Config) GetConfigID ¶
GetConfigID returns the plugin controller config identifier.
func (*Config) MarshalJSON ¶
MarshalJSON marshals the Config to JSON.
func (*Config) MarshalProtoJSON ¶
func (x *Config) MarshalProtoJSON(s *json.MarshalState)
MarshalProtoJSON marshals the Config message to JSON.
func (*Config) MarshalProtoText ¶
func (*Config) MarshalToSizedBufferVT ¶
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) UnmarshalJSON ¶
UnmarshalJSON unmarshals the Config from JSON.
func (*Config) UnmarshalProtoJSON ¶
func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)
UnmarshalProtoJSON unmarshals the Config message from JSON.
func (*Config) UnmarshalVT ¶
type Controller ¶
type Controller struct {
// BusController supplies the plugin-local bus and lifetime.
*bus.BusController[*Config]
}
Controller publishes the plugin's node type and editor until the bus removes it.
type StreamEcho ¶
type StreamEcho struct{}
StreamEcho serves a peer stream that returns every byte sent to it.
func NewStreamEcho ¶
func NewStreamEcho() *StreamEcho
NewStreamEcho constructs the plugin's node type.
func (*StreamEcho) Compile ¶
func (n *StreamEcho) Compile(ctx context.Context, node *s4wave_flowgraph.PlacedFlowgraphNode) (map[string]config.Config, error)
Compile serves every connected stream, or the explicit protocol_id parameter.
func (*StreamEcho) GetConfigIDs ¶
func (n *StreamEcho) GetConfigIDs() []string
GetConfigIDs declares the existing stream echo controller.
func (*StreamEcho) GetDisplayName ¶
func (n *StreamEcho) GetDisplayName() string
GetDisplayName returns the name shown for the node type.
func (*StreamEcho) GetPorts ¶
func (n *StreamEcho) GetPorts() []*s4wave_flowgraph.FlowgraphPort
GetPorts declares the stream output that Local Ports may connect to.
Source Files