statusnotifyserver

Documentation

Index

• func GetStatusParameters(reg *pb.StatusRegistration) (string, string, []string, []string, []string)
• type StatusNotifyServer
  • func NewStatusNotifyServer(readyNotifyClientID string, sh StatusNotifyServerHelpers) *StatusNotifyServer
  • func (s *StatusNotifyServer) StatusDeregister(ctx context.Context, dereg *pb.StatusDeregistration) (*pb.StatusDeregistrationResponse, error)
  • func (s *StatusNotifyServer) StatusRegister(reg *pb.StatusRegistration, stream pb.StatusNotify_StatusRegisterServer) error
• type StatusNotifyServerHelpers

Functions

func GetStatusParameters

func GetStatusParameters(reg *pb.StatusRegistration) (string, string, []string, []string, []string)

GetStatusParameters retrieves the status query parameters from the StatusRegistration

Types

type StatusNotifyServer

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

StatusNotifyServer will be initialized by NewStatusNotifyServer() and its lifecycle is valid until all the clients unsubscribed the stream notification channel

func NewStatusNotifyServer

func NewStatusNotifyServer(readyNotifyClientID string, sh StatusNotifyServerHelpers) *StatusNotifyServer

NewStatusNotifyServer will create a new StatusNotifyServer and destroys the previous one

func (*StatusNotifyServer) StatusDeregister

func (s *StatusNotifyServer) StatusDeregister(ctx context.Context, dereg *pb.StatusDeregistration) (*pb.StatusDeregistrationResponse, error)

StatusDeregister will be called when the subscriber wants to terminate the stream

func (*StatusNotifyServer) StatusRegister

func (s *StatusNotifyServer) StatusRegister(reg *pb.StatusRegistration, stream pb.StatusNotify_StatusRegisterServer) error

StatusRegister gets notified when a client registers for a status notification stream for a given resource

type StatusNotifyServerHelpers

type StatusNotifyServerHelpers interface {
	GetAppContextId(ctx context.Context, reg *pb.StatusRegistration) (string, error)
	StatusQuery(ctx context.Context, reg *pb.StatusRegistration, qInstance, qType, qOutput string, qApps, qClusters, qResources []string) status.StatusResult
	PrepareStatusNotification(reg *pb.StatusRegistration, statusResult status.StatusResult) *pb.StatusNotification
}

StatusNotifyServerHelpers is an interface supported by the specific microservices that need to provide status notification