rkgrpcmid

Documentation

Overview

Package rkgrpcmid provides common utility functions for middleware of grpc framework

Index

• Variables
• func AddToServerContextPayload(ctx context.Context, key interface{}, value interface{})
• func ContainsServerPayload(ctx context.Context) bool
• func GetGrpcInfo(fullMethod string) (grpcService, grpcMethod string)
• func GetGwInfo(md metadata.MD) (gwMethod, gwPath, gwScheme, gwUserAgent string)
• func GetRemoteAddressSet(ctx context.Context) (ip, port, netType string)
• func GetRemoteAddressSetFromMeta(md metadata.MD) (ip, port string)
• func GetServerContextPayload(ctx context.Context) map[interface{}]interface{}
• func GetServerPayloadKey() interface{}
• func MergeAndDeduplicateSlice(src []string, target []string) []string
• func MergeToOutgoingMD(ctx context.Context, md metadata.MD) context.Context
• func ToOptionsKey(entryName, rpcType string) string
• func WrapContextForServer(ctx context.Context) context.Context

Variables

var (
	LocalIp = zap.String("localIp", rkmid.LocalIp.String)
	// LocalHostname read hostname from localhost
	LocalHostname = zap.String("localHostname", rkmid.LocalHostname.String)
)

var RpcPayloadAppended = rpcPayloadAppended{}

RpcPayloadAppended a flag used in inner middleware

Functions

func AddToServerContextPayload

func AddToServerContextPayload(ctx context.Context, key interface{}, value interface{})

AddToServerContextPayload add k/v into payload injected into server side context

func ContainsServerPayload

func ContainsServerPayload(ctx context.Context) bool

ContainsServerPayload is payload injected into server side context?

func GetGrpcInfo

func GetGrpcInfo(fullMethod string) (grpcService, grpcMethod string)

GetGrpcInfo Extract grpc related information from fullMethod.

func GetGwInfo

func GetGwInfo(md metadata.MD) (gwMethod, gwPath, gwScheme, gwUserAgent string)

GetGwInfo Extract gateway related information from metadata.

func GetRemoteAddressSet

func GetRemoteAddressSet(ctx context.Context) (ip, port, netType string)

GetRemoteAddressSet Read remote Ip and port from metadata first.

func GetRemoteAddressSetFromMeta

func GetRemoteAddressSetFromMeta(md metadata.MD) (ip, port string)

GetRemoteAddressSetFromMeta Read remote Ip and port from metadata. If user enabled RK style gateway server mux option, then there would be bellow headers forwarded to grpc metadata 1: x-forwarded-method 2: x-forwarded-path 3: x-forwarded-scheme 4: x-forwarded-user-agent 5: x-forwarded-remote-addr

func GetServerContextPayload

func GetServerContextPayload(ctx context.Context) map[interface{}]interface{}

GetServerContextPayload get context payload injected into server side context

func GetServerPayloadKey

func GetServerPayloadKey() interface{}

GetServerPayloadKey get server payload key used in context.Context

func MergeAndDeduplicateSlice

func MergeAndDeduplicateSlice(src []string, target []string) []string

MergeAndDeduplicateSlice Merge src and targets and deduplicate

func MergeToOutgoingMD

func MergeToOutgoingMD(ctx context.Context, md metadata.MD) context.Context

MergeToOutgoingMD Merge md to context outgoing metadata.

func ToOptionsKey

func ToOptionsKey(entryName, rpcType string) string

ToOptionsKey Convert to optionsMap key with entry name and rpcType.

func WrapContextForServer

func WrapContextForServer(ctx context.Context) context.Context

WrapContextForServer Wrap server context.