pubsub

Documentation

Index

• type PubSub
• type Publisher
• type Reader
• type Subscriber

Types

type PubSub

type PubSub interface {
	Publisher
	Subscriber
	Reader
}

PubSub interface designed to implement on any storage type to provide pub-sub abilities Publisher used to receive messages from the PHP app via RPC Subscriber should be implemented to subscribe to a topics and provide a connections list per topic Reader return next message from the channel

type Publisher

type Publisher interface {
	// Publish one or multiple Channel.
	Publish(messages []byte) error

	// PublishAsync publish message and return immediately
	// If error occurred it will be printed into the logger
	PublishAsync(messages []byte)
}

Publisher publish one or more messages BETA interface

type Reader

type Reader interface {
	Next() (*websocketsv1.Message, error)
}

Reader interface should return next message

type Subscriber

type Subscriber interface {
	// Subscribe broker to one or multiple topics.
	Subscribe(connectionID string, topics ...string) error

	// Unsubscribe from one or multiply topics
	Unsubscribe(connectionID string, topics ...string) error

	// Connections returns all connections associated with the particular topic
	Connections(topic string, ret map[string]struct{})
}

Subscriber defines the ability to operate as message passing broker. BETA interface