brick

README

brick

Brick is a code generating function service for Go.

Documentation

Index

• func Launch(ctx context.Context, options ...Option) (err error)
• func Run(ctx context.Context, handler func(ctx context.Context), options ...Option) (err error)
• type App
  • func New(options ...Option) (app *App, err error)
  • func (app *App) Close() (err error)
  • func (app *App) Run(ctx context.Context, handler func(ctx context.Context)) (err error)
  • func (app *App) Serve(ctx context.Context) (err error)
• type Config
• type Option
  • func WithActive(active string) Option
  • func WithCloseTimeout(timeout time.Duration) Option
  • func WithConfigRetriever(retriever configs.Retriever) Option
  • func WithEndpoint(builder ...endpoints.EndpointBuilder) Option
  • func WithEndpointRetriever(builder endpoints.EndpointRetrieverBuilder) Option
  • func WithEndpoints(builders []endpoints.EndpointBuilder) Option
  • func WithExtraTransport(builder ...transports.Builder) Option
  • func WithGracefulShutdown(signals ...os.Signal) Option
  • func WithLogger(builder logs.Builder) Option
  • func WithVersion(v string) Option
• type Options

Functions

func Launch

func Launch(ctx context.Context, options ...Option) (err error)

func Run

func Run(ctx context.Context, handler func(ctx context.Context), options ...Option) (err error)

Types

type App

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

func New

func New(options ...Option) (app *App, err error)

func (*App) Close

func (app *App) Close() (err error)

func (*App) Run

func (app *App) Run(ctx context.Context, handler func(ctx context.Context)) (err error)

func (*App) Serve

func (app *App) Serve(ctx context.Context) (err error)

type Config

type Config struct {
	Logger     configs.Config `yaml:"logger"`
	Transports configs.Config `yaml:"transports"`
	Endpoints  configs.Config `yaml:"endpoints"`
}

type Option

type Option func(*Options) error

func WithActive

func WithActive(active string) Option

func WithCloseTimeout

func WithCloseTimeout(timeout time.Duration) Option

func WithConfigRetriever

func WithConfigRetriever(retriever configs.Retriever) Option

func WithEndpoint

func WithEndpoint(builder ...endpoints.EndpointBuilder) Option

func WithEndpointRetriever

func WithEndpointRetriever(builder endpoints.EndpointRetrieverBuilder) Option

func WithEndpoints

func WithEndpoints(builders []endpoints.EndpointBuilder) Option

func WithExtraTransport

func WithExtraTransport(builder ...transports.Builder) Option

func WithGracefulShutdown

func WithGracefulShutdown(signals ...os.Signal) Option

func WithLogger

func WithLogger(builder logs.Builder) Option

func WithVersion

func WithVersion(v string) Option

type Options

type Options struct {
	Active                      string
	Version                     string
	ConfigRetriever             configs.Retriever
	LoggerBuilder               logs.Builder
	EndpointBuilders            []endpoints.EndpointBuilder
	EndpointRetrieverBuilder    endpoints.EndpointRetrieverBuilder
	ExtraTransportBuilders      []transports.Builder
	GracefulShutdownListenWinds []whisper.Wind
	CloseTimeout                time.Duration
}