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 ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Start ¶
func Start(id string, subs ...Subscription) error
Start wires all provided subscriptions for the given id.
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 Subscription ¶ added in v0.40.0
Subscription is a self-contained function that registers a consumer for a given id.
func Alarms ¶ added in v0.40.0
func Alarms(sub messaging.AlarmSubscriber, c AlarmConsumer) Subscription
Alarms returns a Subscription that subscribes consumer as an AlarmConsumer.
func Messages ¶ added in v0.40.0
func Messages(sub messaging.Subscriber, c MessageConsumer, subjects ...string) Subscription
Messages returns a Subscription that subscribes consumer to the given subjects as a MessageConsumer.
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. |