Documentation
¶
Overview ¶
Package e2e is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterGreeterHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterGreeterHandlerClient(ctx context.Context, mux *runtime.ServeMux, client GreeterClient) error
- func RegisterGreeterHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterGreeterHandlerServer(ctx context.Context, mux *runtime.ServeMux, server GreeterServer) error
- func RegisterGreeterServer(s grpc.ServiceRegistrar, srv GreeterServer)
- type Basic
- func (*Basic) Descriptor() ([]byte, []int)deprecated
- func (x *Basic) GetA() string
- func (m *Basic) GetB() isBasic_B
- func (x *Basic) GetInt() int32
- func (x *Basic) GetMap() map[string]string
- func (x *Basic) GetO() string
- func (x *Basic) GetStr() string
- func (*Basic) ProtoMessage()
- func (x *Basic) ProtoReflect() protoreflect.Message
- func (x *Basic) Reset()
- func (x *Basic) String() string
- type Basic_Int
- type Basic_Str
- type GreeterAdapter
- func (a *GreeterAdapter) SayHello(ctx context.Context, req *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error)
- func (a *GreeterAdapter) SayHelloPost(ctx context.Context, req *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error)
- func (a *GreeterAdapter) SayHttp(ctx context.Context, req *HelloRequest, opts ...grpc.CallOption) (*annotations.Http, error)
- type GreeterClient
- type GreeterGatewayClient
- type GreeterGatewayClientAdapter
- func (a *GreeterGatewayClientAdapter) SayHello(ctx context.Context, req *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error)
- func (a *GreeterGatewayClientAdapter) SayHelloPost(ctx context.Context, req *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error)
- func (a *GreeterGatewayClientAdapter) SayHttp(ctx context.Context, req *HelloRequest, opts ...grpc.CallOption) (*annotations.Http, error)
- type GreeterServer
- type HelloReply
- type HelloRequest
- type Nested
- type Nested_Message
- type UnimplementedGreeterServer
- type UnsafeGreeterServer
Constants ¶
const ( Greeter_SayHello_FullMethodName = "/e2e.Greeter/SayHello" Greeter_SayHelloPost_FullMethodName = "/e2e.Greeter/SayHelloPost" Greeter_SayHttp_FullMethodName = "/e2e.Greeter/SayHttp" )
Variables ¶
var File_e2e_proto protoreflect.FileDescriptor
var Greeter_ServiceDesc = grpc.ServiceDesc{ ServiceName: "e2e.Greeter", HandlerType: (*GreeterServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "SayHello", Handler: _Greeter_SayHello_Handler, }, { MethodName: "SayHelloPost", Handler: _Greeter_SayHelloPost_Handler, }, { MethodName: "SayHttp", Handler: _Greeter_SayHttp_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "e2e.proto", }
Greeter_ServiceDesc is the grpc.ServiceDesc for Greeter service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterGreeterHandler ¶
func RegisterGreeterHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterGreeterHandler registers the http handlers for service Greeter to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterGreeterHandlerClient ¶
func RegisterGreeterHandlerClient(ctx context.Context, mux *runtime.ServeMux, client GreeterClient) error
RegisterGreeterHandlerClient registers the http handlers for service Greeter to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "GreeterClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "GreeterClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "GreeterClient" to call the correct interceptors.
func RegisterGreeterHandlerFromEndpoint ¶
func RegisterGreeterHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterGreeterHandlerFromEndpoint is same as RegisterGreeterHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterGreeterHandlerServer ¶
func RegisterGreeterHandlerServer(ctx context.Context, mux *runtime.ServeMux, server GreeterServer) error
RegisterGreeterHandlerServer registers the http handlers for service Greeter to "mux". UnaryRPC :call GreeterServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterGreeterHandlerFromEndpoint instead.
func RegisterGreeterServer ¶
func RegisterGreeterServer(s grpc.ServiceRegistrar, srv GreeterServer)
Types ¶
type Basic ¶
type Basic struct { A string `protobuf:"bytes,1,opt,name=a,proto3" json:"a,omitempty"` // Types that are assignable to B: // // *Basic_Int // *Basic_Str B isBasic_B `protobuf_oneof:"b"` Map map[string]string `` /* 147-byte string literal not displayed */ O *string `protobuf:"bytes,5,opt,name=o,proto3,oneof" json:"o,omitempty"` // contains filtered or unexported fields }
Basic just tests basic fields, including oneofs and so on that don't generally work automatically with encoding/json.
func (*Basic) Descriptor
deprecated
func (*Basic) ProtoMessage ¶
func (*Basic) ProtoMessage()
func (*Basic) ProtoReflect ¶
func (x *Basic) ProtoReflect() protoreflect.Message
type Basic_Int ¶
type Basic_Int struct {
Int int32 `protobuf:"varint,2,opt,name=int,proto3,oneof"`
}
type Basic_Str ¶
type Basic_Str struct {
Str string `protobuf:"bytes,3,opt,name=str,proto3,oneof"`
}
type GreeterAdapter ¶
type GreeterAdapter struct {
// contains filtered or unexported fields
}
GreeterAdapter is the adapter for Greeter server into Greeter client interface
func (*GreeterAdapter) SayHello ¶
func (a *GreeterAdapter) SayHello(ctx context.Context, req *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error)
func (*GreeterAdapter) SayHelloPost ¶
func (a *GreeterAdapter) SayHelloPost(ctx context.Context, req *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error)
func (*GreeterAdapter) SayHttp ¶
func (a *GreeterAdapter) SayHttp(ctx context.Context, req *HelloRequest, opts ...grpc.CallOption) (*annotations.Http, error)
type GreeterClient ¶
type GreeterClient interface { // Sends a greeting SayHello(ctx context.Context, in *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error) SayHelloPost(ctx context.Context, in *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error) SayHttp(ctx context.Context, in *HelloRequest, opts ...grpc.CallOption) (*annotations.Http, error) }
GreeterClient is the client API for Greeter service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
The greeting service definition.
func NewGreeterAdapter ¶
func NewGreeterAdapter(in GreeterServer) GreeterClient
func NewGreeterClient ¶
func NewGreeterClient(cc grpc.ClientConnInterface) GreeterClient
func NewGreeterGatewayClientAdapter ¶
func NewGreeterGatewayClientAdapter(in GreeterGatewayClient) GreeterClient
type GreeterGatewayClient ¶
type GreeterGatewayClient interface { // Sends a greeting SayHello(context.Context, *HelloRequest) (*HelloReply, error) SayHelloPost(context.Context, *HelloRequest) (*HelloReply, error) SayHttp(context.Context, *HelloRequest) (*annotations.Http, error) }
GreeterGatewayClient is the interface for Greeter service client.
func NewGreeterGatewayClient ¶
func NewGreeterGatewayClient(c gateway.Client) GreeterGatewayClient
type GreeterGatewayClientAdapter ¶
type GreeterGatewayClientAdapter struct {
// contains filtered or unexported fields
}
GreeterGatewayClientAdapter is the adapter for Greeter server into Greeter client interface
func (*GreeterGatewayClientAdapter) SayHello ¶
func (a *GreeterGatewayClientAdapter) SayHello(ctx context.Context, req *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error)
func (*GreeterGatewayClientAdapter) SayHelloPost ¶
func (a *GreeterGatewayClientAdapter) SayHelloPost(ctx context.Context, req *HelloRequest, opts ...grpc.CallOption) (*HelloReply, error)
func (*GreeterGatewayClientAdapter) SayHttp ¶
func (a *GreeterGatewayClientAdapter) SayHttp(ctx context.Context, req *HelloRequest, opts ...grpc.CallOption) (*annotations.Http, error)
type GreeterServer ¶
type GreeterServer interface { // Sends a greeting SayHello(context.Context, *HelloRequest) (*HelloReply, error) SayHelloPost(context.Context, *HelloRequest) (*HelloReply, error) SayHttp(context.Context, *HelloRequest) (*annotations.Http, error) // contains filtered or unexported methods }
GreeterServer is the server API for Greeter service. All implementations must embed UnimplementedGreeterServer for forward compatibility.
The greeting service definition.
type HelloReply ¶
type HelloReply struct { Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"` // contains filtered or unexported fields }
The response message containing the greetings
func (*HelloReply) Descriptor
deprecated
func (*HelloReply) Descriptor() ([]byte, []int)
Deprecated: Use HelloReply.ProtoReflect.Descriptor instead.
func (*HelloReply) GetMessage ¶
func (x *HelloReply) GetMessage() string
func (*HelloReply) ProtoMessage ¶
func (*HelloReply) ProtoMessage()
func (*HelloReply) ProtoReflect ¶
func (x *HelloReply) ProtoReflect() protoreflect.Message
func (*HelloReply) Reset ¶
func (x *HelloReply) Reset()
func (*HelloReply) String ¶
func (x *HelloReply) String() string
type HelloRequest ¶
type HelloRequest struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
The request message containing the user's name.
func (*HelloRequest) Descriptor
deprecated
func (*HelloRequest) Descriptor() ([]byte, []int)
Deprecated: Use HelloRequest.ProtoReflect.Descriptor instead.
func (*HelloRequest) GetName ¶
func (x *HelloRequest) GetName() string
func (*HelloRequest) ProtoMessage ¶
func (*HelloRequest) ProtoMessage()
func (*HelloRequest) ProtoReflect ¶
func (x *HelloRequest) ProtoReflect() protoreflect.Message
func (*HelloRequest) Reset ¶
func (x *HelloRequest) Reset()
func (*HelloRequest) String ¶
func (x *HelloRequest) String() string
type Nested ¶
type Nested struct {
// contains filtered or unexported fields
}
Test nested types
func (*Nested) Descriptor
deprecated
func (*Nested) ProtoMessage ¶
func (*Nested) ProtoMessage()
func (*Nested) ProtoReflect ¶
func (x *Nested) ProtoReflect() protoreflect.Message
type Nested_Message ¶
type Nested_Message struct { Basic *Basic `protobuf:"bytes,1,opt,name=basic,proto3" json:"basic,omitempty"` // contains filtered or unexported fields }
func (*Nested_Message) Descriptor
deprecated
func (*Nested_Message) Descriptor() ([]byte, []int)
Deprecated: Use Nested_Message.ProtoReflect.Descriptor instead.
func (*Nested_Message) GetBasic ¶
func (x *Nested_Message) GetBasic() *Basic
func (*Nested_Message) ProtoMessage ¶
func (*Nested_Message) ProtoMessage()
func (*Nested_Message) ProtoReflect ¶
func (x *Nested_Message) ProtoReflect() protoreflect.Message
func (*Nested_Message) Reset ¶
func (x *Nested_Message) Reset()
func (*Nested_Message) String ¶
func (x *Nested_Message) String() string
type UnimplementedGreeterServer ¶
type UnimplementedGreeterServer struct{}
UnimplementedGreeterServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedGreeterServer) SayHello ¶
func (UnimplementedGreeterServer) SayHello(context.Context, *HelloRequest) (*HelloReply, error)
func (UnimplementedGreeterServer) SayHelloPost ¶
func (UnimplementedGreeterServer) SayHelloPost(context.Context, *HelloRequest) (*HelloReply, error)
func (UnimplementedGreeterServer) SayHttp ¶
func (UnimplementedGreeterServer) SayHttp(context.Context, *HelloRequest) (*annotations.Http, error)
type UnsafeGreeterServer ¶
type UnsafeGreeterServer interface {
// contains filtered or unexported methods
}
UnsafeGreeterServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to GreeterServer will result in compilation errors.