focus

Documentation

Overview

Package focus provides a gRPC service for raising the application.

Index

• Constants
• func TryRaise(settingsPath string) bool
• func TryVersion(settingsPath string) (*semver.Version, bool)
• type Service
  • func NewService(locator service.Locator, version *semver.Version, ...) (*Service, error)
  • func (service *Service) Close()
  • func (service *Service) GetRaiseCh() <-chan struct{}
  • func (service *Service) Raise(_ context.Context, reason *wrapperspb.StringValue) (*emptypb.Empty, error)
  • func (service *Service) Version(context.Context, *emptypb.Empty) (*proto.VersionResponse, error)

Constants

const (
	Host = "127.0.0.1"
)

Functions

func TryRaise

func TryRaise(settingsPath string) bool

TryRaise tries to raise the application by dialing the focus service. It returns true if the service is running and the application was told to raise.

func TryVersion

func TryVersion(settingsPath string) (*semver.Version, bool)

TryVersion tries to determine the version of the running application instance. It returns the version and true if the version could be determined.

Types

type Service

type Service struct {
	proto.UnimplementedFocusServer
	// contains filtered or unexported fields
}

Service is a gRPC service that can be used to raise the application.

func NewService

func NewService(locator service.Locator, version *semver.Version, panicHandler async.PanicHandler) (*Service, error)

NewService creates a new focus service. It listens on the local host and port 1042 (by default).

func (*Service) Close

func (service *Service) Close()

Close closes the service.

func (*Service) GetRaiseCh

func (service *Service) GetRaiseCh() <-chan struct{}

GetRaiseCh returns a channel on which events are sent when the application should be raised.

func (*Service) Raise

func (service *Service) Raise(_ context.Context, reason *wrapperspb.StringValue) (*emptypb.Empty, error)

Raise implements the gRPC FocusService interface; it raises the application.

func (*Service) Version

func (service *Service) Version(context.Context, *emptypb.Empty) (*proto.VersionResponse, error)

Version implements the gRPC FocusService interface; it returns the version of the service.