extendemptyfx

Documentation

Overview

Package extendemptyfx provides better integration for Fx for services implementing or calling ExtendEmpty.

Clients

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

fx.Provide(extendemptyfx.Client("..."))

Servers

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

Given,

func NewExtendEmptyHandler() extendemptyserver.Interface

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

fx.Provide(
	NewExtendEmptyHandler,
	extendemptyfx.Server(),
)

Index

• func Client(name string, opts ...thrift.ClientOption) interface{}
• func Server(opts ...thrift.RegisterOption) interface{}
• type Params
• type Result
• type ServerParams
• type ServerResult

Functions

func Client

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

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

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

func Server

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

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

fx.Provide(
	func(h *MyExtendEmptyHandler) extendemptyserver.Interface {
		return h
	},
	extendemptyfx.Server(),
)

Types

type Params

type Params struct {
	fx.In

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

Params defines the dependencies for the ExtendEmpty client.

type Result

type Result struct {
	fx.Out

	Client extendemptyclient.Interface
}

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

type ServerParams

type ServerParams struct {
	fx.In

	Handler extendemptyserver.Interface
}

ServerParams defines the dependencies for the ExtendEmpty server.

type ServerResult

type ServerResult struct {
	fx.Out

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

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