protocol

README

Forward Protocol Support

This package is used to support other backend protocols and perform conversion operations from HTTP to various protocols such as HTTP, tRPC, gRPC, and WebSocket.

Directory Structure

• cliprotocol.go Protocol conversion interface definition
• http HTTP to HTTP conversion
• trpc HTTP to tRPC conversion
• grpc HTTP to tRPC conversion

You can implement the cliprotocol.go interface to enable custom protocol conversion for your business.

Documentation

Index

• func RegisterCliProtocolHandler(protocol string, handler CliProtocolHandler)
• type CliProtocolHandler
  • func GetCliProtocolHandler(protocol string) (CliProtocolHandler, error)

Functions

func RegisterCliProtocolHandler

func RegisterCliProtocolHandler(protocol string, handler CliProtocolHandler)

RegisterCliProtocolHandler registers downstream protocol handler

Types

type CliProtocolHandler

type CliProtocolHandler interface {
	// WithCtx sets the context header
	WithCtx(ctx context.Context) (context.Context, error)
	// GetCliOptions gets specific client options for the request
	GetCliOptions(ctx context.Context) ([]client.Option, error)
	// TransReqBody transforms the request body
	TransReqBody(ctx context.Context) (interface{}, error)
	// TransRspBody transforms the response body
	TransRspBody(ctx context.Context) (interface{}, error)
	// HandleErr handles error information
	HandleErr(ctx context.Context, err error) error
	// HandleRspBody handles the response
	HandleRspBody(ctx context.Context, rspBody interface{}) error
}

CliProtocolHandler handles downstream requests based on the downstream client request protocol type

func GetCliProtocolHandler

func GetCliProtocolHandler(protocol string) (CliProtocolHandler, error)

GetCliProtocolHandler gets the downstream protocol handler based on the protocol