grpc

Documentation

Index

• Constants
• Variables
• func Bool(val string) (bool, error)
• func BoolSlice(val, sep string) ([]bool, error)
• func BoolValue(val string) (*wrapperspb.BoolValue, error)
• func Bytes(val string) ([]byte, error)
• func BytesSlice(val, sep string) ([][]byte, error)
• func BytesValue(val string) (*wrapperspb.BytesValue, error)
• func ClientConnsClose() error
• func DoubleValue(val string) (*wrapperspb.DoubleValue, error)
• func Duration(val string) (*durationpb.Duration, error)
• func Enum(val string, enumValMap map[string]int32) (int32, error)
• func EnumSlice(val, sep string, enumValMap map[string]int32) ([]int32, error)
• func Float32(val string) (float32, error)
• func Float32Slice(val, sep string) ([]float32, error)
• func Float64(val string) (float64, error)
• func Float64Slice(val, sep string) ([]float64, error)
• func FloatValue(val string) (*wrapperspb.FloatValue, error)
• func HTTPPathPattern(ctx context.Context) (string, bool)
• func Int32(val string) (int32, error)
• func Int32Slice(val, sep string) ([]int32, error)
• func Int32Value(val string) (*wrapperspb.Int32Value, error)
• func Int64(val string) (int64, error)
• func Int64Slice(val, sep string) ([]int64, error)
• func Int64Value(val string) (*wrapperspb.Int64Value, error)
• func NewClient(addr string, opts ...grpc.DialOption) (*grpc.ClientConn, error)
• func NewServerMetadataContext(ctx context.Context, md ServerMetadata) context.Context
• func NewTLSClient(addr string, opts ...grpc.DialOption) (*grpc.ClientConn, error)
• func RPCMethod(ctx context.Context) (string, bool)
• func String(val string) (string, error)
• func StringSlice(val, sep string) ([]string, error)
• func StringValue(val string) (*wrapperspb.StringValue, error)
• func Timestamp(val string) (*timestamppb.Timestamp, error)
• func UInt32Value(val string) (*wrapperspb.UInt32Value, error)
• func UInt64Value(val string) (*wrapperspb.UInt64Value, error)
• func Uint32(val string) (uint32, error)
• func Uint32Slice(val, sep string) ([]uint32, error)
• func Uint64(val string) (uint64, error)
• func Uint64Slice(val, sep string) ([]uint64, error)
• type AnnotateContextOption
  • func WithHTTPPathPattern(pattern string) AnnotateContextOption
• type ServerMetadata
  • func ServerMetadataFromContext(ctx context.Context) (md ServerMetadata, ok bool)
• type ServerTransportStream
  • func (s *ServerTransportStream) Header() metadata.MD
  • func (s *ServerTransportStream) Method() string
  • func (s *ServerTransportStream) SendHeader(md metadata.MD) error
  • func (s *ServerTransportStream) SetHeader(md metadata.MD) error
  • func (s *ServerTransportStream) SetTrailer(md metadata.MD) error
  • func (s *ServerTransportStream) Trailer() metadata.MD

Constants

const MetadataHeaderPrefix = "Grpc-Metadata-"

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

const MetadataPrefix = "grpcgateway-"

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

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

var ClientConns = make(clientConns)

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.

var Internal = &metadata.MD{httpi.HeaderInternal: []string{"true"}}

Functions

func Bool

func Bool(val string) (bool, error)

Bool converts the given string representation of a boolean value into bool.

func BoolSlice

func BoolSlice(val, sep string) ([]bool, error)

BoolSlice converts 'val' where individual booleans are separated by 'sep' into a bool slice.

func BoolValue

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

BoolValue well-known type support as wrapper around bool type

func Bytes

func Bytes(val string) ([]byte, error)

Bytes converts the given string representation of a byte sequence into a slice of bytes A bytes sequence is encoded in URL-safe base64 without padding

func BytesSlice

func BytesSlice(val, sep string) ([][]byte, error)

BytesSlice converts 'val' where individual bytes sequences, encoded in URL-safe base64 without padding, are separated by 'sep' into a slice of bytes slices slice.

func BytesValue

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

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

func ClientConnsClose

func ClientConnsClose() error

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 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 Float32

func Float32(val string) (float32, error)

Float32 converts the given string representation of a floating point number into float32.

func Float32Slice

func Float32Slice(val, sep string) ([]float32, error)

Float32Slice converts 'val' where individual floating point numbers are separated by 'sep' into a float32 slice.

func Float64

func Float64(val string) (float64, error)

Float64 converts the given string representation into representation of a floating point number into float64.

func Float64Slice

func Float64Slice(val, sep string) ([]float64, error)

Float64Slice converts 'val' where individual floating point numbers are separated by 'sep' into a float64 slice.

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 Int32

func Int32(val string) (int32, error)

Int32 converts the given string representation of an integer into int32.

func Int32Slice

func Int32Slice(val, sep string) ([]int32, error)

Int32Slice converts 'val' where individual integers are separated by 'sep' into a int32 slice.

func Int32Value

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

Int32Value well-known type support as wrapper around int32 type

func Int64

func Int64(val string) (int64, error)

Int64 converts the given string representation of an integer into int64.

func Int64Slice

func Int64Slice(val, sep string) ([]int64, error)

Int64Slice converts 'val' where individual integers are separated by 'sep' into a int64 slice.

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 NewServerMetadataContext

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

NewServerMetadataContext creates a new context with ServerMetadata

func NewTLSClient

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

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 String

func String(val string) (string, error)

String just returns the given string. It is just for compatibility to other types.

func StringSlice

func StringSlice(val, sep string) ([]string, error)

StringSlice converts 'val' where individual strings are separated by 'sep' into a string slice.

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

func Uint32

func Uint32(val string) (uint32, error)

Uint32 converts the given string representation of an integer into uint32.

func Uint32Slice

func Uint32Slice(val, sep string) ([]uint32, error)

Uint32Slice converts 'val' where individual integers are separated by 'sep' into a uint32 slice.

func Uint64

func Uint64(val string) (uint64, error)

Uint64 converts the given string representation of an integer into uint64.

func Uint64Slice

func Uint64Slice(val, sep string) ([]uint64, error)

Uint64Slice converts 'val' where individual integers are separated by 'sep' into a uint64 slice.

Types

type AnnotateContextOption

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

func WithHTTPPathPattern

func WithHTTPPathPattern(pattern string) AnnotateContextOption

type ServerMetadata

type ServerMetadata struct {
	HeaderMD  metadata.MD
	TrailerMD 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) Header

func (s *ServerTransportStream) Header() metadata.MD

Header returns the header metadata of the stream.

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) 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.

func (*ServerTransportStream) Trailer

func (s *ServerTransportStream) Trailer() metadata.MD

Trailer returns the cached trailer metadata.