showbridge

README

showbridge (go edition)

Simple protocol router /s

Releases · Documentation

Supported Protocols

• HTTP
• UDP
• TCP
• MQTT
• NATS
• PosiStageNet
• MIDI (not included in pre-built binaries yet)
• Serial (not included in pre-built binaries yet)
• OSC
• FreeD
• SIP
• Redis

CLI Usage

NAME:
   showbridge - Simple protocol router /s

USAGE:
   showbridge [global options]

GLOBAL OPTIONS:
   --config string      path to config file (default: "./config.yaml") [$SHOWBRIDGE_CONFIG]
   --log-level string   set log level (default: "info") [$SHOWBRIDGE_LOG_LEVEL]
   --log-format string  log format to use (default: "text") [$SHOWBRIDGE_LOG_FORMAT]
   --trace              enable OpenTelemetry tracing [$SHOWBRIDGE_TRACE]
   --help, -h           show help
   --version, -v        print the version

Documentation

Index

• type Router
  • func NewRouter(routerConfig config.Config) (*Router, []config.ModuleError, []config.RouteError)
  • func (r *Router) AddEventDestination(dest common.EventDestination)
  • func (r *Router) GetRunningConfig() config.Config
  • func (r *Router) HandleEvent(event common.Event, sender common.EventDestination)
  • func (r *Router) HandleInput(ctx context.Context, sourceId string, payload any) (bool, []common.RouteIOError)
  • func (r *Router) HandleOutput(ctx context.Context, destinationId string, payload any) error
  • func (r *Router) RemoveEventDestination(dest common.EventDestination)
  • func (r *Router) Start(ctx context.Context)
  • func (r *Router) Stop()
  • func (r *Router) UpdateConfig(newConfig config.Config, triggerChangeChan bool) (error, []config.ModuleError, []config.RouteError)

Types

type Router

type Router struct {
	Context context.Context
	// TODO(jwetzell): do these need to be guarded against concurrency?
	ModuleInstances map[string]common.Module
	// TODO(jwetzell): change to something easier to lookup
	RouteInstances []*route.Route
	ConfigChange   chan config.Config
	// contains filtered or unexported fields
}

TODO(jwetzell): can/should this be split into different "components"?

func NewRouter

func NewRouter(routerConfig config.Config) (*Router, []config.ModuleError, []config.RouteError)

func (*Router) AddEventDestination

func (r *Router) AddEventDestination(dest common.EventDestination)

func (*Router) GetRunningConfig

func (r *Router) GetRunningConfig() config.Config

func (*Router) HandleEvent

func (r *Router) HandleEvent(event common.Event, sender common.EventDestination)

func (*Router) HandleInput

func (r *Router) HandleInput(ctx context.Context, sourceId string, payload any) (bool, []common.RouteIOError)

func (*Router) HandleOutput

func (r *Router) HandleOutput(ctx context.Context, destinationId string, payload any) error

func (*Router) RemoveEventDestination

func (r *Router) RemoveEventDestination(dest common.EventDestination)

func (*Router) Start

func (r *Router) Start(ctx context.Context)

func (*Router) Stop

func (r *Router) Stop()

func (*Router) UpdateConfig

func (r *Router) UpdateConfig(newConfig config.Config, triggerChangeChan bool) (error, []config.ModuleError, []config.RouteError)