roster

Documentation

Index

• type Config
• type Roster
  • func New(cfg *Config, shutdownCh <-chan struct{}) *Roster
  • func (r *Roster) MatchesIQ(iq *xmpp.IQ) bool
  • func (r *Roster) OnlinePresencesMatchingJID(j *jid.JID) []*xmpp.Presence
  • func (r *Roster) ProcessIQ(iq *xmpp.IQ, stm stream.C2S)
  • func (r *Roster) ProcessPresence(presence *xmpp.Presence)

Types

type Config

type Config struct {
	Versioning bool `yaml:"versioning"`
}

Config represents a roster configuration.

type Roster

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

Roster represents a roster server stream module.

func New

func New(cfg *Config, shutdownCh <-chan struct{}) *Roster

New returns a roster server stream module.

func (*Roster) MatchesIQ

func (r *Roster) MatchesIQ(iq *xmpp.IQ) bool

MatchesIQ returns whether or not an IQ should be processed by the roster module.

func (*Roster) OnlinePresencesMatchingJID

func (r *Roster) OnlinePresencesMatchingJID(j *jid.JID) []*xmpp.Presence

OnlinePresencesMatchingJID returns current online presences matching a given JID.

func (*Roster) ProcessIQ

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

ProcessIQ processes a roster IQ taking according actions over the associated stream.

func (*Roster) ProcessPresence

func (r *Roster) ProcessPresence(presence *xmpp.Presence)

ProcessPresence process an incoming roster presence.