messaging

type AlarmHandler interface {
	// Handle handles alarms passed by underlying implementation.
	Handle(subject string, alarm protomfx.Alarm) error

	// Cancel is used for cleanup during unsubscribing and it's optional.
	Cancel() error
}

type AlarmPublisher interface {
	// PublishAlarm publishes an alarm to the message broker.
	PublishAlarm(subject string, alarm protomfx.Alarm) error
}

type AlarmSubscriber interface {
	// SubscribeAlarms subscribes to the alarm stream.
	SubscribeAlarms(id string, handler AlarmHandler) error

	// UnsubscribeAlarms unsubscribes from the alarm stream.
	UnsubscribeAlarms(id string) error
}

type CommandHandler interface {
	// Handle handles commands passed by underlying implementation.
	Handle(subject string, cmd protomfx.Command) error

	// Cancel is used for cleanup during unsubscribing and it's optional.
	Cancel() error
}

type CommandPublisher interface {
	// PublishCommand publishes a command to the message broker.
	PublishCommand(subject string, cmd protomfx.Command) error
}

type CommandSubscriber interface {
	// SubscribeCommands subscribes to the command stream for the given topic.
	SubscribeCommands(id, topic string, handler CommandHandler) error

	// UnsubscribeCommands unsubscribes from the command stream for the given topic.
	UnsubscribeCommands(id, topic string) error
}

type MessageDispatcher interface {
	// Dispatch publishes msg to every subject enabled by the dispatcher flags in pc.
	Dispatch(msg protomfx.Message, pc *domain.ProfileConfig) error
}

type MessageHandler interface {
	// Handle handles messages passed by underlying implementation.
	Handle(subject string, msg protomfx.Message) error

	// Cancel is used for cleanup during unsubscribing and it's optional.
	Cancel() error
}

type NotificationHandler interface {
	// Handle handles notifications passed by underlying implementation.
	Handle(subject string, notification protomfx.Notification) error

	// Cancel is used for cleanup during unsubscribing and it's optional.
	Cancel() error
}

type NotificationPublisher interface {
	// PublishNotification publishes a notification to the message broker.
	PublishNotification(subject string, notification protomfx.Notification) error
}

type NotificationSubscriber interface {
	// SubscribeNotifications subscribes to the notification stream for the given topic.
	SubscribeNotifications(id, topic string, handler NotificationHandler) error

	// UnsubscribeNotifications unsubscribes from the notification stream for the given topic.
	UnsubscribeNotifications(id, topic string) error
}

type PubSub interface {
	Publisher
	Subscriber
}

type Publisher interface {
	// Publish publishes message to the message broker.
	Publish(subject string, msg protomfx.Message) error

	// Close gracefully closes message publisher's connection.
	Close() error
}

type Subscriber interface {
	// Subscribe subscribes to the message stream and consumes messages.
	Subscribe(id, topic string, handler MessageHandler) error

	// Unsubscribe unsubscribes from the message stream and
	// stops consuming messages.
	Unsubscribe(id, topic string) error

	// Close gracefully closes message subscriber's connection.
	Close() error
}

type WebhookHandler interface {
	// Handle handles webhook messages passed by underlying implementation.
	Handle(subject string, webhook protomfx.Webhook) error

	// Cancel is used for cleanup during unsubscribing and it's optional.
	Cancel() error
}

type WebhookPublisher interface {
	// PublishWebhook publishes a webhook message to the message broker.
	PublishWebhook(subject string, webhook protomfx.Webhook) error
}

type WebhookSubscriber interface {
	// SubscribeWebhooks subscribes to the webhook stream.
	SubscribeWebhooks(id string, handler WebhookHandler) error

	// UnsubscribeWebhooks unsubscribes from the webhook stream.
	UnsubscribeWebhooks(id string) error
}