pubsub

type Broadcaster interface {
	GetDriver(key string) (SubReader, error)
}

type Constructor interface {
	PubSubFromConfig(key string) (PubSub, error)
}

type Message struct {
	// Topic (channel in terms of redis)
	Topic string `json:"topic"`
	// Payload (on some decode stages might be represented as base64 string)
	Payload []byte `json:"payload"`
}

type PubSub interface {
	Publisher
	Subscriber
	Reader
}

type Publisher interface {
	// Publish one or multiple Channel.
	Publish(message *Message) error

	// PublishAsync publish message and return immediately
	// If error occurred it will be printed into the logger
	PublishAsync(message *Message)
}

type Reader interface {
	Next(ctx context.Context) (*Message, error)
}

type SubReader interface {
	Subscriber
	Reader
}

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{})

	// Stop used to stop the driver and free up the connection
	Stop()
}