gaea

README

gaea

Gaea['dʒi:ə] 盖亚, 一个轻量级gRPC业务框架.

Documentation

Index

• Constants
• func Apply(opts ...Option) *options
• func NewContext(ctx context.Context, s AppInfo) context.Context
• type AppInfo
  • func FromContext(ctx context.Context) (s AppInfo, ok bool)
• type Gaea
  • func New(opts ...Option) *Gaea
  • func (g *Gaea) Endpoint() []string
  • func (g *Gaea) ID() string
  • func (g *Gaea) Metadata() map[string]string
  • func (g *Gaea) Name() string
  • func (g *Gaea) RegisterServer(servers ...server.Server)
  • func (g *Gaea) Run() error
  • func (g *Gaea) Stop() (err error)
  • func (g *Gaea) Version() string
• type Option
  • func AfterStart(fn func(context.Context) error) Option
  • func AfterStop(fn func(context.Context) error) Option
  • func BeforeStart(fn func(context.Context) error) Option
  • func BeforeStop(fn func(context.Context) error) Option
  • func WithContext(ctx context.Context) Option
  • func WithEndpoint(endpoints ...*url.URL) Option
  • func WithID(id string) Option
  • func WithMetadata(md map[string]string) Option
  • func WithName(name string) Option
  • func WithRegistry(r registry.Registry) Option
  • func WithRegistryTimeout(t time.Duration) Option
  • func WithServer(srv ...server.Server) Option
  • func WithSignal(sigs ...os.Signal) Option
  • func WithStopTimeout(t time.Duration) Option
  • func WithVersion(version string) Option

Constants

const (
	Name    = "Gaea"
	Version = "v0.2.1"
)

Name and Version info of this framework, used for statistics and debug

Functions

func Apply

func Apply(opts ...Option) *options

func NewContext

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

NewContext returns a new Context that carries value.

Types

type AppInfo

type AppInfo interface {
	ID() string
	Name() string
	Version() string
	Metadata() map[string]string
	Endpoint() []string
}

func FromContext

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

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

type Gaea

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

func New

func New(opts ...Option) *Gaea

New create an application lifecycle manager.

func (*Gaea) Endpoint

func (g *Gaea) Endpoint() []string

Endpoint returns endpoints.

func (*Gaea) ID

func (g *Gaea) ID() string

ID returns app instance id.

func (*Gaea) Metadata

func (g *Gaea) Metadata() map[string]string

Metadata returns service metadata.

func (*Gaea) Name

func (g *Gaea) Name() string

Name returns service name.

func (*Gaea) RegisterServer

func (g *Gaea) RegisterServer(servers ...server.Server)

func (*Gaea) Run

func (g *Gaea) Run() error

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

func (*Gaea) Stop

func (g *Gaea) Stop() (err error)

Stop gracefully stops the application.

func (*Gaea) Version

func (g *Gaea) Version() string

Version returns app version.

type Option

type Option func(o *options)

Option is an application option.

func AfterStart

func AfterStart(fn func(context.Context) error) Option

AfterStart run funcs after app starts

func AfterStop

func AfterStop(fn func(context.Context) error) Option

AfterStop run funcs after app stops

func BeforeStart

func BeforeStart(fn func(context.Context) error) Option

BeforeStart run funcs before app starts

func BeforeStop

func BeforeStop(fn func(context.Context) error) Option

BeforeStop run funcs before app stops

func WithContext

func WithContext(ctx context.Context) Option

WithContext with a context

func WithEndpoint

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

WithEndpoint with service endpoint.

func WithID

func WithID(id string) Option

WithID with app id

func WithMetadata

func WithMetadata(md map[string]string) Option

WithMetadata with service metadata.

func WithName

func WithName(name string) Option

WithName .

func WithRegistry

func WithRegistry(r registry.Registry) Option

WithRegistry with service registry.

func WithRegistryTimeout

func WithRegistryTimeout(t time.Duration) Option

WithRegistryTimeout with registrar timeout.

func WithServer

func WithServer(srv ...server.Server) Option

WithServer with servers

func WithSignal

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

WithSignal with some system signal

func WithStopTimeout

func WithStopTimeout(t time.Duration) Option

WithStopTimeout with app stop timeout.

func WithVersion

func WithVersion(version string) Option

WithVersion with a version