grpcall

package
v0.0.0-...-9037792 Latest Latest
Warning

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

 Go to latest Published: Jun 24, 2021 License: MIT Imports: 36 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	FormatJSON = Format("json")
)

Variables

View Source 
var ErrReflectionNotSupported = errors.New("server does not support the reflection API")

ErrReflectionNotSupported is returned by DescriptorSource operations that rely on interacting with the reflection service when the source does not actually expose the reflection service. When this occurs, an alternate source (like file descriptor sets) must be used.

Functions

func BlockingDial 

func BlockingDial(ctx context.Context, address string, opts ...grpc.DialOption) (*grpc.ClientConn, error)

BlockingDial is a helper method to dial the given address, using optional TLS credentials, and blocking until the returned connection is ready. If the given credentials are nil, the connection will be insecure (plain-text).

func ClientTransportCredentials 

func ClientTransportCredentials(insecureSkipVerify bool, cacertFile, clientCertFile, clientKeyFile string) (credentials.TransportCredentials, error)

ClientTransportCredentials builds transport credentials for a gRPC client using the given properties. If cacertFile is blank, only standard trusted certs are used to verify the server certs. If clientCertFile is blank, the client will not use a client certificate. If clientCertFile is not blank then clientKeyFile must not be blank.

func EnsureExtensions 

func EnsureExtensions(source DescriptorSource, msg proto.Message) proto.Message

EnsureExtensions uses the given descriptor source to download extensions for the given message. It returns a copy of the given message, but as a dynamic message that knows about all extensions known to the given descriptor source.

func GetAllFiles 

func GetAllFiles(source DescriptorSource) ([]*desc.FileDescriptor, error)

GetAllFiles uses the given descriptor source to return a list of file descriptors.

func GetCmd 

func GetCmd()

go run main.go localhost:8080 hello.TestApi Version

func GetDescriptorText 

func GetDescriptorText(dsc desc.Descriptor, _ DescriptorSource) (string, error)

GetDescriptorText returns a string representation of the given descriptor. This returns a snippet of proto source that describes the given element.

func ListMethods 

func ListMethods(source DescriptorSource, serviceName string) ([]string, error)

ListMethods uses the given descriptor source to return a sorted list of method names for the specified fully-qualified service name.

func ListServices 

func ListServices(source DescriptorSource) ([]string, error)

ListServices uses the given descriptor source to return a sorted list of fully-qualified service names.

func MakeTemplate 

func MakeTemplate(md *desc.MessageDescriptor) proto.Message

MakeTemplate returns a message instance for the given descriptor that is a suitable template for creating an instance of that message in JSON. In particular, it ensures that any repeated fields (which include map fields) are not empty, so they will render with a single element (to show the types and optionally nested fields). It also ensures that nested messages are not nil by setting them to a message that is also fleshed out as a template message.

func MetadataFromHeaders 

func MetadataFromHeaders(headers []string) metadata.MD

MetadataFromHeaders converts a list of header strings (each string in "Header-Name: Header-Value" form) into metadata. If a string has a header name without a value (e.g. does not contain a colon), the value is assumed to be blank. Binary headers (those whose names end in "-bin") should be base64-encoded. But if they cannot be base64-decoded, they will be assumed to be in raw form and used as is.

func MetadataToString 

func MetadataToString(md metadata.MD) string

MetadataToString returns a string representation of the given metadata, for displaying to users.

func RequestParserAndFormatterFor 

func RequestParserAndFormatterFor(descSource DescriptorSource, emitJSONDefaultFields bool, in io.Reader) (RequestParser, Formatter, error)

RequestParserAndFormatterFor returns a request parser and formatter for the given format.

func ServerTransportCredentials 

func ServerTransportCredentials(cacertFile, serverCertFile, serverKeyFile string, requireClientCerts bool) (credentials.TransportCredentials, error)

ServerTransportCredentials builds transport credentials for a gRPC server using the given properties. If cacertFile is blank, the server will not request client certs unless requireClientCerts is true. When requireClientCerts is false and cacertFile is not blank, the server will verify client certs when presented, but will not require client certs. The serverCertFile and serverKeyFile must both not be blank.

Types

type DefaultEventHandler1 

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

func (*DefaultEventHandler1) OnReceiveData 

func (h *DefaultEventHandler1) OnReceiveData(md metadata.MD, resp string, respErr error)

func (*DefaultEventHandler1) OnReceiveTrailers 

func (h *DefaultEventHandler1) OnReceiveTrailers(stat *status.Status, md metadata.MD)

type DescriptorSource 

type DescriptorSource interface {
	// ListServices returns a list of fully-qualified service names. It will be all services in a set of
	// descriptor files or the set of all services exposed by a gRPC server.
	ListServices() ([]string, error)
	// FindSymbol returns a descriptor for the given fully-qualified symbol name.
	FindSymbol(fullyQualifiedName string) (desc.Descriptor, error)
	// AllExtensionsForType returns all known extension fields that extend the given message type name.
	AllExtensionsForType(typeName string) ([]*desc.FieldDescriptor, error)
}

DescriptorSource is a source of protobuf descriptor information. It can be backed by a FileDescriptorSet proto (like a file generated by protoc) or a remote server that supports the reflection API.

func DescriptorSourceFromFileDescriptorSet 

func DescriptorSourceFromFileDescriptorSet(files *descpb.FileDescriptorSet) (DescriptorSource, error)

DescriptorSourceFromFileDescriptorSet creates a DescriptorSource that is backed by the FileDescriptorSet.

func DescriptorSourceFromFileDescriptors 

func DescriptorSourceFromFileDescriptors(files ...*desc.FileDescriptor) (DescriptorSource, error)

DescriptorSourceFromFileDescriptorSet creates a DescriptorSource that is backed by the given file descriptors

func DescriptorSourceFromProtoFiles 

func DescriptorSourceFromProtoFiles(importPaths []string, fileNames ...string) (DescriptorSource, error)

DescriptorSourceFromProtoFiles creates a DescriptorSource that is backed by the named files, whose contents are Protocol Buffer source files. The given importPaths are used to locate any imported files.

func DescriptorSourceFromProtoSets 

func DescriptorSourceFromProtoSets(fileNames ...string) (DescriptorSource, error)

DescriptorSourceFromProtoSets creates a DescriptorSource that is backed by the named files, whose contents are encoded FileDescriptorSet protos.

func DescriptorSourceFromServer 

func DescriptorSourceFromServer(_ context.Context, refClient *grpcreflect.Client) DescriptorSource

DescriptorSourceFromServer creates a DescriptorSource that uses the given gRPC reflection client to interrogate a server for descriptor information. If the server does not support the reflection API then the various DescriptorSource methods will return ErrReflectionNotSupported

type EngineHandler 

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

func New 

func New(options ...Option) (*EngineHandler, error)

func (*EngineHandler) Call 

func (e *EngineHandler) Call(target, serviceName, methodName, data string) (*ResultModel, error)

func (*EngineHandler) CallWithAddr 

func (e *EngineHandler) CallWithAddr(target, serviceName, methodName, data string) (*ResultModel, error)

func (*EngineHandler) CallWithAddrCtx 

func (e *EngineHandler) CallWithAddrCtx(ctx context.Context, target, serviceName, methodName, data string) (*ResultModel, error)

func (*EngineHandler) CallWithClient 

func (e *EngineHandler) CallWithClient(client *grpc.ClientConn, serviceName, methodName, data string) (*ResultModel, error)

func (*EngineHandler) CallWithClientCtx 

func (e *EngineHandler) CallWithClientCtx(ctx context.Context, client *grpc.ClientConn, serviceName, methodName, data string) (*ResultModel, error)

func (*EngineHandler) CallWithCtx 

func (e *EngineHandler) CallWithCtx(ctx context.Context, target, serviceName, methodName, data string) (*ResultModel, error)

func (*EngineHandler) Close 

func (e *EngineHandler) Close() error

func (*EngineHandler) DoConnect 

func (e *EngineHandler) DoConnect(target string) (*grpc.ClientConn, error)

func (*EngineHandler) ExtractProtoType 

func (e *EngineHandler) ExtractProtoType(svc, mth string) (proto.Message, proto.Message, error)

func (*EngineHandler) Init 

func (e *EngineHandler) Init() error

func (*EngineHandler) ListMethods 

func (e *EngineHandler) ListMethods(svc string) ([]string, error)

func (*EngineHandler) ListServiceAndMethods 

func (e *EngineHandler) ListServiceAndMethods() (map[string][]ServMethodModel, error)

func (*EngineHandler) ListServices 

func (e *EngineHandler) ListServices() ([]string, error)

type EventHandler 

type EventHandler struct {
	// contains filtered or unexported fields
}
var DefaultEventHandler *EventHandler

func SetDefaultEventHandler 

func SetDefaultEventHandler(descSource DescriptorSource, formatter Formatter) *EventHandler

func (*EventHandler) FormatResponse 

func (h *EventHandler) FormatResponse(resp proto.Message) string

type Format 

type Format string

type Formatter 

type Formatter func(proto.Message) (string, error)

Formatter translates messages into string representations.

func NewJSONFormatter 

func NewJSONFormatter(emitDefaults bool, resolver jsonpb.AnyResolver) Formatter

NewJSONFormatter returns a formatter that returns JSON strings.

func ParseFormatterByDesc 

func ParseFormatterByDesc(descSource DescriptorSource, emitFields bool) (Formatter, error)

type InEventHooker 

type InEventHooker struct {
}

func (*InEventHooker) OnReceiveData 

func (h *InEventHooker) OnReceiveData(md metadata.MD, resp string, respErr error)

func (*InEventHooker) OnReceiveTrailers 

func (h *InEventHooker) OnReceiveTrailers(stat *status.Status, md metadata.MD)

type InvocationEventHandler 

type InvocationEventHandler interface {
	// OnReceiveHeaders is called when response headers and message have been received.
	OnReceiveData(metadata.MD, string, error)

	// OnReceiveTrailers is called when response trailers and final RPC status have been received.
	OnReceiveTrailers(*status.Status, metadata.MD)
}

InvocationEventHandler is a bag of callbacks for handling events that occur in the course of invoking an RPC.

type InvokeHandler 

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

func (*InvokeHandler) InvokeRPC 

func (in *InvokeHandler) InvokeRPC(ctx context.Context, source DescriptorSource, ch grpcdynamic.Channel, svc, mth string,
	headers []string, requestData RequestSupplier) (*ResultModel, error)

InvokeRPC uses the given gRPC channel to invoke the given method.

type Option 

type Option func(*EngineHandler) error

type ReqRespTypes 

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

type RequestParser 

type RequestParser interface {
	// Next parses input data into the given request message. If called after
	// input is exhausted, it returns io.EOF. If the caller re-uses the same
	// instance in multiple calls to Next, it should call msg.Reset() in between
	// each call.
	Next(msg proto.Message) error
}

RequestParser processes input into messages.

func NewJSONRequestParser 

func NewJSONRequestParser(in io.Reader, resolver jsonpb.AnyResolver) RequestParser

NewJSONRequestParser returns a RequestParser that reads data in JSON format from the given reader.

func RequestParserFor 

func RequestParserFor(descSource DescriptorSource, in io.Reader) (RequestParser, error)

type RequestSupplier 

type RequestSupplier func(proto.Message) error

RequestSupplier is a function that is called to populate messages for a gRPC operation.

type ResultModel 

type ResultModel struct {
	ResultChan chan string
	SendChan   chan []byte
	DoneChan   chan error
	Data       string
	RespHeader metadata.MD
	IsStream   bool
	Cancel     context.CancelFunc
}

func (*ResultModel) Close 

func (r *ResultModel) Close()

func (*ResultModel) IsClose 

func (r *ResultModel) IsClose()

func (*ResultModel) IsError 

func (r *ResultModel) IsError()

func (*ResultModel) Read 

func (r *ResultModel) Read()

func (*ResultModel) Write 

func (r *ResultModel) Write()

type ServMethodModel 

type ServMethodModel struct {
	PackageName     string
	ServiceName     string
	FullServiceName string
	MethodName      string
	FullMethodName  string
}

Source Files

View all Source files

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.