module

Documentation

Index

• func Initialize(cfg *Config)
• func ProcessIQ(iq *xmpp.IQ, stm stream.C2S)
• func Shutdown()
• type Config
  • func (cfg *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type IQHandler
• type Mods
  • func Modules() Mods
• type Module

Functions

func Initialize

func Initialize(cfg *Config)

Initialize initializes module component.

func ProcessIQ

func ProcessIQ(iq *xmpp.IQ, stm stream.C2S)

ProcessIQ process a module IQ returning 'service unavailable' in case it can't be properly handled.

func Shutdown

func Shutdown()

Shutdown shuts down module sub system stopping every active module.

Types

type Config

type Config struct {
	Enabled      map[string]struct{}
	Roster       roster.Config
	Offline      offline.Config
	Registration xep0077.Config
	Version      xep0092.Config
	Ping         xep0199.Config
}

Config represents C2S modules configuration.

func (*Config) UnmarshalYAML

func (cfg *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML satisfies Unmarshaler interface.

type IQHandler

type IQHandler interface {
	Module

	// MatchesIQ returns whether or not an IQ should be
	// processed by the module.
	MatchesIQ(iq *xmpp.IQ) bool

	// ProcessIQ processes a module IQ taking according actions
	// over the associated stream.
	ProcessIQ(iq *xmpp.IQ, stm stream.C2S)
}

IQHandler represents an IQ handler module.

type Mods

type Mods struct {
	Roster       *roster.Roster
	Offline      *offline.Offline
	LastActivity *xep0012.LastActivity
	Private      *xep0049.Private
	DiscoInfo    *xep0030.DiscoInfo
	VCard        *xep0054.VCard
	Register     *xep0077.Register
	Version      *xep0092.Version
	BlockingCmd  *xep0191.BlockingCommand
	Ping         *xep0199.Ping
	// contains filtered or unexported fields
}

Mods structure keeps reference to all active modules.

func Modules

func Modules() Mods

Modules returns current active modules.

type Module

type Module interface {
}

Module represents a generic XMPP module.