grpcmux

Documentation

Index

• Variables
• func CodeToError(c codes.Code) string
• func DefaultHTTPErrorHandler(ctx context.Context, mux *runtime.ServeMux, marshaler runtime.Marshaler, ...)
• func DefaultHeaderMatcher(key string) (string, bool)
• func SetCustomErrorCodes(codeErrors map[int32]string)
• func Validate(ctx context.Context, req interface{}) error
• func WriteHTTPErrorResponse(w http.ResponseWriter, err error)
• type Error
  • func (*Error) Descriptor() ([]byte, []int)
  • func (x *Error) GetDetails() []*any.Any
  • func (x *Error) GetError() string
  • func (x *Error) GetErrorCode() int32
  • func (x *Error) GetErrorDescription() string
  • func (*Error) ProtoMessage()
  • func (x *Error) ProtoReflect() protoreflect.Message
  • func (x *Error) Reset()
  • func (x *Error) String() string
• type MuxedGrpc
• type ServeMux
  • func NewServeMux(opts ...runtime.ServeMuxOption) *ServeMux
  • func (s *ServeMux) Handle(method string, path string, h runtime.HandlerFunc)
  • func (s *ServeMux) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type StreamError
  • func (*StreamError) Descriptor() ([]byte, []int)
  • func (x *StreamError) GetDetails() []*any.Any
  • func (x *StreamError) GetErrorDescription() string
  • func (x *StreamError) GetGrpcCode() int32
  • func (x *StreamError) GetHttpCode() int32
  • func (x *StreamError) GetHttpStatus() string
  • func (*StreamError) ProtoMessage()
  • func (x *StreamError) ProtoReflect() protoreflect.Message
  • func (x *StreamError) Reset()
  • func (x *StreamError) String() string

Variables

var File_error_proto protoreflect.FileDescriptor

Functions

func CodeToError

func CodeToError(c codes.Code) string

CodeToError translate grpc codes to error

func DefaultHTTPErrorHandler

func DefaultHTTPErrorHandler(ctx context.Context, mux *runtime.ServeMux, marshaler runtime.Marshaler, w http.ResponseWriter, r *http.Request, err error)

DefaultHTTPErrorHandler is the default error handler. If "err" is a gRPC Status, the function replies with the status code mapped by HTTPStatusFromCode. If otherwise, it replies with http.StatusInternalServerError.

The response body written by this function is a Status message marshaled by the Marshaler.

func DefaultHeaderMatcher

func DefaultHeaderMatcher(key string) (string, bool)

DefaultHeaderMatcher default header matcher

func SetCustomErrorCodes

func SetCustomErrorCodes(codeErrors map[int32]string)

SetCustomErrorCodes set custom error codes for DefaultHTTPError the map[int32]string is compact to protobuf's ENMU_name 2*** HTTP status 200 4*** HTTP status 400 5*** AND other HTTP status 500 For exp: in proto

enum CommonError {
	captcha_required = 4001;
	invalid_captcha = 4002;
}

in code grpcmux.SetCustomErrorCodes(common.CommonError_name)

func Validate

func Validate(ctx context.Context, req interface{}) error

Validate by the contxt

func WriteHTTPErrorResponse

func WriteHTTPErrorResponse(w http.ResponseWriter, err error)

WriteHTTPErrorResponse set HTTP status code and write error description to the body.

Types

type Error

type Error struct {
	Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// This is to make the error more compatible with users that expect errors to be Status objects:
	// https://github.com/grpc/grpc/blob/master/src/proto/grpc/status/status.proto
	// It should be the exact same message as the Error field.
	ErrorCode        int32      `protobuf:"varint,2,opt,name=error_code,json=errorCode,proto3" json:"error_code,omitempty"`
	ErrorDescription string     `protobuf:"bytes,3,opt,name=error_description,json=errorDescription,proto3" json:"error_description,omitempty"`
	Details          []*any.Any `protobuf:"bytes,4,rep,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

Error is the generic error returned from unary RPCs.

func (*Error) Descriptor

func (*Error) Descriptor() ([]byte, []int)

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetDetails

func (x *Error) GetDetails() []*any.Any

func (*Error) GetError

func (x *Error) GetError() string

func (*Error) GetErrorCode

func (x *Error) GetErrorCode() int32

func (*Error) GetErrorDescription

func (x *Error) GetErrorDescription() string

func (*Error) ProtoMessage

func (*Error) ProtoMessage()

func (*Error) ProtoReflect

func (x *Error) ProtoReflect() protoreflect.Message

func (*Error) Reset

func (x *Error) Reset()

func (*Error) String

func (x *Error) String() string

type MuxedGrpc

type MuxedGrpc struct {
}

MuxedGrpc check the context is by mux grpc

type ServeMux

type ServeMux struct {
	*runtime.ServeMux
}

ServeMux the custom serve mux that implement grpc ServeMux to simplify the http restful

func NewServeMux

func NewServeMux(opts ...runtime.ServeMuxOption) *ServeMux

NewServeMux allocates and returns a new ServeMux.

func (*ServeMux) Handle

func (s *ServeMux) Handle(method string, path string, h runtime.HandlerFunc)

Handle associates "h" to the pair of HTTP method and path pattern.

func (*ServeMux) ServeHTTP

func (s *ServeMux) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP add ctx from http request

type StreamError

type StreamError struct {
	GrpcCode         int32      `protobuf:"varint,1,opt,name=grpc_code,json=grpcCode,proto3" json:"grpc_code,omitempty"`
	HttpCode         int32      `protobuf:"varint,2,opt,name=http_code,json=httpCode,proto3" json:"http_code,omitempty"`
	ErrorDescription string     `protobuf:"bytes,3,opt,name=error_description,json=errorDescription,proto3" json:"error_description,omitempty"`
	HttpStatus       string     `protobuf:"bytes,4,opt,name=http_status,json=httpStatus,proto3" json:"http_status,omitempty"`
	Details          []*any.Any `protobuf:"bytes,5,rep,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

StreamError is a response type which is returned when streaming rpc returns an error.

func (*StreamError) Descriptor

func (*StreamError) Descriptor() ([]byte, []int)

Deprecated: Use StreamError.ProtoReflect.Descriptor instead.

func (*StreamError) GetDetails

func (x *StreamError) GetDetails() []*any.Any

func (*StreamError) GetErrorDescription

func (x *StreamError) GetErrorDescription() string

func (*StreamError) GetGrpcCode

func (x *StreamError) GetGrpcCode() int32

func (*StreamError) GetHttpCode

func (x *StreamError) GetHttpCode() int32

func (*StreamError) GetHttpStatus

func (x *StreamError) GetHttpStatus() string

func (*StreamError) ProtoMessage

func (*StreamError) ProtoMessage()

func (*StreamError) ProtoReflect

func (x *StreamError) ProtoReflect() protoreflect.Message

func (*StreamError) Reset

func (x *StreamError) Reset()

func (*StreamError) String

func (x *StreamError) String() string