retained

Documentation

Index

• type IterateFn
• type Store

Types

type IterateFn

type IterateFn func(message *message.Message) bool

IterateFn is the callback function used by iterate() Return false means to stop the iteration.

type Store

type Store interface {
	// GetRetainedMessage returns the message that equals the passed topic.
	GetRetainedMessage(topicName string) *message.Message
	// ClearAll clears all retained messages.
	ClearAll()
	// AddOrReplace adds or replaces a retained message.
	AddOrReplace(message *message.Message)
	// Remove removes a retained message.
	Remove(topicName string)
	// GetMatchedMessages returns the retained messages that match the passed topic filter.
	GetMatchedMessages(topicFilter string) []*message.Message
	// Iterate all retained messages. The callback is called once for each message.
	// If callback return false, the iteration will be stopped.
	// Notice:
	// The results are not sorted in any way, no ordering of any kind is guaranteed.
	// This method will walk through all retained messages,
	// so this will be a expensive operation if there are a large number of retained messages.
	Iterate(fn IterateFn)
}

Store is the interface used by gmqtt.server and external logic to handler the operations of retained messages. User can get the implementation from gmqtt.Server interface. This interface provides the ability for extensions to interact with the retained message store. Notice: This methods will not trigger any gmqtt hooks.