xep0199

package

v0.3.5 Latest Latest Go to latest Published: Nov 9, 2018 License: GPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	Send         bool
	SendInterval time.Duration
}

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

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

UnmarshalYAML satisfies Unmarshaler interface.

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

Ping represents a ping server stream module.

func New(config *Config, disco *xep0030.DiscoInfo) (*Ping, chan<- chan bool)

New returns an ping IQ handler module.

func (x *Ping) CancelPing(stm stream.C2S)

CancelPing cancels a previous scheduled ping.

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

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

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

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

func (x *Ping) SchedulePing(stm stream.C2S)

SchedulePing schedules a new ping in a 'send interval' period, cancelling previous scheduled ping.