Documentation ¶
Overview ¶
Package examples is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func DisableEchoService_Service()
- func Disable_CUSTOM_EASE_GATEWAY_TEST__default__grpc_ServiceGroup()
- func EnableEchoService_Service(spec *skypb.ServiceSpec, conn *grpc.ClientConn)
- func Enable_CUSTOM_EASE_GATEWAY_TEST__default__grpc_ServiceGroup()
- func RegisterEchoServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterEchoServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client EchoServiceClient) error
- func RegisterEchoServiceHandlerFromEndpoint(mux *runtime.ServeMux) (err error)
- func RegisterEchoServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server EchoServiceServer) error
- func RegisterEchoServiceServer(s *grpc.Server, srv EchoServiceServer)
- func Validate__grpc_gateway_proto_examples_SimpleMessage(v *SimpleMessage) error
- type EchoServiceClient
- type EchoServiceServer
- type Embedded
- func (*Embedded) Descriptor() ([]byte, []int)deprecated
- func (m *Embedded) GetMark() isEmbedded_Mark
- func (x *Embedded) GetNote() string
- func (x *Embedded) GetProgress() int64
- func (*Embedded) ProtoMessage()
- func (x *Embedded) ProtoReflect() protoreflect.Message
- func (x *Embedded) Reset()
- func (x *Embedded) String() string
- type Embedded_Note
- type Embedded_Progress
- type SimpleMessage
- func (*SimpleMessage) Descriptor() ([]byte, []int)deprecated
- func (m *SimpleMessage) GetCode() isSimpleMessage_Code
- func (x *SimpleMessage) GetEn() int64
- func (m *SimpleMessage) GetExt() isSimpleMessage_Ext
- func (x *SimpleMessage) GetId() string
- func (x *SimpleMessage) GetLang() string
- func (x *SimpleMessage) GetLineNum() int64
- func (x *SimpleMessage) GetNo() *Embedded
- func (x *SimpleMessage) GetNum() int64
- func (x *SimpleMessage) GetStatus() *Embedded
- func (*SimpleMessage) ProtoMessage()
- func (x *SimpleMessage) ProtoReflect() protoreflect.Message
- func (x *SimpleMessage) Reset()
- func (x *SimpleMessage) String() string
- type SimpleMessage_En
- type SimpleMessage_Lang
- type SimpleMessage_LineNum
- type SimpleMessage_No
- type UnimplementedEchoServiceServer
- func (*UnimplementedEchoServiceServer) Echo(context.Context, *SimpleMessage) (*SimpleMessage, error)
- func (*UnimplementedEchoServiceServer) EchoBody(context.Context, *SimpleMessage) (*SimpleMessage, error)
- func (*UnimplementedEchoServiceServer) EchoDelete(context.Context, *SimpleMessage) (*SimpleMessage, error)
Constants ¶
This section is empty.
Variables ¶
var File_proto_examples_echo_service_proto protoreflect.FileDescriptor
Functions ¶
func DisableEchoService_Service ¶
func DisableEchoService_Service()
func Disable_CUSTOM_EASE_GATEWAY_TEST__default__grpc_ServiceGroup ¶
func Disable_CUSTOM_EASE_GATEWAY_TEST__default__grpc_ServiceGroup()
func EnableEchoService_Service ¶
func EnableEchoService_Service(spec *skypb.ServiceSpec, conn *grpc.ClientConn)
func Enable_CUSTOM_EASE_GATEWAY_TEST__default__grpc_ServiceGroup ¶
func Enable_CUSTOM_EASE_GATEWAY_TEST__default__grpc_ServiceGroup()
func RegisterEchoServiceHandler ¶
func RegisterEchoServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterEchoServiceHandler registers the http handlers for service EchoService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterEchoServiceHandlerClient ¶
func RegisterEchoServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client EchoServiceClient) error
RegisterEchoServiceHandlerClient registers the http handlers for service EchoService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "EchoServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "EchoServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "EchoServiceClient" to call the correct interceptors.
func RegisterEchoServiceHandlerFromEndpoint ¶
RegisterEchoServiceHandlerFromEndpoint is same as RegisterEchoServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterEchoServiceHandlerServer ¶
func RegisterEchoServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server EchoServiceServer) error
RegisterEchoServiceHandlerServer registers the http handlers for service EchoService to "mux". UnaryRPC :call EchoServiceServer 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 (such as grpc.SendHeader, etc) to stop working. Consider using RegisterEchoServiceHandlerFromEndpoint instead.
func RegisterEchoServiceServer ¶
func RegisterEchoServiceServer(s *grpc.Server, srv EchoServiceServer)
func Validate__grpc_gateway_proto_examples_SimpleMessage ¶
func Validate__grpc_gateway_proto_examples_SimpleMessage(v *SimpleMessage) error
Types ¶
type EchoServiceClient ¶
type EchoServiceClient interface { Echo(ctx context.Context, in *SimpleMessage, opts ...grpc.CallOption) (*SimpleMessage, error) EchoBody(ctx context.Context, in *SimpleMessage, opts ...grpc.CallOption) (*SimpleMessage, error) EchoDelete(ctx context.Context, in *SimpleMessage, opts ...grpc.CallOption) (*SimpleMessage, error) }
EchoServiceClient is the client API for EchoService 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.
func NewEchoServiceClient ¶
func NewEchoServiceClient(cc grpc.ClientConnInterface) EchoServiceClient
type EchoServiceServer ¶
type EchoServiceServer interface { Echo(context.Context, *SimpleMessage) (*SimpleMessage, error) EchoBody(context.Context, *SimpleMessage) (*SimpleMessage, error) EchoDelete(context.Context, *SimpleMessage) (*SimpleMessage, error) }
EchoServiceServer is the server API for EchoService service.
type Embedded ¶
type Embedded struct { // Types that are assignable to Mark: // *Embedded_Progress // *Embedded_Note Mark isEmbedded_Mark `protobuf_oneof:"mark"` // contains filtered or unexported fields }
func (*Embedded) Descriptor
deprecated
func (*Embedded) GetProgress ¶
func (*Embedded) ProtoMessage ¶
func (*Embedded) ProtoMessage()
func (*Embedded) ProtoReflect ¶
func (x *Embedded) ProtoReflect() protoreflect.Message
type Embedded_Note ¶
type Embedded_Note struct {
Note string `protobuf:"bytes,2,opt,name=note,proto3,oneof"`
}
type Embedded_Progress ¶
type Embedded_Progress struct {
Progress int64 `protobuf:"varint,1,opt,name=progress,proto3,oneof"`
}
type SimpleMessage ¶
type SimpleMessage struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Num int64 `protobuf:"varint,2,opt,name=num,proto3" json:"num,omitempty"` // Types that are assignable to Code: // *SimpleMessage_LineNum // *SimpleMessage_Lang Code isSimpleMessage_Code `protobuf_oneof:"code"` Status *Embedded `protobuf:"bytes,5,opt,name=status,proto3" json:"status,omitempty"` // Types that are assignable to Ext: // *SimpleMessage_En // *SimpleMessage_No Ext isSimpleMessage_Ext `protobuf_oneof:"ext"` // contains filtered or unexported fields }
func (*SimpleMessage) Descriptor
deprecated
func (*SimpleMessage) Descriptor() ([]byte, []int)
Deprecated: Use SimpleMessage.ProtoReflect.Descriptor instead.
func (*SimpleMessage) GetCode ¶
func (m *SimpleMessage) GetCode() isSimpleMessage_Code
func (*SimpleMessage) GetEn ¶
func (x *SimpleMessage) GetEn() int64
func (*SimpleMessage) GetExt ¶
func (m *SimpleMessage) GetExt() isSimpleMessage_Ext
func (*SimpleMessage) GetId ¶
func (x *SimpleMessage) GetId() string
func (*SimpleMessage) GetLang ¶
func (x *SimpleMessage) GetLang() string
func (*SimpleMessage) GetLineNum ¶
func (x *SimpleMessage) GetLineNum() int64
func (*SimpleMessage) GetNo ¶
func (x *SimpleMessage) GetNo() *Embedded
func (*SimpleMessage) GetNum ¶
func (x *SimpleMessage) GetNum() int64
func (*SimpleMessage) GetStatus ¶
func (x *SimpleMessage) GetStatus() *Embedded
func (*SimpleMessage) ProtoMessage ¶
func (*SimpleMessage) ProtoMessage()
func (*SimpleMessage) ProtoReflect ¶
func (x *SimpleMessage) ProtoReflect() protoreflect.Message
func (*SimpleMessage) Reset ¶
func (x *SimpleMessage) Reset()
func (*SimpleMessage) String ¶
func (x *SimpleMessage) String() string
type SimpleMessage_En ¶
type SimpleMessage_En struct {
En int64 `protobuf:"varint,6,opt,name=en,proto3,oneof"`
}
type SimpleMessage_Lang ¶
type SimpleMessage_Lang struct {
Lang string `protobuf:"bytes,4,opt,name=lang,proto3,oneof"`
}
type SimpleMessage_LineNum ¶
type SimpleMessage_LineNum struct {
LineNum int64 `protobuf:"varint,3,opt,name=line_num,json=lineNum,proto3,oneof"`
}
type SimpleMessage_No ¶
type SimpleMessage_No struct {
No *Embedded `protobuf:"bytes,7,opt,name=no,proto3,oneof"`
}
type UnimplementedEchoServiceServer ¶
type UnimplementedEchoServiceServer struct { }
UnimplementedEchoServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedEchoServiceServer) Echo ¶
func (*UnimplementedEchoServiceServer) Echo(context.Context, *SimpleMessage) (*SimpleMessage, error)
func (*UnimplementedEchoServiceServer) EchoBody ¶
func (*UnimplementedEchoServiceServer) EchoBody(context.Context, *SimpleMessage) (*SimpleMessage, error)
func (*UnimplementedEchoServiceServer) EchoDelete ¶
func (*UnimplementedEchoServiceServer) EchoDelete(context.Context, *SimpleMessage) (*SimpleMessage, error)