c2smodel

Documentation

Index

• type Info
• type InfoMap
  • func NewInfoMap() *InfoMap
  • func NewInfoMapFromInfo(inf Info) *InfoMap
  • func NewInfoMapFromMap(m map[string]string) *InfoMap
  • func (im *InfoMap) Bool(k string) bool
  • func (im *InfoMap) Float(k string) float64
  • func (im *InfoMap) Int(k string) int
  • func (im *InfoMap) Map() map[string]string
  • func (im *InfoMap) ReadOnly() Info
  • func (im *InfoMap) SetBool(k string, v bool)
  • func (im *InfoMap) SetFloat(k string, v float64)
  • func (im *InfoMap) SetInt(k string, v int)
  • func (im *InfoMap) SetString(k, v string)
  • func (im *InfoMap) String(k string) string
• type ResourceDesc
  • func NewResourceDesc(instanceID string, jd *jid.JID, pr *stravaganza.Presence, inf Info) ResourceDesc

Types

type Info

type Info interface {
	// String returns string value associated to k key.
	String(k string) string

	// Bool returns bool value associated to k key.
	Bool(k string) bool

	// Int returns int value associated to k key.
	Int(k string) int

	// Float returns float64 value associated to k key.
	Float(k string) float64

	// Map returns map info set copy.
	Map() map[string]string
}

Info represents C2S immutable info set.

type InfoMap

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

InfoMap represents a mutable c2s info set.

func NewInfoMap

func NewInfoMap() *InfoMap

NewInfoMap returns an empty mutable info set.

func NewInfoMapFromInfo

func NewInfoMapFromInfo(inf Info) *InfoMap

NewInfoMapFromInfo returns a mutable info set derived from a read-only info map.

func NewInfoMapFromMap

func NewInfoMapFromMap(m map[string]string) *InfoMap

NewInfoMapFromMap returns a mutable info set of derived from m.

func (*InfoMap) Bool

func (im *InfoMap) Bool(k string) bool

func (*InfoMap) Float

func (im *InfoMap) Float(k string) float64

func (*InfoMap) Int

func (im *InfoMap) Int(k string) int

func (*InfoMap) Map

func (im *InfoMap) Map() map[string]string

func (*InfoMap) ReadOnly

func (im *InfoMap) ReadOnly() Info

ReadOnly returns a read-only info map reference.

func (*InfoMap) SetBool

func (im *InfoMap) SetBool(k string, v bool)

SetBool sets a boolean info value.

func (*InfoMap) SetFloat

func (im *InfoMap) SetFloat(k string, v float64)

SetFloat sets a float info value.

func (*InfoMap) SetInt

func (im *InfoMap) SetInt(k string, v int)

SetInt sets an integer info value.

func (*InfoMap) SetString

func (im *InfoMap) SetString(k, v string)

SetString sets a string info value.

func (*InfoMap) String

func (im *InfoMap) String(k string) string

type ResourceDesc

type ResourceDesc interface {
	// InstanceID specifies the instance identifier that registered the resource.
	InstanceID() string

	// JID returns the resource associated JID value.
	JID() *jid.JID

	// Presence returns the resource associated presence stanza.
	Presence() *stravaganza.Presence

	// Info returns resource registered info.
	Info() Info

	// IsAvailable returns presence available value.
	IsAvailable() bool

	// Priority returns resource presence priority.
	Priority() int8
}

ResourceDesc represents read-only a resource description.

func NewResourceDesc

func NewResourceDesc(instanceID string, jd *jid.JID, pr *stravaganza.Presence, inf Info) ResourceDesc

NewResourceDesc initializes and returns a read-only resource description.