application

Documentation

Index

• func NewContext(ctx context.Context, s Application) context.Context
• type App
  • func New(opts ...Option) *App
  • func (a *App) Endpoint() []string
  • func (a *App) GrpcServer() *grpc.Server
  • func (a *App) HttpServer() *http.Server
  • func (a *App) ID() string
  • func (a *App) Metadata() map[string]string
  • func (a *App) Name() string
  • func (a *App) Run() error
  • func (a *App) Stop() error
  • func (a *App) Version() string
• type Application
  • func FromContext(ctx context.Context) (s Application, ok bool)
• type Option
  • func Context(ctx context.Context) Option
  • func Endpoint(endpoints ...*url.URL) Option
  • func GrpcServer(srv *grpc.Server) Option
  • func HttpServer(srv *http.Server) Option
  • func ID(id string) Option
  • func Logger(logger zlog.Logger) Option
  • func Metadata(md map[string]string) Option
  • func Name(name string) Option
  • func Registrar(r registry.Registrar) Option
  • func Server(srv ...transport.Server) Option
  • func Signal(sigs ...os.Signal) Option
  • func Version(version string) Option

Functions

func NewContext

func NewContext(ctx context.Context, s Application) context.Context

NewContext returns a new Context that carries value.

Types

type App

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

App is an application components lifecycle manager.

func New

func New(opts ...Option) *App

New create an application lifecycle manager.

func (*App) Endpoint

func (a *App) Endpoint() []string

Endpoint returns endpoints.

func (*App) GrpcServer

func (a *App) GrpcServer() *grpc.Server

func (*App) HttpServer

func (a *App) HttpServer() *http.Server

func (*App) ID

func (a *App) ID() string

ID returns app instance id.

func (*App) Metadata

func (a *App) Metadata() map[string]string

Metadata returns service metadata.

func (*App) Name

func (a *App) Name() string

Name returns service name.

func (*App) Run

func (a *App) Run() error

Run executes all OnStart hooks registered with the application's Lifecycle.

func (*App) Stop

func (a *App) Stop() error

Stop gracefully stops the application.

func (*App) Version

func (a *App) Version() string

Version returns app version.

type Application

type Application interface {
	ID() string
	Name() string
	Version() string
	Metadata() map[string]string
	Endpoint() []string
	GrpcServer() *grpc.Server
	HttpServer() *http.Server
}

Application

func FromContext

func FromContext(ctx context.Context) (s Application, ok bool)

FromContext returns the Transport value stored in ctx, if any.

type Option

type Option func(o *options)

Option is an application option.

func Context

func Context(ctx context.Context) Option

Context with service context.

func Endpoint

func Endpoint(endpoints ...*url.URL) Option

Endpoint with service endpoint.

func GrpcServer

func GrpcServer(srv *grpc.Server) Option

func HttpServer

func HttpServer(srv *http.Server) Option

func ID

func ID(id string) Option

ID with service id.

func Logger

func Logger(logger zlog.Logger) Option

Logger with service logger.

func Metadata

func Metadata(md map[string]string) Option

Metadata with service metadata.

func Name

func Name(name string) Option

Name with service name.

func Registrar

func Registrar(r registry.Registrar) Option

Registrar with service registry.

func Server

func Server(srv ...transport.Server) Option

Server with transport servers.

func Signal

func Signal(sigs ...os.Signal) Option

Signal with exit signals.

func Version

func Version(version string) Option

Version with service version.