baseservicefx

package
v1.52.0 Latest Latest
Warning

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

Go to latest
Published: Feb 15, 2021 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Package baseservicefx provides better integration for Fx for services implementing or calling BaseService.

Clients

If you are making requests to BaseService, use the Client function to inject a BaseService client into your container.

fx.Provide(baseservicefx.Client("..."))

Servers

If you are implementing BaseService, provide a baseserviceserver.Interface into the container and use the Server function.

Given,

func NewBaseServiceHandler() baseserviceserver.Interface

You can do the following to have the procedures of BaseService made available to an Fx application.

fx.Provide(
	NewBaseServiceHandler,
	baseservicefx.Server(),
)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Client

func Client(name string, opts ...thrift.ClientOption) interface{}

Client provides a BaseService client to an Fx application using the given name for routing.

fx.Provide(
	baseservicefx.Client("..."),
	newHandler,
)

func Server added in v1.22.0

func Server(opts ...thrift.RegisterOption) interface{}

Server provides procedures for BaseService to an Fx application. It expects a baseservicefx.Interface to be present in the container.

fx.Provide(
	func(h *MyBaseServiceHandler) baseserviceserver.Interface {
		return h
	},
	baseservicefx.Server(),
)

Types

type Params added in v1.13.0

type Params struct {
	fx.In

	Provider    yarpc.ClientConfig
	Restriction restriction.Checker `optional:"true"`
}

Params defines the dependencies for the BaseService client.

type Result added in v1.13.0

type Result struct {
	fx.Out

	Client baseserviceclient.Interface
}

Result defines the output of the BaseService client module. It provides a BaseService client to an Fx application.

type ServerParams added in v1.22.0

type ServerParams struct {
	fx.In

	Handler baseserviceserver.Interface
}

ServerParams defines the dependencies for the BaseService server.

type ServerResult added in v1.22.0

type ServerResult struct {
	fx.Out

	Procedures []transport.Procedure `group:"yarpcfx"`
}

ServerResult defines the output of BaseService server module. It provides the procedures of a BaseService handler to an Fx application.

The procedures are provided to the "yarpcfx" value group. Dig 1.2 or newer must be used for this feature to work.

Jump to

Keyboard shortcuts

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