grpc

package
v1.7.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 13, 2026 License: MIT, Apache-2.0 Imports: 29 Imported by: 7

Documentation

Index

Constants

View Source 
const (
	SysErr             = ErrCode(-1)
	Success            = ErrCode(codes.OK)
	Canceled           = ErrCode(codes.Canceled)
	Unknown            = ErrCode(codes.Unknown)
	InvalidArgument    = ErrCode(codes.InvalidArgument)
	DeadlineExceeded   = ErrCode(codes.DeadlineExceeded)
	NotFound           = ErrCode(codes.NotFound)
	AlreadyExists      = ErrCode(codes.AlreadyExists)
	PermissionDenied   = ErrCode(codes.PermissionDenied)
	ResourceExhausted  = ErrCode(codes.ResourceExhausted)
	FailedPrecondition = ErrCode(codes.FailedPrecondition)
	Aborted            = ErrCode(codes.Aborted)
	OutOfRange         = ErrCode(codes.OutOfRange)
	Unimplemented      = ErrCode(codes.Unimplemented)
	Internal           = ErrCode(codes.Internal)
	Unavailable        = ErrCode(codes.Unavailable)
	DataLoss           = ErrCode(codes.DataLoss)
	Unauthenticated    = ErrCode(codes.Unauthenticated)
)
View Source 
const MetadataHeaderPrefix = "Grpc-Metadata-"

MetadataHeaderPrefix is the http prefix that represents custom metadata parameters to or from a gRPC call.

View Source 
const MetadataPrefix = "Grpc-Gateway-"

MetadataPrefix is prepended to permanent HTTP header keys (as specified by the IANA) when added to the gRPC context.

View Source 
const MetadataTrailerPrefix = "Grpc-Trailer-"

MetadataTrailerPrefix is prepended to gRPC metadata as it is converted to HTTP headers in a response handled by grpc-gateway

Variables

View Source 
var DefaultContextTimeout = 0 * time.Second

DefaultContextTimeout is used for gRPC call context.WithTimeout whenever a Grpc-Timeout inbound header isn't present. If the value is 0 the sent `context` will not have a timeout.

View Source 
var InternalMD = &metadata.MD{httpx.HeaderInternal: []string{"true"}}
View Source 
var ReConnectMap = make(map[string]func() error)

这里的key值应该取什么

Functions

func BoolValue 

func BoolValue(val string) (*wrapperspb.BoolValue, error)

BoolValue well-known type support as wrapper around bool type

func BytesValue 

func BytesValue(val string) (*wrapperspb.BytesValue, error)

BytesValue well-known type support as wrapper around bytes[] type

func DoubleValue 

func DoubleValue(val string) (*wrapperspb.DoubleValue, error)

DoubleValue well-known type support as wrapper around float64 type

func Duration 

func Duration(val string) (*durationpb.Duration, error)

Duration converts the given string into a timestamp.Duration.

func Enum 

func Enum(val string, enumValMap map[string]int32) (int32, error)

Enum converts the given string into an int32 that should be type casted into the correct enum proto type.

func EnumP added in v1.6.2 

func EnumP(val string, enumValMap map[string]int32) (*int32, error)

EnumP converts the given string into an int32 pointer that should be type casted into the correct enum proto type.

func EnumSlice 

func EnumSlice(val, sep string, enumValMap map[string]int32) ([]int32, error)

EnumSlice converts 'val' where individual enums are separated by 'sep' into a int32 slice. Each individual int32 should be type casted into the correct enum proto type.

func FloatValue 

func FloatValue(val string) (*wrapperspb.FloatValue, error)

FloatValue well-known type support as wrapper around float32 type

func HTTPPathPattern 

func HTTPPathPattern(ctx context.Context) (string, bool)

HTTPPathPattern returns the HTTP path pattern string relating to the HTTP handler, if one exists. The format of the returned string is defined by the google.api.http path template type.

func Int32Value 

func Int32Value(val string) (*wrapperspb.Int32Value, error)

Int32Value well-known type support as wrapper around int32 type

func Int64Value 

func Int64Value(val string) (*wrapperspb.Int64Value, error)

Int64Value well-known type support as wrapper around int64 type

func NewClient 

func NewClient(addr string, opts ...grpc.DialOption) (*grpc.ClientConn, error)

func NewClientTLS added in v1.3.20 

func NewClientTLS(addr string, opts ...grpc.DialOption) (*grpc.ClientConn, error)

func NewServerMetadataContext 

func NewServerMetadataContext(ctx context.Context, md ServerMetadata) context.Context

NewServerMetadataContext creates a new context with ServerMetadata

func RPCMethod 

func RPCMethod(ctx context.Context) (string, bool)

RPCMethod returns the method string for the server context. The returned string is in the format of "/package.service/method".

func ReConnect 

func ReConnect(v interface{}, getEndPort func() string, opts []grpc.DialOption) func() error

func Register 

func Register(code ErrCode, msg string)

func StringValue 

func StringValue(val string) (*wrapperspb.StringValue, error)

StringValue well-known type support as wrapper around string type

func Timestamp 

func Timestamp(val string) (*timestamppb.Timestamp, error)

Timestamp converts the given RFC3339 formatted string into a timestamp.Timestamp.

func UInt32Value 

func UInt32Value(val string) (*wrapperspb.UInt32Value, error)

UInt32Value well-known type support as wrapper around uint32 type

func UInt64Value 

func UInt64Value(val string) (*wrapperspb.UInt64Value, error)

UInt64Value well-known type support as wrapper around uint64 type

Types

type AnnotateContextOption 

type AnnotateContextOption func(ctx context.Context) context.Context

func WithHTTPPathPattern 

func WithHTTPPathPattern(pattern string) AnnotateContextOption

type ErrCode 

type ErrCode errors.ErrCode

func (ErrCode) ErrResp added in v1.3.9 

func (x ErrCode) ErrResp() *ErrResp

func (ErrCode) Error 

func (x ErrCode) Error() string

func (ErrCode) GRPCStatus 

func (x ErrCode) GRPCStatus() *status.Status

func (ErrCode) Msg 

func (x ErrCode) Msg(msg string) *ErrResp

func (ErrCode) String 

func (x ErrCode) String() string

func (ErrCode) Wrap 

func (x ErrCode) Wrap(err error) *ErrResp

type ErrResp added in v1.3.9 

type ErrResp errors.ErrResp

func ErrRespFrom added in v1.6.6 

func ErrRespFrom(err error) *ErrResp

func NewErrResp added in v1.6.6 

func NewErrResp(code ErrCode, msg string) *ErrResp

func (*ErrResp) ErrResp added in v1.6.13 

func (e *ErrResp) ErrResp() *errors.ErrResp

func (*ErrResp) Error added in v1.3.9 

func (x *ErrResp) Error() string

func (*ErrResp) GRPCStatus added in v1.3.9 

func (x *ErrResp) GRPCStatus() *status.Status

func (*ErrResp) MarshalJSON added in v1.3.9 

func (x *ErrResp) MarshalJSON() ([]byte, error)

type GRPCStatus 

type GRPCStatus interface {
	GRPCStatus() *status.Status
}

type ServerMetadata 

type ServerMetadata struct {
	Header  metadata.MD
	Trailer metadata.MD
}

ServerMetadata consists of metadata sent from gRPC server.

func ServerMetadataFromContext 

func ServerMetadataFromContext(ctx context.Context) (md ServerMetadata, ok bool)

ServerMetadataFromContext returns the ServerMetadata in ctx

type ServerTransportStream 

type ServerTransportStream struct {
	// contains filtered or unexported fields
}

ServerTransportStream implements grpc.ServerTransportStream. It should only be used by the generated files to support grpc.SendHeader outside of gRPC server use.

func (*ServerTransportStream) Method 

func (s *ServerTransportStream) Method() string

Method returns the method for the stream.

func (*ServerTransportStream) SendHeader 

func (s *ServerTransportStream) SendHeader(md metadata.MD) error

SendHeader sets the header metadata.

func (*ServerTransportStream) ServerMetadata added in v1.5.1 

func (s *ServerTransportStream) ServerMetadata() ServerMetadata

Header returns the server metadata of the stream.

func (*ServerTransportStream) SetHeader 

func (s *ServerTransportStream) SetHeader(md metadata.MD) error

SetHeader sets the header metadata.

func (*ServerTransportStream) SetTrailer 

func (s *ServerTransportStream) SetTrailer(md metadata.MD) error

SetTrailer sets the trailer metadata.

type Unmarshaler added in v1.6.6 

type Unmarshaler interface {
	Unmarshal(data []byte, v proto.Message) error
}
var (
	DefaultUnmarshaler Unmarshaler = &protojson.UnmarshalOptions{}
)

Source Files

View all Source files

Directories

Path Synopsis
web
test

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.