sidecar

Documentation

Index

• func ConfFolder() (confFolder string, err error)
• func ConfigFactory(cfPath string) sputnik.ConfFactory
• func LoadDockerComposeFile(url string) error
• func LoadEnv() error
• func ReadAppBlocks(confFolder string) ([]sputnik.BlockDescriptor, error)
• func Start(cntr sputnik.ServerConnector)
• func StartServices() (stopServices func(), err error)
• func StartServicesWithCompose(composePath string) (stopServices func(), err error)
• func UseEmbeddedConfiguration(efs *embed.FS) (cleanUp func(), err error)
• func WalkDir(root string, exts []string) ([]string, error)
• type Cleaner
  • func (c *Cleaner) Clean()
  • func (c *Cleaner) Push(cf func())
• type Connector
• type MessageConsumer
• type MessageProducer
• type Runner
  • func StartRunner(confFolder string, cntr sputnik.ServerConnector) (*Runner, error)
  • func (rnr *Runner) Start(ri *runnerInfo) error
  • func (rnr *Runner) Stop()
  • func (rnr *Runner) Wait()

Functions

func ConfFolder

func ConfFolder() (confFolder string, err error)

Command line of sidecar : <exe name> --cf <path of config folder> ConfFolder() return the value of 'cf' flag

func ConfigFactory

func ConfigFactory(cfPath string) sputnik.ConfFactory

ConfigFactory returns implementation of sputnik.ConfFactory based on github.com/tkanos/gonfig - JSON format of config files - Automatic matching of environment variables - Env. variable for configuration "example" and key "kname" should be set in environment as "EXAMPLE_KNAME" - Value in environment automatically overrides value from the file - Temporary used github.com/g41797/gonfig (till merge of PR)

func LoadDockerComposeFile

func LoadDockerComposeFile(url string) error

Loads docker-compose.yml file to configuration folder with name "docker-compose.yml" for further using by StartServices

func LoadEnv

func LoadEnv() error

Loads all *.env file from configuration folder of the process. Overwrites non-existing environment variables. Supports "prefixed" environment variables (https://github.com/g41797/gonfig#using-prefixes-for-environment-variables-name)

func ReadAppBlocks

func ReadAppBlocks(confFolder string) ([]sputnik.BlockDescriptor, error)

func Start

func Start(cntr sputnik.ServerConnector)

func StartServices

func StartServices() (stopServices func(), err error)

Starts docker compose on 'docker-compose.yml' from configuration folder Does not wait finish.

func StartServicesWithCompose

func StartServicesWithCompose(composePath string) (stopServices func(), err error)

func UseEmbeddedConfiguration

func UseEmbeddedConfiguration(efs *embed.FS) (cleanUp func(), err error)

UseEmbeddedConfiguration creates temporary directory and copies configuration files embedded within package. For success returns cleanUp function for removing created directory Use this function in main function if you don't supply path to config directory in command line. Example:

import (

	"embed"
 .......

)

go:embed configdir var cnffiles embed.FS

func main() {
	cleanup, err := sidecar.UseEmbeddedConfiguration(&cnffiles)
	if err != nil {
		return err
	}
	defer cleanup()
	sidecar.Start(new(adapter.BrokerConnector))
}

func WalkDir

func WalkDir(root string, exts []string) ([]string, error)

Finds all the files matching a particular suffix in all the directories https://stackoverflow.com/questions/70537979/how-to-efficiently-find-all-the-files-matching-a-particular-suffix-in-all-the-di

Types

type Cleaner

type Cleaner struct {
	// contains filtered or unexported fields
}

Emulates stack of cleanup functions

func (*Cleaner) Clean

func (c *Cleaner) Clean()

Cleanup in LIFO order

func (*Cleaner) Push

func (c *Cleaner) Push(cf func())

Push cleanup function to stack

type Connector

type Connector interface {
	// Connect to the broker or attach to existing shared
	Connect(cf sputnik.ConfFactory, shared sputnik.ServerConnection) error

	// For shared connection - detach, for own - close
	Disconnect()
}

Connector provides possibility for negotiation between sputnik based software and external broker process

type MessageConsumer

type MessageConsumer interface {
	Connector

	// Receive event from broker, convert to sputnik.Msg
	// and send to another block
	Consume(sender sputnik.BlockCommunicator) error
}

type MessageProducer

type MessageProducer interface {
	Connector

	// Translate message to format of the broker and send it
	Produce(msg sputnik.Msg) error
}

type Runner

type Runner struct {
	// contains filtered or unexported fields
}

func StartRunner

func StartRunner(confFolder string, cntr sputnik.ServerConnector) (*Runner, error)

func (*Runner) Start

func (rnr *Runner) Start(ri *runnerInfo) error

func (*Runner) Stop

func (rnr *Runner) Stop()

func (*Runner) Wait

func (rnr *Runner) Wait()