README
¶
Consumers
Consumers provide an abstraction of various Mainflux consumers.
Mainflux consumer is a generic service that can handle received messages - consume them.
The message is not necessarily a Mainflux message - before consuming, Mainflux message can
be transformed into any valid format that specific consumer can understand. For example,
writers are consumers that can take a SenML or JSON message and store it.
Consumers are optional services and are treated as plugins. In order to run consumer services, core services must be up and running.
For an in-depth explanation of the usage of consumers, as well as thorough
understanding of Mainflux, please check out the official documentation.
For more information about service capabilities and its usage, please check out the API documentation.
Documentation
¶
Overview ¶
Package consumers contain the domain concept definitions needed to support Mainflux consumer services functionality.
Index ¶
- func Alarms(id string, sub messaging.AlarmSubscriber, c AlarmConsumer) error
- func Messages(id string, sub messaging.Subscriber, c MessageConsumer, subjects ...string) error
- func Notifications(id string, sub messaging.NotificationSubscriber, c NotificationConsumer, ...) error
- func Webhooks(id string, sub messaging.WebhookSubscriber, c WebhookConsumer) error
- type AlarmConsumer
- type MessageConsumer
- type NotificationConsumer
- type WebhookConsumer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Alarms ¶ added in v0.40.0
func Alarms(id string, sub messaging.AlarmSubscriber, c AlarmConsumer) error
Alarms subscribes the given AlarmConsumer to alarms.
func Messages ¶ added in v0.40.0
func Messages(id string, sub messaging.Subscriber, c MessageConsumer, subjects ...string) error
Messages subscribes the given MessageConsumer to the given subjects.
func Notifications ¶ added in v0.42.0
func Notifications(id string, sub messaging.NotificationSubscriber, c NotificationConsumer, subject string) error
Notifications subscribes the given NotificationConsumer to the given subject.
func Webhooks ¶ added in v0.42.0
func Webhooks(id string, sub messaging.WebhookSubscriber, c WebhookConsumer) error
Webhooks subscribes the given WebhookConsumer to webhook forwarding.
Types ¶
type AlarmConsumer ¶ added in v0.40.0
AlarmConsumer specifies an API for consuming protomfx.Alarm.
type MessageConsumer ¶ added in v0.40.0
MessageConsumer specifies an API for consuming protomfx.Message.
type NotificationConsumer ¶ added in v0.42.0
type NotificationConsumer interface {
ConsumeNotification(subject string, notification protomfx.Notification) error
}
NotificationConsumer specifies an API for consuming protomfx.Notification.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package notifiers contain the domain concept definitions needed to support Mainflux notifications functionality.
|
Package notifiers contain the domain concept definitions needed to support Mainflux notifications functionality. |
|
smpp
Package smpp contains the domain concept definitions needed to support Mainflux SMS notifications.
|
Package smpp contains the domain concept definitions needed to support Mainflux SMS notifications. |
|
smtp
Package smtp contains the domain concept definitions needed to support Mainflux SMTP notifications.
|
Package smtp contains the domain concept definitions needed to support Mainflux SMTP notifications. |
|
Package writers contain the domain concept definitions needed to support Mainflux writer services functionality.
|
Package writers contain the domain concept definitions needed to support Mainflux writer services functionality. |
|
postgres
Package postgres contains repository implementations using Postgres as the underlying database.
|
Package postgres contains repository implementations using Postgres as the underlying database. |
|
timescale
Package timescale contains repository implementations using Timescale as the underlying database.
|
Package timescale contains repository implementations using Timescale as the underlying database. |