Documentation
¶
Index ¶
- Constants
- Variables
- func BuildStovepipeGatewayYARPCProcedures(server StovepipeGatewayYARPCServer) []transport.Procedure
- func NewFxStovepipeGatewayYARPCClient(name string, options ...v2.ClientOption) interface{}
- func NewFxStovepipeGatewayYARPCProcedures() interface{}
- func RegisterStovepipeGatewayServer(s grpc.ServiceRegistrar, srv StovepipeGatewayServer)
- type FxStovepipeGatewayYARPCClientParams
- type FxStovepipeGatewayYARPCClientResult
- type FxStovepipeGatewayYARPCProceduresParams
- type FxStovepipeGatewayYARPCProceduresResult
- type PingRequest
- type PingResponse
- func (*PingResponse) Descriptor() ([]byte, []int)deprecated
- func (x *PingResponse) GetHostname() string
- func (x *PingResponse) GetMessage() string
- func (x *PingResponse) GetServiceName() string
- func (x *PingResponse) GetTimestamp() int64
- func (*PingResponse) ProtoMessage()
- func (x *PingResponse) ProtoReflect() protoreflect.Message
- func (x *PingResponse) Reset()
- func (x *PingResponse) String() string
- type StovepipeGatewayClient
- type StovepipeGatewayServer
- type StovepipeGatewayYARPCClient
- type StovepipeGatewayYARPCServer
- type UnimplementedStovepipeGatewayServer
- type UnsafeStovepipeGatewayServer
Constants ¶
const (
StovepipeGateway_Ping_FullMethodName = "/uber.submitqueue.stovepipe.StovepipeGateway/Ping"
)
Variables ¶
var File_gateway_proto protoreflect.FileDescriptor
var StovepipeGateway_ServiceDesc = grpc.ServiceDesc{ ServiceName: "uber.submitqueue.stovepipe.StovepipeGateway", HandlerType: (*StovepipeGatewayServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Ping", Handler: _StovepipeGateway_Ping_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "gateway.proto", }
StovepipeGateway_ServiceDesc is the grpc.ServiceDesc for StovepipeGateway service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func BuildStovepipeGatewayYARPCProcedures ¶
func BuildStovepipeGatewayYARPCProcedures(server StovepipeGatewayYARPCServer) []transport.Procedure
BuildStovepipeGatewayYARPCProcedures prepares an implementation of the StovepipeGateway service for YARPC registration.
func NewFxStovepipeGatewayYARPCClient ¶
func NewFxStovepipeGatewayYARPCClient(name string, options ...v2.ClientOption) interface{}
NewFxStovepipeGatewayYARPCClient provides a StovepipeGatewayYARPCClient to an Fx application using the given name for routing.
fx.Provide(
protopb.NewFxStovepipeGatewayYARPCClient("service-name"),
...
)
func NewFxStovepipeGatewayYARPCProcedures ¶
func NewFxStovepipeGatewayYARPCProcedures() interface{}
NewFxStovepipeGatewayYARPCProcedures provides StovepipeGatewayYARPCServer procedures to an Fx application. It expects a StovepipeGatewayYARPCServer to be present in the container.
fx.Provide( protopb.NewFxStovepipeGatewayYARPCProcedures(), ... )
func RegisterStovepipeGatewayServer ¶
func RegisterStovepipeGatewayServer(s grpc.ServiceRegistrar, srv StovepipeGatewayServer)
Types ¶
type FxStovepipeGatewayYARPCClientParams ¶
type FxStovepipeGatewayYARPCClientParams struct {
fx.In
Provider yarpc.ClientConfig
AnyResolver v2.AnyResolver `name:"yarpcfx" optional:"true"`
Restriction restriction.Checker `optional:"true"`
}
FxStovepipeGatewayYARPCClientParams defines the input for NewFxStovepipeGatewayYARPCClient. It provides the paramaters to get a StovepipeGatewayYARPCClient in an Fx application.
type FxStovepipeGatewayYARPCClientResult ¶
type FxStovepipeGatewayYARPCClientResult struct {
fx.Out
Client StovepipeGatewayYARPCClient
}
FxStovepipeGatewayYARPCClientResult defines the output of NewFxStovepipeGatewayYARPCClient. It provides a StovepipeGatewayYARPCClient to an Fx application.
type FxStovepipeGatewayYARPCProceduresParams ¶
type FxStovepipeGatewayYARPCProceduresParams struct {
fx.In
Server StovepipeGatewayYARPCServer
AnyResolver v2.AnyResolver `name:"yarpcfx" optional:"true"`
}
FxStovepipeGatewayYARPCProceduresParams defines the input for NewFxStovepipeGatewayYARPCProcedures. It provides the paramaters to get StovepipeGatewayYARPCServer procedures in an Fx application.
type FxStovepipeGatewayYARPCProceduresResult ¶
type FxStovepipeGatewayYARPCProceduresResult struct {
fx.Out
Procedures []transport.Procedure `group:"yarpcfx"`
ReflectionMeta reflection.ServerMeta `group:"yarpcfx"`
}
FxStovepipeGatewayYARPCProceduresResult defines the output of NewFxStovepipeGatewayYARPCProcedures. It provides StovepipeGatewayYARPCServer procedures to an Fx application.
The procedures are provided to the "yarpcfx" value group. Dig 1.2 or newer must be used for this feature to work.
type PingRequest ¶
type PingRequest struct {
// Optional message to include in the ping
Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}
PingRequest is the request for the Ping method
func (*PingRequest) Descriptor
deprecated
func (*PingRequest) Descriptor() ([]byte, []int)
Deprecated: Use PingRequest.ProtoReflect.Descriptor instead.
func (*PingRequest) GetMessage ¶
func (x *PingRequest) GetMessage() string
func (*PingRequest) ProtoMessage ¶
func (*PingRequest) ProtoMessage()
func (*PingRequest) ProtoReflect ¶
func (x *PingRequest) ProtoReflect() protoreflect.Message
func (*PingRequest) Reset ¶
func (x *PingRequest) Reset()
func (*PingRequest) String ¶
func (x *PingRequest) String() string
type PingResponse ¶
type PingResponse struct {
// The response message
Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
// The service name that handled the request
ServiceName string `protobuf:"bytes,2,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
// Timestamp of when the ping was received
Timestamp int64 `protobuf:"varint,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
// Hostname of the server that handled the request
Hostname string `protobuf:"bytes,4,opt,name=hostname,proto3" json:"hostname,omitempty"`
// contains filtered or unexported fields
}
PingResponse is the response for the Ping method
func (*PingResponse) Descriptor
deprecated
func (*PingResponse) Descriptor() ([]byte, []int)
Deprecated: Use PingResponse.ProtoReflect.Descriptor instead.
func (*PingResponse) GetHostname ¶
func (x *PingResponse) GetHostname() string
func (*PingResponse) GetMessage ¶
func (x *PingResponse) GetMessage() string
func (*PingResponse) GetServiceName ¶
func (x *PingResponse) GetServiceName() string
func (*PingResponse) GetTimestamp ¶
func (x *PingResponse) GetTimestamp() int64
func (*PingResponse) ProtoMessage ¶
func (*PingResponse) ProtoMessage()
func (*PingResponse) ProtoReflect ¶
func (x *PingResponse) ProtoReflect() protoreflect.Message
func (*PingResponse) Reset ¶
func (x *PingResponse) Reset()
func (*PingResponse) String ¶
func (x *PingResponse) String() string
type StovepipeGatewayClient ¶
type StovepipeGatewayClient interface {
// Ping returns a response indicating the service is alive
Ping(ctx context.Context, in *PingRequest, opts ...grpc.CallOption) (*PingResponse, error)
}
StovepipeGatewayClient is the client API for StovepipeGateway 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.
StovepipeGateway provides the Stovepipe gateway API.
func NewStovepipeGatewayClient ¶
func NewStovepipeGatewayClient(cc grpc.ClientConnInterface) StovepipeGatewayClient
type StovepipeGatewayServer ¶
type StovepipeGatewayServer interface {
// Ping returns a response indicating the service is alive
Ping(context.Context, *PingRequest) (*PingResponse, error)
// contains filtered or unexported methods
}
StovepipeGatewayServer is the server API for StovepipeGateway service. All implementations must embed UnimplementedStovepipeGatewayServer for forward compatibility.
StovepipeGateway provides the Stovepipe gateway API.
type StovepipeGatewayYARPCClient ¶
type StovepipeGatewayYARPCClient interface {
Ping(context.Context, *PingRequest, ...yarpc.CallOption) (*PingResponse, error)
}
StovepipeGatewayYARPCClient is the YARPC client-side interface for the StovepipeGateway service.
func NewStovepipeGatewayYARPCClient ¶
func NewStovepipeGatewayYARPCClient(clientConfig transport.ClientConfig, options ...v2.ClientOption) StovepipeGatewayYARPCClient
NewStovepipeGatewayYARPCClient builds a new YARPC client for the StovepipeGateway service.
type StovepipeGatewayYARPCServer ¶
type StovepipeGatewayYARPCServer interface {
Ping(context.Context, *PingRequest) (*PingResponse, error)
}
StovepipeGatewayYARPCServer is the YARPC server-side interface for the StovepipeGateway service.
type UnimplementedStovepipeGatewayServer ¶
type UnimplementedStovepipeGatewayServer struct{}
UnimplementedStovepipeGatewayServer 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 (UnimplementedStovepipeGatewayServer) Ping ¶
func (UnimplementedStovepipeGatewayServer) Ping(context.Context, *PingRequest) (*PingResponse, error)
type UnsafeStovepipeGatewayServer ¶
type UnsafeStovepipeGatewayServer interface {
// contains filtered or unexported methods
}
UnsafeStovepipeGatewayServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to StovepipeGatewayServer will result in compilation errors.