onewayfx

Documentation

Overview

Package onewayfx provides better integration for Fx for services implementing or calling Oneway.

Clients

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

fx.Provide(onewayfx.Client("..."))

Servers

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

Given,

func NewOnewayHandler() onewayserver.Interface

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

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

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

func Server

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

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

fx.Provide(
	func(h *MyOnewayHandler) onewayserver.Interface {
		return h
	},
	onewayfx.Server(),
)

Types

type Params

type Params struct {
	fx.In

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

Params defines the dependencies for the Oneway client.

type Result

type Result struct {
	fx.Out

	Client onewayclient.Interface
}

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

type ServerParams

type ServerParams struct {
	fx.In

	Handler onewayserver.Interface
}

ServerParams defines the dependencies for the Oneway server.

type ServerResult

type ServerResult struct {
	fx.Out

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

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