kratos

package module
v0.0.0-...-961a225 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 13, 2024 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const Release = "v2.8.2"

Release 是当前 kratos 库的版本号

Variables

This section is empty.

Functions

func NewContext

func NewContext(ctx context.Context, s AppInfo) 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) 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() (err error)

Stop gracefully stops the application.

func (*App) Version

func (a *App) Version() string

Version returns app version.

type AppInfo

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

AppInfo is application context value.

func FromContext

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

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

type Option

type Option func(o *options)

Option 是应用程序的选项。

func AfterStart

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

AfterStart 在应用程序启动后运行函数。

func AfterStop

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

AfterStop 在应用程序停止后运行函数。

func BeforeStart

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

BeforeStart 在应用程序启动前运行函数。

func BeforeStop

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

BeforeStop 在应用程序停止前运行函数。

func Context

func Context(ctx context.Context) Option

Context 用于设置服务上下文。

func Endpoint

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

Endpoint 用于设置服务端点。

func ID

func ID(id string) Option

ID 用于设置服务 ID。

func Logger

func Logger(logger log.Logger) Option

Logger 用于设置服务日志记录器。

func Metadata

func Metadata(md map[string]string) Option

Metadata 用于设置服务元数据。

func Name

func Name(name string) Option

Name 用于设置服务名称。

func Registrar

func Registrar(r registry.Registrar) Option

Registrar 用于设置服务注册器。

func RegistrarTimeout

func RegistrarTimeout(t time.Duration) Option

RegistrarTimeout 用于设置注册器超时时间。

func Server

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

Server 用于设置传输服务器。

func Signal

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

Signal 用于设置退出信号。

func StopTimeout

func StopTimeout(t time.Duration) Option

StopTimeout 用于设置应用程序停止超时时间。

func Version

func Version(version string) Option

Version 用于设置服务版本。

Directories

Path Synopsis
api
cmd
kratos module
env
contrib
proto
Package proto 定义了 protobuf 编解码器。
Package proto 定义了 protobuf 编解码器。
xml
nolint:mnd
nolint:mnd
internal
group
Package group provides a sample lazy load container.
Package group provides a sample lazy load container.
p2c
wrr

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL