xep0199

Documentation

Index

• type Config
• type Ping
  • func New(config *Config, stm stream.C2S) *Ping
  • func (x *Ping) MatchesIQ(iq *xml.IQ) bool
  • func (x *Ping) ProcessIQ(iq *xml.IQ)
  • func (x *Ping) RegisterDisco(discoInfo *xep0030.DiscoInfo)
  • func (x *Ping) ResetDeadline()
  • func (x *Ping) StartPinging()

Types

type Config

type Config struct {
	Send         bool `yaml:"send"`
	SendInterval int  `yaml:"send_interval"`
}

Config represents XMPP Ping module (XEP-0199) configuration.

type Ping

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

Ping represents a ping server stream module.

func New

func New(config *Config, stm stream.C2S) *Ping

New returns an ping IQ handler module.

func (*Ping) MatchesIQ

func (x *Ping) MatchesIQ(iq *xml.IQ) bool

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

func (*Ping) ProcessIQ

func (x *Ping) ProcessIQ(iq *xml.IQ)

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

func (*Ping) RegisterDisco

func (x *Ping) RegisterDisco(discoInfo *xep0030.DiscoInfo)

RegisterDisco registers disco entity features/items associated to ping module.

func (*Ping) ResetDeadline

func (x *Ping) ResetDeadline()

ResetDeadline resets send ping deadline.

func (*Ping) StartPinging

func (x *Ping) StartPinging()

StartPinging starts pinging peer every 'send interval' period.