subscription

Documentation

Index

• Variables
• type Subscription
  • func (s *Subscription) Copy() *Subscription
  • func (s *Subscription) GetFullTopicName() string
  • func (s *Subscription) Validate() error

Variables

var (
	ErrInvalidTopicName      = errors.New("invalid topic name")
	ErrInvalidQos            = errors.New("invalid qos")
	ErrInvalidRetainHandling = errors.New("invalid retain handling")
)

Types

type Subscription

type Subscription struct {
	// ShareName is the share name of a shared subscription.
	// set to "" if it is a non-shared subscription.
	ShareName string
	// TopicFilter is the topic filter which does not include the share name.
	TopicFilter string
	// ID is the subscription identifier
	ID uint32

	// QoS is the qos level of the Subscription.
	QoS packet.QoS
	// NoLocal is the No Local option.
	NoLocal bool
	// RetainAsPublished is the Retain As Published option.
	RetainAsPublished bool
	// RetainHandling the Retain Handling option.
	RetainHandling byte
}

Subscription represents a subscription in lighthouse.

func (*Subscription) Copy

func (s *Subscription) Copy() *Subscription

Copy makes a copy of subscription.

func (*Subscription) GetFullTopicName

func (s *Subscription) GetFullTopicName() string

GetFullTopicName returns the full topic name of the subscription.

func (*Subscription) Validate

func (s *Subscription) Validate() error

Validate returns whether the subscription is valid. If you can ensure the subscription is valid then just skip the validation.