impl

Documentation

Index

• type StatusRestService
  • func NewStatusRestService() *StatusRestService
• type StatusService
  • func NewStatusService() *StatusService
  • func (st *StatusService) GetGlobalServiceStatus(ctx context.Context, empty *common.EmptyMessage) (*status.ServerStatusMessage, error)
  • func (st *StatusService) GetServerTime(ctx context.Context, empty *common.EmptyMessage) (*status.ServerTimeMessage, error)
  • func (st *StatusService) GetVersion(ctx context.Context, empty *common.EmptyMessage) (*common.Version, error)

Types

type StatusRestService

type StatusRestService struct {
	restMw.FuncRestService
}

func NewStatusRestService

func NewStatusRestService() *StatusRestService

type StatusService

type StatusService struct {
	middleware.FuncGrpcService
}

StatusService provides a service that offers basic status functionality: - Time -> returns UTC epoch time in nanoseconds precision - Version -> returns the current version of the service - Status -> returns the current status of the service

func NewStatusService

func NewStatusService() *StatusService

func (*StatusService) GetGlobalServiceStatus

func (st *StatusService) GetGlobalServiceStatus(ctx context.Context, empty *common.EmptyMessage) (*status.ServerStatusMessage, error)

func (*StatusService) GetServerTime

func (st *StatusService) GetServerTime(ctx context.Context, empty *common.EmptyMessage) (*status.ServerTimeMessage, error)

GetServerTime returns the current UTC server time in nanoseconds

func (*StatusService) GetVersion

func (st *StatusService) GetVersion(ctx context.Context, empty *common.EmptyMessage) (*common.Version, error)

GetVersion returns the current API Version. It is a direct mapping from go-version "github.com/hashicorp/go-version.Version