transportx

Documentation

Index

• func NewContext(ctx context.Context, s AppInfo) context.Context
• func Run(ctx context.Context, appInfo AppInfo, logger *slog.Logger, ...) error
• type AppInfo
  • func FromContext(ctx context.Context) (s AppInfo, ok bool)
  • func NewAppInfo(id, name, version string, metadata map[string]string) AppInfo
• type RunOption
  • func AfterStart(fn ...func(ctx context.Context) error) RunOption
  • func AfterStop(fn ...func(ctx context.Context) error) RunOption
  • func BeforeStart(fn ...func(ctx context.Context) error) RunOption
  • func BeforeStop(fn ...func(ctx context.Context) error) RunOption
  • func WithServers(server ...Server) RunOption
  • func WithSignal(signal ...os.Signal) RunOption
  • func WithStopTimeout(stopTimeout time.Duration) RunOption
• type Server

Functions

func NewContext

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

NewContext returns a new Context that carries value.

func Run

func Run(ctx context.Context, appInfo AppInfo, logger *slog.Logger, options ...RunOption) error

Types

type AppInfo

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

func FromContext

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

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

func NewAppInfo

func NewAppInfo(id, name, version string, metadata map[string]string) AppInfo

type RunOption

type RunOption func(*runner)

func AfterStart

func AfterStart(fn ...func(ctx context.Context) error) RunOption

func AfterStop

func AfterStop(fn ...func(ctx context.Context) error) RunOption

func BeforeStart

func BeforeStart(fn ...func(ctx context.Context) error) RunOption

func BeforeStop

func BeforeStop(fn ...func(ctx context.Context) error) RunOption

func WithServers

func WithServers(server ...Server) RunOption

func WithSignal

func WithSignal(signal ...os.Signal) RunOption

func WithStopTimeout

func WithStopTimeout(stopTimeout time.Duration) RunOption

type Server

type Server interface {
	Start(context.Context) error
	Stop(context.Context) error
}