broadcast

type Broker interface {
	// Serve serves broker.
	Serve() error

	// close the consumption and disconnect broker.
	Stop()

	// Subscribe broker to one or multiple topics.
	Subscribe(upstream chan *Message, topics ...string) error

	// Unsubscribe broker from one or multiple topics.
	Unsubscribe(upstream chan *Message, topics ...string)

	// Broadcast one or multiple Messages.
	Broadcast(messages ...*Message) error
}

type Client struct {
	// contains filtered or unexported fields
}

type Command struct {
	// Cmd type.
	Cmd string `json:"cmd"`

	// Args contains command specific payload.
	Args json.RawMessage `json:"args"`
}

type CommandHandler func(ctx *ConnContext, cmd []byte)

type Config struct {
	// Path defines on this URL the middleware must be activated. Same path must be handled by underlying
	// application kernel to authorize the consumption. Optional.
	Path string

	// RedisConfig configures redis broker.
	Redis *RedisConfig
}

type ConnContext struct {
	// Upstream to push Messages into.
	Upstream chan *Message

	// Conn to the client.
	Conn *websocket.Conn

	// Topics contain list of currently subscribed topics.
	Topics []string
}

type ErrorEvent struct {
	// Conn specific to the error.
	Conn *websocket.Conn

	// Caused contains job specific error.
	Caused error
}

type Memory struct {
	// contains filtered or unexported fields
}

type Message struct {
	// Topic message been pushed into.
	Topic string `json:"topic"`

	// Payload to be broadcasted. Must be valid JSON.
	Payload json.RawMessage `json:"payload"`
}

type Redis struct {
	// contains filtered or unexported fields
}

type RedisConfig struct {
	Addr     string
	Password string
	DB       int
}

type Service struct {
	// contains filtered or unexported fields
}

type TopicEvent struct {
	// Conn associated with topics.
	Conn *websocket.Conn

	// Topics specific to event.
	Topics []string
}