topics

package

v1.2.3 Latest Latest Go to latest Published: Dec 10, 2022 License: MIT Imports: 2 Imported by: 0

Details

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

Repository

github.com/breezymind/comqtt

Links

Open Source Insights

Documentation ¶

Index ¶

type Index
- func New() *Index
type Leaf
type Subscriptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Index ¶

type Index struct {
	Root *Leaf // a leaf containing a message and more leaves.
	// contains filtered or unexported fields
}

Index is a prefix/trie tree containing topic subscribers and retained messages.

func New ¶

func New() *Index

New returns a pointer to a new instance of Index.

func (*Index) Scan ¶

func (x *Index) Scan(topic string) []string

Scan returns true if a matching filter exists

func (x *Index) Subscribe(filter string) bool

Subscribe creates a subscription filter for a client. Returns true if the subscription was new.

func (*Index) Unsubscribe ¶

func (x *Index) Unsubscribe(filter string) bool

Unsubscribe removes a subscription filter for a client. Returns true if an unsubscribe action successful and the subscription existed.

type Leaf ¶

type Leaf struct {
	Key    string           // the key that was used to create the leaf.
	Parent *Leaf            // a pointer to the parent node for the leaf.
	Leaves map[string]*Leaf // a map of child nodes, keyed on particle id.
	Filter string           // the path of the topic filter being matched.
	Count  int
}