module

Documentation

Index

• type Config
  • func (cfg *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type IQHandler
• type 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 *xml.IQ) bool

	// ProcessIQ processes a module IQ taking according actions
	// over the associated stream.
	ProcessIQ(iq *xml.IQ)
}

IQHandler represents an IQ handler module.

type Module

type Module interface {
	// RegisterDisco registers disco entity features and items
	// associated to the module.
	RegisterDisco(discoInfo *xep0030.DiscoInfo)
}

Module represents a generic XMPP module.