mirror of
https://github.com/mainflux/mainflux.git
synced 2025-04-29 13:49:28 +08:00
a6a8648e4f
* Add can access by things ID endpoint to things service Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Add new auth endpoint to the swagger docs Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com> * Add test for the new endpoint of the things service Signed-off-by: Aleksandar Novakovic <anovakovic01@gmail.com>
84 lines
2.6 KiB
Go
84 lines
2.6 KiB
Go
//
|
|
// Copyright (c) 2018
|
|
// Mainflux
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
|
|
package things
|
|
|
|
// Channel represents a Mainflux "communication group". This group contains the
|
|
// things that can exchange messages between eachother.
|
|
type Channel struct {
|
|
ID string
|
|
Owner string
|
|
Name string
|
|
Metadata map[string]interface{}
|
|
}
|
|
|
|
// ChannelsPage contains page related metadata as well as list of channels that
|
|
// belong to this page.
|
|
type ChannelsPage struct {
|
|
PageMetadata
|
|
Channels []Channel
|
|
}
|
|
|
|
// ChannelRepository specifies a channel persistence API.
|
|
type ChannelRepository interface {
|
|
// Save persists the channel. Successful operation is indicated by unique
|
|
// identifier accompanied by nil error response. A non-nil error is
|
|
// returned to indicate operation failure.
|
|
Save(Channel) (string, error)
|
|
|
|
// Update performs an update to the existing channel. A non-nil error is
|
|
// returned to indicate operation failure.
|
|
Update(Channel) error
|
|
|
|
// RetrieveByID retrieves the channel having the provided identifier, that is owned
|
|
// by the specified user.
|
|
RetrieveByID(string, string) (Channel, error)
|
|
|
|
// RetrieveAll retrieves the subset of channels owned by the specified user.
|
|
RetrieveAll(string, uint64, uint64, string) (ChannelsPage, error)
|
|
|
|
// RetrieveByThing retrieves the subset of channels owned by the specified
|
|
// user and have specified thing connected to them.
|
|
RetrieveByThing(string, string, uint64, uint64) (ChannelsPage, error)
|
|
|
|
// Remove removes the channel having the provided identifier, that is owned
|
|
// by the specified user.
|
|
Remove(string, string) error
|
|
|
|
// Connect adds thing to the channel's list of connected things.
|
|
Connect(string, string, string) error
|
|
|
|
// Disconnect removes thing from the channel's list of connected
|
|
// things.
|
|
Disconnect(string, string, string) error
|
|
|
|
// HasThing determines whether the thing with the provided access key, is
|
|
// "connected" to the specified channel. If that's the case, it returns
|
|
// thing's ID.
|
|
HasThing(string, string) (string, error)
|
|
|
|
// HasThingByID determines whether the thing with the provided ID, is
|
|
// "connected" to the specified channel. If that's the case, then
|
|
// returned error will be nil.
|
|
HasThingByID(string, string) error
|
|
}
|
|
|
|
// ChannelCache contains channel-thing connection caching interface.
|
|
type ChannelCache interface {
|
|
// Connect channel thing connection.
|
|
Connect(string, string) error
|
|
|
|
// HasThing checks if thing is connected to channel.
|
|
HasThing(string, string) bool
|
|
|
|
// Disconnects thing from channel.
|
|
Disconnect(string, string) error
|
|
|
|
// Removes channel from cache.
|
|
Remove(string) error
|
|
}
|