rpc

Documentation

Index

• func Export[Request, Response any](method HandlerFunc[Request, Response])
• func ExportName[Request, Response any](name string, method HandlerFunc[Request, Response])
• type HandlerFunc
  • func Compile[Request, Response any](method HandlerFunc[Request, Response]) HandlerFunc[Request, Response]
• type Server

Functions

func Export

func Export[Request, Response any](method HandlerFunc[Request, Response])

Export exports a method to RPC. The name of method will be converted to kebab-case.

func ExportName

func ExportName[Request, Response any](name string, method HandlerFunc[Request, Response])

ExportName exports a method to RPC with specified name.

Types

type HandlerFunc

type HandlerFunc[Request, Response any] func(ctx context.Context, req *Request) (resp *Response, err error)

func Compile

func Compile[Request, Response any](method HandlerFunc[Request, Response]) HandlerFunc[Request, Response]

Compile wraps a method with request validator, initer and error handler. The returned method is used in RPC server to handle any request.

Business code should never call Compile unless for test purpose, e.g. writing unit test cases for a RPC method.

type Server

type Server interface {
	Serve(ctx context.Context) error
	Shutdown(ctx context.Context) error
}

Server represents a long running server.