plugin

Documentation

Index

• func ConfigureCLNPlugin[T MetricsPluginState](state T) (*cln4go.Plugin[T], error)
• func OnInit[T MetricsPluginState](plugin *cln4go.Plugin[T], request map[string]any) map[string]any
• type ForceUpdateRPC
  • func (instance *ForceUpdateRPC[T]) Call(plugin *cln4go.Plugin[T], payload map[string]any) (map[string]any, error)
• type LNMetricsCleanCacheRPC
  • func (self *LNMetricsCleanCacheRPC[T]) Call(plugin *cln4go.Plugin[T], payload map[string]any) (map[string]any, error)
• type LNMetricsInfoRPC
  • func (self *LNMetricsInfoRPC[T]) Call(plugin *cln4go.Plugin[T], payload map[string]any) (map[string]any, error)
• type MetricsPlugin
  • func (plugin *MetricsPlugin) CallOnStopOnMetrics(metric metrics.Metric, msg *metrics.Msg)
  • func (plugin *MetricsPlugin) CallUpdateOnMetric(metric metrics.Metric, msg *metrics.Msg)
  • func (self *MetricsPlugin) GetCron() *cron.Cron
  • func (self *MetricsPlugin) GetMetrics() map[int]metrics.Metric
  • func (self *MetricsPlugin) GetRpc() *cln4go.UnixRPC
  • func (self *MetricsPlugin) GetServer() *graphql.Client
  • func (self *MetricsPlugin) GetStorage() db.PluginDatabase
  • func (self *MetricsPlugin) IsWithProxy() bool
  • func (self *MetricsPlugin) NewClient(path string) error
  • func (plugin *MetricsPlugin) RegisterMetrics(id int, metric metrics.Metric) error
  • func (plugin *MetricsPlugin) RegisterOneTimeEvt(after string)
  • func (plugin *MetricsPlugin) RegisterRecurrentEvt(after string)
  • func (self *MetricsPlugin) SetProxy(withProxy bool)
  • func (self *MetricsPlugin) SetServer(server *graphql.Client)
  • func (self *MetricsPlugin) SetStorage(storage db.PluginDatabase)
• type MetricsPluginState
• type OnShoutdown
  • func (self *OnShoutdown[T]) Call(plugin *cln4go.Plugin[T], payload map[string]any)
• type RawLocalScoreRPC
  • func NewRawLocalScoreRPC[T MetricsPluginState]() *RawLocalScoreRPC[T]
  • func (instance *RawLocalScoreRPC[T]) Call(plugin *cln4go.Plugin[T], payload map[string]any) (map[string]any, error)

Functions

func ConfigureCLNPlugin

func ConfigureCLNPlugin[T MetricsPluginState](state T) (*cln4go.Plugin[T], error)

func OnInit

func OnInit[T MetricsPluginState](plugin *cln4go.Plugin[T], request map[string]any) map[string]any

Types

type ForceUpdateRPC

type ForceUpdateRPC[T MetricsPluginState] struct{}

ForceUpdateRPC enable the force update command

func (*ForceUpdateRPC[T]) Call

func (instance *ForceUpdateRPC[T]) Call(plugin *cln4go.Plugin[T], payload map[string]any) (map[string]any, error)

type LNMetricsCleanCacheRPC

type LNMetricsCleanCacheRPC[T MetricsPluginState] struct{}

func (*LNMetricsCleanCacheRPC[T]) Call

func (self *LNMetricsCleanCacheRPC[T]) Call(plugin *cln4go.Plugin[T], payload map[string]any) (map[string]any, error)

type LNMetricsInfoRPC

type LNMetricsInfoRPC[T MetricsPluginState] struct{}

func (*LNMetricsInfoRPC[T]) Call

func (self *LNMetricsInfoRPC[T]) Call(plugin *cln4go.Plugin[T], payload map[string]any) (map[string]any, error)

type MetricsPlugin

type MetricsPlugin struct {
	Metrics   map[int]metrics.Metric
	Rpc       *cln4go.UnixRPC
	Cron      *cron.Cron
	Server    *graphql.Client
	Storage   db.PluginDatabase
	WithProxy bool
}

FIXME: move this to a generics to set the Client in this way we could support different implementation

func (*MetricsPlugin) CallOnStopOnMetrics

func (plugin *MetricsPlugin) CallOnStopOnMetrics(metric metrics.Metric, msg *metrics.Msg)

callOnStopOnMetrics Call on stop operation on the node when the caller are shutdown itself.

func (*MetricsPlugin) CallUpdateOnMetric

func (plugin *MetricsPlugin) CallUpdateOnMetric(metric metrics.Metric, msg *metrics.Msg)

nolint

func (*MetricsPlugin) GetCron

func (self *MetricsPlugin) GetCron() *cron.Cron

func (*MetricsPlugin) GetMetrics

func (self *MetricsPlugin) GetMetrics() map[int]metrics.Metric

func (*MetricsPlugin) GetRpc

func (self *MetricsPlugin) GetRpc() *cln4go.UnixRPC

func (*MetricsPlugin) GetServer

func (self *MetricsPlugin) GetServer() *graphql.Client

func (*MetricsPlugin) GetStorage

func (self *MetricsPlugin) GetStorage() db.PluginDatabase

func (*MetricsPlugin) IsWithProxy

func (self *MetricsPlugin) IsWithProxy() bool

func (*MetricsPlugin) NewClient

func (self *MetricsPlugin) NewClient(path string) error

func (*MetricsPlugin) RegisterMetrics

func (plugin *MetricsPlugin) RegisterMetrics(id int, metric metrics.Metric) error

func (*MetricsPlugin) RegisterOneTimeEvt

func (plugin *MetricsPlugin) RegisterOneTimeEvt(after string)

func (*MetricsPlugin) RegisterRecurrentEvt

func (plugin *MetricsPlugin) RegisterRecurrentEvt(after string)

RegisterRecurrentEvt Register internal recurrent methods

func (*MetricsPlugin) SetProxy

func (self *MetricsPlugin) SetProxy(withProxy bool)

func (*MetricsPlugin) SetServer

func (self *MetricsPlugin) SetServer(server *graphql.Client)

func (*MetricsPlugin) SetStorage

func (self *MetricsPlugin) SetStorage(storage db.PluginDatabase)

type MetricsPluginState

type MetricsPluginState interface {
	GetRpc() *cln4go.UnixRPC

	NewClient(path string) error

	SetStorage(storage pluginDB.PluginDatabase)

	GetStorage() pluginDB.PluginDatabase

	RegisterOneTimeEvt(after string)

	RegisterMetrics(id int, metrics metrics.Metric) error

	SetProxy(withProxy bool)

	IsWithProxy() bool

	SetServer(server *graphql.Client)

	GetServer() *graphql.Client

	GetCron() *cron.Cron

	CallOnStopOnMetrics(metric metrics.Metric, msg *metrics.Msg)

	CallUpdateOnMetric(metric metrics.Metric, msg *metrics.Msg)

	GetMetrics() map[int]metrics.Metric
}

type OnShoutdown

type OnShoutdown[T MetricsPluginState] struct{}

func (*OnShoutdown[T]) Call

func (self *OnShoutdown[T]) Call(plugin *cln4go.Plugin[T], payload map[string]any)

type RawLocalScoreRPC

type RawLocalScoreRPC[T MetricsPluginState] struct{}

func NewRawLocalScoreRPC

func NewRawLocalScoreRPC[T MetricsPluginState]() *RawLocalScoreRPC[T]

func (*RawLocalScoreRPC[T]) Call

func (instance *RawLocalScoreRPC[T]) Call(plugin *cln4go.Plugin[T], payload map[string]any) (map[string]any, error)