presencehub

Documentation

Index

• type AvailablePresenceInfo
• type PresenceHub
  • func New(router *router.Router) *PresenceHub
  • func (x *PresenceHub) AvailablePresencesMatchingJID(j *jid.JID) []AvailablePresenceInfo
  • func (x *PresenceHub) MatchesIQ(iq *xmpp.IQ) bool
  • func (x *PresenceHub) ProcessIQ(iq *xmpp.IQ)
  • func (x *PresenceHub) RegisterPresence(presence *xmpp.Presence) (err error, alreadyRegistered bool)
  • func (x *PresenceHub) Shutdown() error
  • func (x *PresenceHub) UnregisterPresence(presence *xmpp.Presence)

Types

type AvailablePresenceInfo

type AvailablePresenceInfo struct {
	Presence *xmpp.Presence
	Caps     *model.Capabilities
}

AvailablePresenceInfo contains an active presence reference along with its capabilities.

type PresenceHub

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

PresenceHub represents global presence hub

func New

func New(router *router.Router) *PresenceHub

New returns a new presence hub instance.

func (*PresenceHub) AvailablePresencesMatchingJID

func (x *PresenceHub) AvailablePresencesMatchingJID(j *jid.JID) []AvailablePresenceInfo

AvailablePresencesMatchingJID returns current online presences matching a given JID.

func (*PresenceHub) MatchesIQ

func (x *PresenceHub) MatchesIQ(iq *xmpp.IQ) bool

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

func (*PresenceHub) ProcessIQ

func (x *PresenceHub) ProcessIQ(iq *xmpp.IQ)

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

func (*PresenceHub) RegisterPresence

func (x *PresenceHub) RegisterPresence(presence *xmpp.Presence) (err error, alreadyRegistered bool)

RegisterPresence keeps track of a new client presence, requesting capabilities when necessary.

func (*PresenceHub) Shutdown

func (x *PresenceHub) Shutdown() error

Shutdown shuts down blocking module.

func (*PresenceHub) UnregisterPresence

func (x *PresenceHub) UnregisterPresence(presence *xmpp.Presence)

UnregisterPresence removes a presence from the hub.