thrifttestfx

Documentation

Overview

Package thrifttestfx provides better integration for Fx for services implementing or calling ThriftTest.

Clients

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

fx.Provide(thrifttestfx.Client("..."))

Servers

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

Given,

func NewThriftTestHandler() thrifttestserver.Interface

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

fx.Provide(
	NewThriftTestHandler,
	thrifttestfx.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 ThriftTest client to an Fx application using the given name for routing.

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

func Server

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

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

fx.Provide(
	func(h *MyThriftTestHandler) thrifttestserver.Interface {
		return h
	},
	thrifttestfx.Server(),
)

Types

type Params

type Params struct {
	fx.In

	Provider yarpc.ClientConfig
}

Params defines the dependencies for the ThriftTest client.

type Result

type Result struct {
	fx.Out

	Client thrifttestclient.Interface
}

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

type ServerParams

type ServerParams struct {
	fx.In

	Handler thrifttestserver.Interface
}

ServerParams defines the dependencies for the ThriftTest server.

type ServerResult

type ServerResult struct {
	fx.Out

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

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