mirror of
https://github.com/grafana/grafana.git
synced 2024-11-30 04:34:23 -06:00
102 lines
3.1 KiB
Go
102 lines
3.1 KiB
Go
package models
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"time"
|
|
|
|
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
|
)
|
|
|
|
// ChannelPublisher writes data into a channel. Note that permissions are not checked.
|
|
type ChannelPublisher func(orgID int64, channel string, data []byte) error
|
|
|
|
// ChannelClientCount will return the number of clients for a channel
|
|
type ChannelClientCount func(orgID int64, channel string) (int, error)
|
|
|
|
// SubscribeEvent contains subscription data.
|
|
type SubscribeEvent struct {
|
|
Channel string
|
|
Path string
|
|
Data json.RawMessage
|
|
}
|
|
|
|
// SubscribeReply is a reaction to SubscribeEvent.
|
|
type SubscribeReply struct {
|
|
Presence bool
|
|
JoinLeave bool
|
|
Recover bool
|
|
Data json.RawMessage
|
|
}
|
|
|
|
// PublishEvent contains publication data.
|
|
type PublishEvent struct {
|
|
Channel string
|
|
Path string
|
|
Data json.RawMessage
|
|
}
|
|
|
|
// PublishReply is a reaction to PublishEvent.
|
|
type PublishReply struct {
|
|
// By default, it's a handler responsibility to publish data
|
|
// into a stream upon OnPublish but returning a data here
|
|
// will make Grafana Live publish data itself (i.e. stream handler
|
|
// just works as permission proxy in this case).
|
|
Data json.RawMessage
|
|
// HistorySize sets a stream history size.
|
|
HistorySize int
|
|
// HistoryTTL is a time that messages will live in stream history.
|
|
HistoryTTL time.Duration
|
|
}
|
|
|
|
// ChannelHandler defines the core channel behavior
|
|
type ChannelHandler interface {
|
|
// OnSubscribe is called when a client wants to subscribe to a channel
|
|
OnSubscribe(ctx context.Context, user *SignedInUser, e SubscribeEvent) (SubscribeReply, backend.SubscribeStreamStatus, error)
|
|
|
|
// OnPublish is called when a client writes a message to the channel websocket.
|
|
OnPublish(ctx context.Context, user *SignedInUser, e PublishEvent) (PublishReply, backend.PublishStreamStatus, error)
|
|
}
|
|
|
|
// ChannelHandlerFactory should be implemented by all core features.
|
|
type ChannelHandlerFactory interface {
|
|
// GetHandlerForPath gets a ChannelHandler for a path.
|
|
// This is called fast and often -- it must be synchronized
|
|
GetHandlerForPath(path string) (ChannelHandler, error)
|
|
}
|
|
|
|
// DashboardActivityChannel is a service to advertise dashboard activity
|
|
type DashboardActivityChannel interface {
|
|
// Called when a dashboard is saved -- this includes the error so we can support a
|
|
// gitops workflow that knows if the value was saved to the local database or not
|
|
// in many cases all direct save requests will fail, but the request should be forwarded
|
|
// to any gitops observers
|
|
DashboardSaved(orgID int64, user *UserDisplayDTO, message string, dashboard *Dashboard, err error) error
|
|
|
|
// Called when a dashboard is deleted
|
|
DashboardDeleted(orgID int64, user *UserDisplayDTO, uid string) error
|
|
|
|
// Experimental! Indicate is GitOps is active. This really means
|
|
// someone is subscribed to the `grafana/dashboards/gitops` channel
|
|
HasGitOpsObserver(orgID int64) bool
|
|
}
|
|
|
|
type LiveMessage struct {
|
|
Id int64
|
|
OrgId int64
|
|
Channel string
|
|
Data json.RawMessage
|
|
Published time.Time
|
|
}
|
|
|
|
type SaveLiveMessageQuery struct {
|
|
OrgId int64
|
|
Channel string
|
|
Data json.RawMessage
|
|
}
|
|
|
|
type GetLiveMessageQuery struct {
|
|
OrgId int64
|
|
Channel string
|
|
}
|