pubsubmodel

package

v0.7.0 Latest Latest Go to latest Published: Dec 22, 2019 License: GPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ortuman/jackal

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Affiliation
- func (a *Affiliation) FromBytes(buf *bytes.Buffer) error
- func (a *Affiliation) ToBytes(buf *bytes.Buffer) error
type Item
- func (i *Item) FromBytes(buf *bytes.Buffer) error
- func (i *Item) ToBytes(buf *bytes.Buffer) error
type Node
- func (n *Node) FromBytes(buf *bytes.Buffer) error
- func (n *Node) ToBytes(buf *bytes.Buffer) error
type Options
- func NewOptionsFromMap(m map[string]string) (*Options, error)
- func NewOptionsFromSubmitForm(form *xep0004.DataForm) (*Options, error)
type Subscription
- func (s *Subscription) FromBytes(buf *bytes.Buffer) error
- func (s *Subscription) ToBytes(buf *bytes.Buffer) error

Constants ¶

View Source

const (
	Owner     = "owner"
	Member    = "member"
	Publisher = "publisher"
	Outcast   = "outcast"
)

affiliation definitions

View Source

const (
	None       = "none"
	Subscribed = "subscribed"
)

subscription definitions

View Source

const (
	Open             = "open"
	Presence         = "presence"
	Roster           = "roster"
	WhiteList        = "whitelist"
	Never            = "never"
	OnSub            = "on_sub"
	OnSubAndPresence = "on_sub_and_presence"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Affiliation ¶

type Affiliation struct {
	JID         string
	Affiliation string
}

Affiliation represents a pubsub affiliation

func (*Affiliation) FromBytes ¶

func (a *Affiliation) FromBytes(buf *bytes.Buffer) error

FromBytes deserializes a Affiliation entity from its binary representation.

func (*Affiliation) ToBytes ¶

func (a *Affiliation) ToBytes(buf *bytes.Buffer) error

ToBytes converts a Affiliation entity to its binary representation.

type Item ¶

type Item struct {
	ID        string
	Publisher string
	Payload   xmpp.XElement
}

Item represents a pubsub node item

func (*Item) FromBytes ¶

func (i *Item) FromBytes(buf *bytes.Buffer) error

FromBytes deserializes a Item entity from its binary representation.

func (*Item) ToBytes ¶

func (i *Item) ToBytes(buf *bytes.Buffer) error

ToBytes converts a Item entity to its binary representation.

type Node ¶

type Node struct {
	Host    string
	Name    string
	Options Options
}

Node represents a pubsub node

func (*Node) FromBytes ¶

func (n *Node) FromBytes(buf *bytes.Buffer) error

FromBytes deserializes a Node entity from its binary representation.

func (*Node) ToBytes ¶

func (n *Node) ToBytes(buf *bytes.Buffer) error

ToBytes converts a Node entity to its binary representation.

type Options ¶

type Options struct {
	Title                 string
	DeliverNotifications  bool
	DeliverPayloads       bool
	PersistItems          bool
	MaxItems              int64
	AccessModel           string
	SendLastPublishedItem string
	RosterGroupsAllowed   []string
	NotificationType      string
	NotifyConfig          bool
	NotifyDelete          bool
	NotifySub             bool
}

Options represents pubsub node configuration options

func NewOptionsFromMap ¶

func NewOptionsFromMap(m map[string]string) (*Options, error)

NewOptionsFromMap returns a new node Options instance derived from an input map.

func NewOptionsFromSubmitForm ¶

func NewOptionsFromSubmitForm(form *xep0004.DataForm) (*Options, error)

NewOptionsFromMap returns a new node Options instance derived from a submit form.

func (*Options) Form ¶

func (opt *Options) Form(rosterGroups []string) *xep0004.DataForm

Form returns Options form representation.

func (*Options) Map ¶

func (opt *Options) Map() (map[string]string, error)

Map returns Options map representation.

func (*Options) ResultForm ¶

func (opt *Options) ResultForm() *xep0004.DataForm

ResultForm returns Options result form representation.

type Subscription ¶

type Subscription struct {
	SubID        string
	JID          string
	Subscription string
}

Subscription represents a pubsub node subscription

func (*Subscription) FromBytes ¶

func (s *Subscription) FromBytes(buf *bytes.Buffer) error

FromBytes deserializes a Subscription entity from its binary representation.

func (*Subscription) ToBytes ¶

func (s *Subscription) ToBytes(buf *bytes.Buffer) error

ToBytes converts a Subscription entity to its binary representation.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL