subscription

package

v0.9.0 Latest Latest Go to latest Published: Nov 14, 2023 License: MIT Imports: 8 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/waku-org/go-waku

Documentation ¶

Index ¶

Variables
type PeerContentFilter
type PeerSubscription
type SubscriptionDetails
type SubscriptionSet
type SubscriptionsMap
- func NewSubscriptionMap(logger *zap.Logger) *SubscriptionsMap

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNotFound = errors.New("not found")

Functions ¶

This section is empty.

Types ¶

type PeerContentFilter ¶ added in v0.9.0

type PeerContentFilter struct {
	PeerID        peer.ID  `json:"peerID"`
	PubsubTopic   string   `json:"pubsubTopics"`
	ContentTopics []string `json:"contentTopics"`
}

type PeerSubscription ¶

type PeerSubscription struct {
	PeerID             peer.ID
	SubsPerPubsubTopic map[string]SubscriptionSet
}

type SubscriptionDetails ¶

type SubscriptionDetails struct {
	sync.RWMutex

	ID string `json:"subscriptionID"`

	Closed bool `json:"-"`

	PeerID        peer.ID                 `json:"peerID"`
	ContentFilter protocol.ContentFilter  `json:"contentFilters"`
	C             chan *protocol.Envelope `json:"-"`
	// contains filtered or unexported fields
}

func (*SubscriptionDetails) Add ¶

func (s *SubscriptionDetails) Add(contentTopics ...string)

func (*SubscriptionDetails) Close ¶

func (s *SubscriptionDetails) Close() error

func (*SubscriptionDetails) CloseC ¶

func (s *SubscriptionDetails) CloseC()

func (*SubscriptionDetails) MarshalJSON ¶

func (s *SubscriptionDetails) MarshalJSON() ([]byte, error)

func (*SubscriptionDetails) Remove ¶

func (s *SubscriptionDetails) Remove(contentTopics ...string)

type SubscriptionSet ¶

type SubscriptionSet map[string]*SubscriptionDetails

Map of SubscriptionDetails.ID to subscriptions

type SubscriptionsMap ¶

type SubscriptionsMap struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewSubscriptionMap ¶

func NewSubscriptionMap(logger *zap.Logger) *SubscriptionsMap

func (*SubscriptionsMap) Clear ¶

func (sub *SubscriptionsMap) Clear()

func (*SubscriptionsMap) Delete ¶

func (sub *SubscriptionsMap) Delete(subscription *SubscriptionDetails) error

func (*SubscriptionsMap) GetSubscription ¶ added in v0.9.0

func (m *SubscriptionsMap) GetSubscription(peerID peer.ID, contentFilter protocol.ContentFilter) ([]peer.ID, []*SubscriptionDetails)

func (*SubscriptionsMap) Has ¶

func (sub *SubscriptionsMap) Has(peerID peer.ID, cf protocol.ContentFilter) bool

Check if we have subscriptions for all (pubsubTopic, contentTopics[i]) pairs provided

func (*SubscriptionsMap) IsListening ¶ added in v0.9.0

func (m *SubscriptionsMap) IsListening(pubsubTopic, contentTopic string) bool

func (*SubscriptionsMap) IsSubscribedTo ¶

func (sub *SubscriptionsMap) IsSubscribedTo(peerID peer.ID) bool

func (*SubscriptionsMap) NewSubscription ¶

func (sub *SubscriptionsMap) NewSubscription(peerID peer.ID, cf protocol.ContentFilter) *SubscriptionDetails

func (*SubscriptionsMap) Notify ¶

func (sub *SubscriptionsMap) Notify(peerID peer.ID, envelope *protocol.Envelope)

Source Files ¶

View all Source files

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