readonlystorefx

Documentation

Overview

Package readonlystorefx provides better integration for Fx for services implementing or calling ReadOnlyStore.

Clients

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

fx.Provide(readonlystorefx.Client("..."))

Servers

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

Given,

func NewReadOnlyStoreHandler() readonlystoreserver.Interface

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

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

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

func Server

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

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

fx.Provide(
	func(h *MyReadOnlyStoreHandler) readonlystoreserver.Interface {
		return h
	},
	readonlystorefx.Server(),
)

Types

type Params

type Params struct {
	fx.In

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

Params defines the dependencies for the ReadOnlyStore client.

type Result

type Result struct {
	fx.Out

	Client readonlystoreclient.Interface
}

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

type ServerParams

type ServerParams struct {
	fx.In

	Handler readonlystoreserver.Interface
}

ServerParams defines the dependencies for the ReadOnlyStore server.

type ServerResult

type ServerResult struct {
	fx.Out

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

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