common

package

v0.1.18 Latest Latest Go to latest Published: Apr 29, 2024 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type CommonAPI struct {
	Alerting     *alerting.Alerting
	APISecret    *jwt.HMACSHA
	ShutdownChan dtypes.ShutdownChan
}

CommonAPI api o

func NewCommonAPI(lr repo.LockedRepo, secret *jwt.HMACSHA, shutdownChan dtypes.ShutdownChan) (CommonAPI, error)

NewCommonAPI initializes a new CommonAPI

func (a *CommonAPI) AuthNew(ctx context.Context, payload *types.JWTPayload) (string, error)

AuthNew generates a new JWT token with the provided permissions

func (a *CommonAPI) AuthVerify(ctx context.Context, token string) (*types.JWTPayload, error)

AuthVerify verifies a JWT token and returns the permissions associated with it

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

Closing jsonrpc closing

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

Discover returns an OpenRPC document describing an RPC API.

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

LogAlerts returns an empty list of alerts

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

LogList returns a list of available logging subsystems

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

LogSetLevel sets the log level for a given subsystem

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

Session returns a UUID of api provider session

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

Shutdown trigger graceful shutdown

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

Version provides information about API provider

type SessionCallbackFunc func(string, string)

SessionCallbackFunc will be called after node connection