readers

README

Readers

Readers provide an implementation of various message readers. Message readers are services that consume normalized (in SenML format) Mainflux messages from data storage and opens HTTP API for message consumption.

For an in-depth explanation of the usage of reader, as well as thorough understanding of Mainflux, please check out the official documentation.

Documentation

Index

• Variables
• type MessageRepository
• type MessagesPage

Variables

var ErrNotFound = errors.New("entity not found")

ErrNotFound indicates that requested entity doesn't exist.

Types

type MessageRepository

type MessageRepository interface {
	// ReadAll skips given number of messages for given channel and returns next
	// limited number of messages.
	ReadAll(chanID string, offset, limit uint64, query map[string]string) (MessagesPage, error)
}

MessageRepository specifies message reader API.

type MessagesPage

type MessagesPage struct {
	Total    uint64
	Offset   uint64
	Limit    uint64
	Messages []senml.Message
}

MessagesPage contains page related metadata as well as list of messages that belong to this page.