micro

package

v1.1.2 Latest Latest Go to latest Published: May 9, 2025 License: MIT Imports: 20 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/daheige/hephfx

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func GetCtxValue(ctx context.Context, key ctxkeys.CtxKey) interface{}
func GetGRPCClientIP(ctx context.Context) (string, error)
func GetSliceFromMD(md metadata.MD, key ctxkeys.CtxKey) []string
func GetStringFromMD(md metadata.MD, key ctxkeys.CtxKey) string
func IncomingMD(ctx context.Context) metadata.MD
func OutgoingMD(ctx context.Context) metadata.MD
func SetCtxValue(ctx context.Context, key ctxkeys.CtxKey, val interface{}) context.Context
type Logger
type LoggerFunc
- func (f LoggerFunc) Printf(msg string, args ...interface{})
type Option
type Service
- func NewService(address string, opts ...Option) *Service
- func (s *Service) GetPid() int
- func (s *Service) Run() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrInvokeGRPCClientIP get grpc request client ip fail.
	ErrInvokeGRPCClientIP = errors.New("invoke from context failed")

	// ErrPeerAddressNil gRPC peer address is nil.
	ErrPeerAddressNil = errors.New("peer address is nil")
)

Functions ¶

func GetCtxValue ¶

func GetCtxValue(ctx context.Context, key ctxkeys.CtxKey) interface{}

GetCtxValue returns ctx when you set key/value into ctx

func GetGRPCClientIP ¶

func GetGRPCClientIP(ctx context.Context) (string, error)

GetGRPCClientIP get client ip address from context

func GetSliceFromMD ¶

func GetSliceFromMD(md metadata.MD, key ctxkeys.CtxKey) []string

GetSliceFromMD returns []string from md

func GetStringFromMD ¶

func GetStringFromMD(md metadata.MD, key ctxkeys.CtxKey) string

GetStringFromMD returns string from md

func IncomingMD ¶

func IncomingMD(ctx context.Context) metadata.MD

IncomingMD returns metadata.MD from incoming ctx get request metadata this method is mainly used at the server end to get the relevant metadata data

func OutgoingMD ¶

func OutgoingMD(ctx context.Context) metadata.MD

OutgoingMD returns metadata.MD from outgoing ctx Use this method when you pass ctx to a downstream service

func SetCtxValue ¶

func SetCtxValue(ctx context.Context, key ctxkeys.CtxKey, val interface{}) context.Context

SetCtxValue returns ctx when you set key/value into ctx

Types ¶

type Logger ¶

type Logger interface {
	Printf(string, ...interface{})
}

Logger is logger interface.

type LoggerFunc ¶

type LoggerFunc func(string, ...interface{})

LoggerFunc is a bridge between Logger and any third party logger.

func (LoggerFunc) Printf ¶

func (f LoggerFunc) Printf(msg string, args ...interface{})

Printf implements Logger interface.

type Option ¶

type Option func(s *Service)

Option for grpc service option

func WithEnablePrometheus ¶

func WithEnablePrometheus() Option

WithEnablePrometheus enable prometheus

func WithEnableRequestAccess ¶

func WithEnableRequestAccess() Option

WithEnableRequestAccess request access log config

func WithEnableRequestValidator ¶

func WithEnableRequestValidator() Option

WithEnableRequestValidator set request validator

func WithGRPCNetwork ¶

func WithGRPCNetwork(network string) Option

WithGRPCNetwork set gRPC start network type

func WithGRPCServerOption ¶

func WithGRPCServerOption(serverOption ...grpc.ServerOption) Option

WithGRPCServerOption returns an Option to append a gRPC server option

func WithInterruptSignals ¶

func WithInterruptSignals(signal ...os.Signal) Option

WithInterruptSignals returns an Option to append a interrupt signal

func WithLogger ¶

func WithLogger(logger Logger) Option

WithLogger uses the provided logger

func WithRecovery ¶

func WithRecovery(f func()) Option

WithRecovery service recover func

func WithShutdownFunc ¶

func WithShutdownFunc(f func()) Option

WithShutdownFunc returns an Option to register a function which will be called when server shutdown

func WithShutdownTimeout ¶

func WithShutdownTimeout(timeout time.Duration) Option

WithShutdownTimeout returns an Option to set the timeout before the server shutdown abruptly

func WithStreamInterceptor ¶

func WithStreamInterceptor(streamInterceptor ...grpc.StreamServerInterceptor) Option

WithStreamInterceptor returns an Option to append some streamInterceptor

func WithUnaryInterceptor ¶

func WithUnaryInterceptor(unaryInterceptor ...grpc.UnaryServerInterceptor) Option

WithUnaryInterceptor returns an Option to append some unaryInterceptor

type Service ¶

type Service struct {
	GRPCServer *grpc.Server // gRPC server
	// contains filtered or unexported fields
}

Service gRPC microservice struct

func NewService ¶

func NewService(address string, opts ...Option) *Service

NewService create a grpc service instance

func (*Service) GetPid ¶

func (s *Service) GetPid() int

GetPid gets the process id of server

func (*Service) Run ¶

func (s *Service) Run() error

Run start gRPC service

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL