Files
ca/Documentation/api/server_service_status.md
dissoupovandGitHub 4667e96e3f Upgrade deps (#4)
* Update docs

* Upgrade deps
2026-10-16 16:34:15 -05:00

3.5 KiB

status

import "github.com/effective-security/trustyca/server/service/status"

Index

Constants

ServiceName provides the Service Name for this package

const ServiceName = "status"

func Factory

func Factory(server gserver.GServer) any

Factory returns a factory of the service

type Service

Service defines the Status service

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

func (*Service) Close

func (s *Service) Close()

Close the subservices and its resources

func (*Service) IsReady

func (s *Service) IsReady() bool

IsReady indicates that the service is ready to serve its end-points

func (*Service) Name

func (s *Service) Name() string

Name returns the service name

func (*Service) RegisterGRPC

func (s *Service) RegisterGRPC(r *grpc.Server)

RegisterGRPC registers gRPC handler

func (*Service) RegisterRoute

func (s *Service) RegisterRoute(r restserver.Router)

RegisterRoute adds the Status API endpoints to the overall URL router

func (*Service) Server

func (s *Service) Server(_ context.Context, _ *emptypb.Empty) (*pb.ServerStatusResponse, error)

Server returns the server version.

func (*Service) Version

func (s *Service) Version(_ context.Context, _ *emptypb.Empty) (*pb.ServerVersion, error)

Version returns the server version.

Generated by gomarkdoc