emptyservicefx

package

v1.72.1 Latest Latest Go to latest Published: Mar 14, 2024 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package emptyservicefx provides better integration for Fx for services implementing or calling EmptyService.

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

fx.Provide(emptyservicefx.Client("..."))

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

Given,

func NewEmptyServiceHandler() emptyserviceserver.Interface

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

fx.Provide(
	NewEmptyServiceHandler,
	emptyservicefx.Server(),
)

This section is empty.

This section is empty.

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

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

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

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

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

fx.Provide(
	func(h *MyEmptyServiceHandler) emptyserviceserver.Interface {
		return h
	},
	emptyservicefx.Server(),
)

type Params struct {
	fx.In

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

Params defines the dependencies for the EmptyService client.

type Result struct {
	fx.Out

	Client emptyserviceclient.Interface
}

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

type ServerParams struct {
	fx.In

	Handler emptyserviceserver.Interface
}

ServerParams defines the dependencies for the EmptyService server.

type ServerResult struct {
	fx.Out

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

ServerResult defines the output of EmptyService server module. It provides the procedures of a EmptyService 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.