-
Notifications
You must be signed in to change notification settings - Fork 669
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
38 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Standalone packages | ||
|
||
The `pkg` directory (the current directory) contains a set of standalone packages that can be imported and used by external applications. The packages are specifically meant for the development of the Mainflux based back-end applications and implement common tasks needed by the programmatic operation of Mainflux platform. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Auth client | ||
|
||
Auth client package is used to identify a thing and authorize a thing's access to a channel. | ||
|
||
To identify a thing, you need a valid **thing key**. You retrieve thing's identity in the form of a **thing ID**. The latter is used in CRUD operations on things and their connections. | ||
|
||
To authorize a thing's access to a channel, you need a valid **thing ID** and a valid **channel ID**. If a thing is not connected to a channel, the auth client responds with an error. Otherwise, a *nil* value is returned, signaling the successful authorization. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Errors | ||
|
||
`errors` package serve to build an arbitrary long error chain in order to capture errors returned from nested service calls. | ||
|
||
`errors` package contains the custom Go `error` interface implementation, `Error`. You use the `Error` interface to **wrap** two errors in a containing error as well as to test recursively if a given error **contains** some other error. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Messaging | ||
|
||
`messaging` package defines `Publisher`, `Subscriber` and an aggregate `Pubsub` interface. | ||
|
||
`Subscriber` interface defines methods used to subscribe to a message broker such as MQTT or NATS. | ||
|
||
`Publisher` interface defines methods used to publish messages to a message broker such as MQTT or NATS. | ||
|
||
`Pubsub` interface is composed of `Publisher` and `Subscriber` interface and can be used to send messages to as well as to receive messages from a message broker. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Mainflux SDK kits | ||
|
||
This directory contains drivers for Mainflux HTTP API. Drivers facilitate system administration - CRUD operations on things, channels and their connections, i.e. provision of Mainflux entities. They can be used also for messaging. | ||
|
||
Drivers are written in different languages in order to enable the faster application development in the respective language. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# ULID identity provider | ||
|
||
ULID identity provider generates a universally unique lexicographically sortable, string encoded identifier, a 128-bit number, unique for all practical purposes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# UUID identity provider | ||
|
||
The UUID identity provider generates a random, universally unique identifier (UUID), unique for all practical purposes. |