gww

Documentation

Index

• Constants
• type GraffitiWallWriter
  • func NewGraffitiWallWriter(cfg *GraffitiWallWriterConfig) *GraffitiWallWriter
  • func (gww *GraffitiWallWriter) GetDescription() string
  • func (gww *GraffitiWallWriter) GetName() string
• type GraffitiWallWriterConfig
  • func NewConfig() *GraffitiWallWriterConfig
  • func (gww *GraffitiWallWriterConfig) GetContainerName() string
  • func (cfg *GraffitiWallWriterConfig) GetParameters() []config.IParameter
  • func (cfg *GraffitiWallWriterConfig) GetSubconfigs() map[string]config.IConfigSection
  • func (cfg *GraffitiWallWriterConfig) GetTitle() string

Constants

const (
	FolderName                     string             = "gww"
	ContainerID_GraffitiWallWriter config.ContainerID = "addon_gww"
	GraffitiFilename               string             = "graffiti.txt"
)

Types

type GraffitiWallWriter

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

func NewGraffitiWallWriter

func NewGraffitiWallWriter(cfg *GraffitiWallWriterConfig) *GraffitiWallWriter

func (*GraffitiWallWriter) GetDescription

func (gww *GraffitiWallWriter) GetDescription() string

func (*GraffitiWallWriter) GetName

func (gww *GraffitiWallWriter) GetName() string

type GraffitiWallWriterConfig

type GraffitiWallWriterConfig struct {
	Enabled config.Parameter[bool]

	InputUrl config.Parameter[string]

	UpdateWallTime config.Parameter[uint64]

	UpdateInputTime config.Parameter[uint64]

	UpdatePixelTime config.Parameter[uint64]

	// The Docker Hub tag
	ContainerTag config.Parameter[string]

	// Custom command line flags
	AdditionalFlags config.Parameter[string]
}

Configuration for the Graffiti Wall Writer

func NewConfig

func NewConfig() *GraffitiWallWriterConfig

Creates a new configuration instance

func (*GraffitiWallWriterConfig) GetContainerName

func (gww *GraffitiWallWriterConfig) GetContainerName() string

func (*GraffitiWallWriterConfig) GetParameters

func (cfg *GraffitiWallWriterConfig) GetParameters() []config.IParameter

Get the parameters for this config

func (*GraffitiWallWriterConfig) GetSubconfigs

func (cfg *GraffitiWallWriterConfig) GetSubconfigs() map[string]config.IConfigSection

Get the sections underneath this one

func (*GraffitiWallWriterConfig) GetTitle

func (cfg *GraffitiWallWriterConfig) GetTitle() string

Get the title for the config