jackal

Documentation

Index

• type C2SConfig
• type ClusterConfig
  • func (c ClusterConfig) IsEnabled() bool
• type ComponentsConfig
• type Config
• type Jackal
  • func New(output io.Writer, args []string) *Jackal
  • func (j *Jackal) Run() error
• type LoggerConfig
• type ModulesConfig
• type S2SConfig

Types

type C2SConfig

type C2SConfig struct {
	Listeners c2s.ListenersConfig `fig:"listeners"`
}

C2SConfig defines C2S subsystem configuration.

type ClusterConfig

type ClusterConfig struct {
	Type   string               `fig:"type" default:"none"`
	KV     kv.Config            `fig:"kv"`
	Server clusterserver.Config `fig:"server"`
}

ClusterConfig defines cluster configuration.

func (ClusterConfig) IsEnabled

func (c ClusterConfig) IsEnabled() bool

IsEnabled tells whether cluster config is enabled.

type ComponentsConfig

type ComponentsConfig struct {
	Listeners xep0114.ListenersConfig `fig:"listeners"`
}

ComponentsConfig defines application components configuration.

type Config

type Config struct {
	MemoryBallastSize int `fig:"memory_ballast_size" default:"134217728"`

	Logger  LoggerConfig  `fig:"logger"`
	Cluster ClusterConfig `fig:"cluster"`

	HTTPPort int `fig:"http_port" default:"6060"`

	Peppers pepper.Config      `fig:"peppers"`
	Admin   adminserver.Config `fig:"admin"`
	Storage storage.Config     `fig:"storage"`
	Hosts   host.Configs       `fig:"hosts"`
	Shapers []shaper.Config    `fig:"shapers"`

	C2S        C2SConfig        `fig:"c2s"`
	S2S        S2SConfig        `fig:"s2s"`
	Components ComponentsConfig `fig:"components"`
	Modules    ModulesConfig    `fig:"modules"`
}

Config defines jackal application configuration.

type Jackal

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

Jackal is the root data structure for Jackal.

func New

func New(output io.Writer, args []string) *Jackal

New makes a new Jackal.

func (*Jackal) Run

func (j *Jackal) Run() error

Run starts Jackal running, and blocks until a Jackal stops.

type LoggerConfig

type LoggerConfig struct {
	Level  string `fig:"level" default:"debug"`
	Format string `fig:"format"`
}

LoggerConfig defines logger configuration.

type ModulesConfig

type ModulesConfig struct {
	// Enabled specifies total set of enabled modules
	Enabled []string `fig:"enabled"`

	// Offline: offline storage
	Offline offline.Config `fig:"offline"`

	// XEP-0092: Software Version
	Version xep0092.Config `fig:"version"`

	// XEP-0198: Stream Management
	Stream xep0198.Config `fig:"stream"`

	// XEP-0199: XMPP Ping
	Ping xep0199.Config `fig:"ping"`
}

ModulesConfig defines application modules configuration.

type S2SConfig

type S2SConfig struct {
	Listeners s2s.ListenersConfig `fig:"listeners"`
	Out       s2s.OutConfig       `fig:"out"`
}

S2SConfig defines S2S subsystem configuration.