common

Documentation

Index

• type CommonAPI
  • func (a *CommonAPI) AuthNew(ctx context.Context, perms []auth.Permission) ([]byte, error)
  • func (a *CommonAPI) AuthVerify(ctx context.Context, token string) ([]auth.Permission, error)
  • func (a *CommonAPI) Closing(ctx context.Context) (<-chan struct{}, error)
  • func (a *CommonAPI) Discover(ctx context.Context) (apitypes.OpenRPCDocument, error)
  • func (a *CommonAPI) LogAlerts(ctx context.Context) ([]alerting.Alert, error)
  • func (a *CommonAPI) LogList(context.Context) ([]string, error)
  • func (a *CommonAPI) LogSetLevel(ctx context.Context, subsystem, level string) error
  • func (a *CommonAPI) Session(ctx context.Context) (uuid.UUID, error)
  • func (a *CommonAPI) Shutdown(ctx context.Context) error
  • func (a *CommonAPI) StartTime(context.Context) (time.Time, error)
  • func (a *CommonAPI) Version(context.Context) (api.APIVersion, error)

Types

type CommonAPI

type CommonAPI struct {
	fx.In

	BuildVersion build.BuildVersion

	Alerting     *alerting.Alerting
	APISecret    *dtypes.APIAlg
	ShutdownChan dtypes.ShutdownChan

	Start dtypes.NodeStartTime
}

func (*CommonAPI) AuthNew

func (a *CommonAPI) AuthNew(ctx context.Context, perms []auth.Permission) ([]byte, error)

func (*CommonAPI) AuthVerify

func (a *CommonAPI) AuthVerify(ctx context.Context, token string) ([]auth.Permission, error)

func (*CommonAPI) Closing

func (a *CommonAPI) Closing(ctx context.Context) (<-chan struct{}, error)

func (*CommonAPI) Discover

func (a *CommonAPI) Discover(ctx context.Context) (apitypes.OpenRPCDocument, error)

func (*CommonAPI) LogAlerts

func (a *CommonAPI) LogAlerts(ctx context.Context) ([]alerting.Alert, error)

func (*CommonAPI) LogList

func (a *CommonAPI) LogList(context.Context) ([]string, error)

func (*CommonAPI) LogSetLevel

func (a *CommonAPI) LogSetLevel(ctx context.Context, subsystem, level string) error

func (*CommonAPI) Session

func (a *CommonAPI) Session(ctx context.Context) (uuid.UUID, error)

func (*CommonAPI) Shutdown

func (a *CommonAPI) Shutdown(ctx context.Context) error

func (*CommonAPI) StartTime

func (a *CommonAPI) StartTime(context.Context) (time.Time, error)

func (*CommonAPI) Version

func (a *CommonAPI) Version(context.Context) (api.APIVersion, error)