dashboard

Documentation

Index

• type Api
• type Bucket
• type Dashboard
  • func New(p *project.Project, envMap map[string]string) (*Dashboard, error)
  • func (d *Dashboard) AddBucket(name string)
  • func (d *Dashboard) AddWebsocketInfoMessage(socket string, message WebsocketMessage) error
  • func (d *Dashboard) GetPort() int
  • func (d *Dashboard) HasStarted() bool
  • func (d *Dashboard) Refresh(opts *RefreshOptions) error
  • func (d *Dashboard) RefreshHistory(_ *history.HistoryRecord) error
  • func (d *Dashboard) Serve(storagePlugin storage.StorageService, noBrowser bool) error
  • func (d *Dashboard) SetConnected(connected bool)
  • func (d *Dashboard) UpdateWebsocketInfoCount(socket string, count int) error
• type DashboardResponse
• type RefreshOptions
• type WebsocketInfo
• type WebsocketMessage

Types

type Api

type Api struct {
	Name    string                 `json:"name,omitempty"`
	OpenApi map[string]interface{} `json:"spec,omitempty"` // not sure which spec version yet
}

type Bucket

type Bucket struct {
	Name         string     `json:"name,omitempty"`
	CreationDate *time.Time `json:"creationDate,omitempty"`
}

type Dashboard

type Dashboard struct {
	// contains filtered or unexported fields
}

func New

func New(p *project.Project, envMap map[string]string) (*Dashboard, error)

func (*Dashboard) AddBucket

func (d *Dashboard) AddBucket(name string)

func (*Dashboard) AddWebsocketInfoMessage

func (d *Dashboard) AddWebsocketInfoMessage(socket string, message WebsocketMessage) error

func (*Dashboard) GetPort

func (d *Dashboard) GetPort() int

func (*Dashboard) HasStarted

func (d *Dashboard) HasStarted() bool

func (*Dashboard) Refresh

func (d *Dashboard) Refresh(opts *RefreshOptions) error

func (*Dashboard) RefreshHistory

func (d *Dashboard) RefreshHistory(_ *history.HistoryRecord) error

func (*Dashboard) Serve

func (d *Dashboard) Serve(storagePlugin storage.StorageService, noBrowser bool) error

func (*Dashboard) SetConnected

func (d *Dashboard) SetConnected(connected bool)

func (*Dashboard) UpdateWebsocketInfoCount

func (d *Dashboard) UpdateWebsocketInfoCount(socket string, count int) error

type DashboardResponse

type DashboardResponse struct {
	Apis                []*openapi3.T                    `json:"apis,omitempty"`
	Buckets             []string                         `json:"buckets,omitempty"`
	Schedules           []*codeconfig.TopicResult        `json:"schedules,omitempty"`
	Topics              []*codeconfig.TopicResult        `json:"topics,omitempty"`
	Websockets          []*codeconfig.WebsocketResult    `json:"websockets,omitempty"`
	ProjectName         string                           `json:"projectName,omitempty"`
	ApiAddresses        map[string]string                `json:"apiAddresses,omitempty"`
	WebsocketAddresses  map[string]string                `json:"websocketAddresses,omitempty"`
	TriggerAddress      string                           `json:"triggerAddress,omitempty"`
	StorageAddress      string                           `json:"storageAddress,omitempty"`
	BucketNotifications []*codeconfig.BucketNotification `json:"bucketNotifications,omitempty"`
	CurrentVersion      string                           `json:"currentVersion,omitempty"`
	LatestVersion       string                           `json:"latestVersion,omitempty"`
	Connected           bool                             `json:"connected"`
}

type RefreshOptions

type RefreshOptions struct {
	Pool               pool.WorkerPool
	TriggerAddress     string
	StorageAddress     string
	ApiAddresses       map[string]string
	WebSocketAddresses map[string]string
	ServiceListener    net.Listener
}

type WebsocketInfo

type WebsocketInfo struct {
	ConnectionCount int                `json:"connectionCount,omitempty"`
	Messages        []WebsocketMessage `json:"messages,omitempty"`
}

type WebsocketMessage

type WebsocketMessage struct {
	Data         string    `json:"data,omitempty"`
	Time         time.Time `json:"time,omitempty"`
	ConnectionID string    `json:"connectionId,omitempty"`
}