mirror of https://github.com/grpc/grpc-go.git
protoc-gen-go-grpc: add period to end of generated comment (#7392)
This commit is contained in:
parent
ee62e56b2e
commit
e7d88223a7
|
|
@ -72,7 +72,7 @@ type LoadBalancer_BalanceLoadClient = grpc.BidiStreamingClient[LoadBalanceReques
|
||||||
|
|
||||||
// LoadBalancerServer is the server API for LoadBalancer service.
|
// LoadBalancerServer is the server API for LoadBalancer service.
|
||||||
// All implementations should embed UnimplementedLoadBalancerServer
|
// All implementations should embed UnimplementedLoadBalancerServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
type LoadBalancerServer interface {
|
type LoadBalancerServer interface {
|
||||||
// Bidirectional rpc to get a list of servers.
|
// Bidirectional rpc to get a list of servers.
|
||||||
BalanceLoad(grpc.BidiStreamingServer[LoadBalanceRequest, LoadBalanceResponse]) error
|
BalanceLoad(grpc.BidiStreamingServer[LoadBalanceRequest, LoadBalanceResponse]) error
|
||||||
|
|
|
||||||
|
|
@ -153,7 +153,7 @@ func (c *channelzClient) GetSocket(ctx context.Context, in *GetSocketRequest, op
|
||||||
|
|
||||||
// ChannelzServer is the server API for Channelz service.
|
// ChannelzServer is the server API for Channelz service.
|
||||||
// All implementations should embed UnimplementedChannelzServer
|
// All implementations should embed UnimplementedChannelzServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// Channelz is a service exposed by gRPC servers that provides detailed debug
|
// Channelz is a service exposed by gRPC servers that provides detailed debug
|
||||||
// information.
|
// information.
|
||||||
|
|
|
||||||
|
|
@ -264,7 +264,7 @@ func genService(gen *protogen.Plugin, file *protogen.File, g *protogen.Generated
|
||||||
serverType := service.GoName + "Server"
|
serverType := service.GoName + "Server"
|
||||||
g.P("// ", serverType, " is the server API for ", service.GoName, " service.")
|
g.P("// ", serverType, " is the server API for ", service.GoName, " service.")
|
||||||
g.P("// All implementations ", mustOrShould, " embed Unimplemented", serverType)
|
g.P("// All implementations ", mustOrShould, " embed Unimplemented", serverType)
|
||||||
g.P("// for forward compatibility")
|
g.P("// for forward compatibility.")
|
||||||
|
|
||||||
// Copy comments from proto file.
|
// Copy comments from proto file.
|
||||||
genServiceComments(g, service)
|
genServiceComments(g, service)
|
||||||
|
|
|
||||||
|
|
@ -75,7 +75,7 @@ type HandshakerService_DoHandshakeClient = grpc.BidiStreamingClient[HandshakerRe
|
||||||
|
|
||||||
// HandshakerServiceServer is the server API for HandshakerService service.
|
// HandshakerServiceServer is the server API for HandshakerService service.
|
||||||
// All implementations must embed UnimplementedHandshakerServiceServer
|
// All implementations must embed UnimplementedHandshakerServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
type HandshakerServiceServer interface {
|
type HandshakerServiceServer interface {
|
||||||
// Handshaker service accepts a stream of handshaker request, returning a
|
// Handshaker service accepts a stream of handshaker request, returning a
|
||||||
// stream of handshaker response. Client is expected to send exactly one
|
// stream of handshaker response. Client is expected to send exactly one
|
||||||
|
|
|
||||||
|
|
@ -123,7 +123,7 @@ type Echo_BidirectionalStreamingEchoClient = grpc.BidiStreamingClient[EchoReques
|
||||||
|
|
||||||
// EchoServer is the server API for Echo service.
|
// EchoServer is the server API for Echo service.
|
||||||
// All implementations must embed UnimplementedEchoServer
|
// All implementations must embed UnimplementedEchoServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// Echo is the echo service.
|
// Echo is the echo service.
|
||||||
type EchoServer interface {
|
type EchoServer interface {
|
||||||
|
|
|
||||||
|
|
@ -66,7 +66,7 @@ func (c *greeterClient) SayHello(ctx context.Context, in *HelloRequest, opts ...
|
||||||
|
|
||||||
// GreeterServer is the server API for Greeter service.
|
// GreeterServer is the server API for Greeter service.
|
||||||
// All implementations must embed UnimplementedGreeterServer
|
// All implementations must embed UnimplementedGreeterServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// The greeting service definition.
|
// The greeting service definition.
|
||||||
type GreeterServer interface {
|
type GreeterServer interface {
|
||||||
|
|
|
||||||
|
|
@ -136,7 +136,7 @@ type RouteGuide_RouteChatClient = grpc.BidiStreamingClient[RouteNote, RouteNote]
|
||||||
|
|
||||||
// RouteGuideServer is the server API for RouteGuide service.
|
// RouteGuideServer is the server API for RouteGuide service.
|
||||||
// All implementations must embed UnimplementedRouteGuideServer
|
// All implementations must embed UnimplementedRouteGuideServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// Interface exported by the server.
|
// Interface exported by the server.
|
||||||
type RouteGuideServer interface {
|
type RouteGuideServer interface {
|
||||||
|
|
|
||||||
|
|
@ -115,7 +115,7 @@ type Health_WatchClient = grpc.ServerStreamingClient[HealthCheckResponse]
|
||||||
|
|
||||||
// HealthServer is the server API for Health service.
|
// HealthServer is the server API for Health service.
|
||||||
// All implementations should embed UnimplementedHealthServer
|
// All implementations should embed UnimplementedHealthServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// Health is gRPC's mechanism for checking whether a server is able to handle
|
// Health is gRPC's mechanism for checking whether a server is able to handle
|
||||||
// RPCs. Its semantics are documented in
|
// RPCs. Its semantics are documented in
|
||||||
|
|
|
||||||
|
|
@ -64,7 +64,7 @@ func (c *routeLookupServiceClient) RouteLookup(ctx context.Context, in *RouteLoo
|
||||||
|
|
||||||
// RouteLookupServiceServer is the server API for RouteLookupService service.
|
// RouteLookupServiceServer is the server API for RouteLookupService service.
|
||||||
// All implementations must embed UnimplementedRouteLookupServiceServer
|
// All implementations must embed UnimplementedRouteLookupServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
type RouteLookupServiceServer interface {
|
type RouteLookupServiceServer interface {
|
||||||
// Lookup returns a target for a single key.
|
// Lookup returns a target for a single key.
|
||||||
RouteLookup(context.Context, *RouteLookupRequest) (*RouteLookupResponse, error)
|
RouteLookup(context.Context, *RouteLookupRequest) (*RouteLookupResponse, error)
|
||||||
|
|
|
||||||
|
|
@ -143,7 +143,7 @@ type BenchmarkService_StreamingBothWaysClient = grpc.BidiStreamingClient[SimpleR
|
||||||
|
|
||||||
// BenchmarkServiceServer is the server API for BenchmarkService service.
|
// BenchmarkServiceServer is the server API for BenchmarkService service.
|
||||||
// All implementations must embed UnimplementedBenchmarkServiceServer
|
// All implementations must embed UnimplementedBenchmarkServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
type BenchmarkServiceServer interface {
|
type BenchmarkServiceServer interface {
|
||||||
// One request followed by one response.
|
// One request followed by one response.
|
||||||
// The server returns the client payload as-is.
|
// The server returns the client payload as-is.
|
||||||
|
|
|
||||||
|
|
@ -67,7 +67,7 @@ func (c *reportQpsScenarioServiceClient) ReportScenario(ctx context.Context, in
|
||||||
|
|
||||||
// ReportQpsScenarioServiceServer is the server API for ReportQpsScenarioService service.
|
// ReportQpsScenarioServiceServer is the server API for ReportQpsScenarioService service.
|
||||||
// All implementations must embed UnimplementedReportQpsScenarioServiceServer
|
// All implementations must embed UnimplementedReportQpsScenarioServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
type ReportQpsScenarioServiceServer interface {
|
type ReportQpsScenarioServiceServer interface {
|
||||||
// Report results of a QPS test benchmark scenario.
|
// Report results of a QPS test benchmark scenario.
|
||||||
ReportScenario(context.Context, *ScenarioResult) (*Void, error)
|
ReportScenario(context.Context, *ScenarioResult) (*Void, error)
|
||||||
|
|
|
||||||
|
|
@ -189,7 +189,7 @@ func (c *testServiceClient) UnimplementedCall(ctx context.Context, in *Empty, op
|
||||||
|
|
||||||
// TestServiceServer is the server API for TestService service.
|
// TestServiceServer is the server API for TestService service.
|
||||||
// All implementations must embed UnimplementedTestServiceServer
|
// All implementations must embed UnimplementedTestServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// A simple service to test the various types of RPCs and experiment with
|
// A simple service to test the various types of RPCs and experiment with
|
||||||
// performance with various types of payload.
|
// performance with various types of payload.
|
||||||
|
|
@ -454,7 +454,7 @@ func (c *unimplementedServiceClient) UnimplementedCall(ctx context.Context, in *
|
||||||
|
|
||||||
// UnimplementedServiceServer is the server API for UnimplementedService service.
|
// UnimplementedServiceServer is the server API for UnimplementedService service.
|
||||||
// All implementations must embed UnimplementedUnimplementedServiceServer
|
// All implementations must embed UnimplementedUnimplementedServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// A simple service NOT implemented at servers so clients can test for
|
// A simple service NOT implemented at servers so clients can test for
|
||||||
// that case.
|
// that case.
|
||||||
|
|
@ -563,7 +563,7 @@ func (c *reconnectServiceClient) Stop(ctx context.Context, in *Empty, opts ...gr
|
||||||
|
|
||||||
// ReconnectServiceServer is the server API for ReconnectService service.
|
// ReconnectServiceServer is the server API for ReconnectService service.
|
||||||
// All implementations must embed UnimplementedReconnectServiceServer
|
// All implementations must embed UnimplementedReconnectServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// A service used to control reconnect server.
|
// A service used to control reconnect server.
|
||||||
type ReconnectServiceServer interface {
|
type ReconnectServiceServer interface {
|
||||||
|
|
@ -698,7 +698,7 @@ func (c *loadBalancerStatsServiceClient) GetClientAccumulatedStats(ctx context.C
|
||||||
|
|
||||||
// LoadBalancerStatsServiceServer is the server API for LoadBalancerStatsService service.
|
// LoadBalancerStatsServiceServer is the server API for LoadBalancerStatsService service.
|
||||||
// All implementations must embed UnimplementedLoadBalancerStatsServiceServer
|
// All implementations must embed UnimplementedLoadBalancerStatsServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// A service used to obtain stats for verifying LB behavior.
|
// A service used to obtain stats for verifying LB behavior.
|
||||||
type LoadBalancerStatsServiceServer interface {
|
type LoadBalancerStatsServiceServer interface {
|
||||||
|
|
@ -850,7 +850,7 @@ func (c *hookServiceClient) ClearReturnStatus(ctx context.Context, in *Empty, op
|
||||||
|
|
||||||
// HookServiceServer is the server API for HookService service.
|
// HookServiceServer is the server API for HookService service.
|
||||||
// All implementations must embed UnimplementedHookServiceServer
|
// All implementations must embed UnimplementedHookServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// Hook service. Used to keep Kubernetes from shutting the pod down.
|
// Hook service. Used to keep Kubernetes from shutting the pod down.
|
||||||
type HookServiceServer interface {
|
type HookServiceServer interface {
|
||||||
|
|
@ -1025,7 +1025,7 @@ func (c *xdsUpdateHealthServiceClient) SendHookRequest(ctx context.Context, in *
|
||||||
|
|
||||||
// XdsUpdateHealthServiceServer is the server API for XdsUpdateHealthService service.
|
// XdsUpdateHealthServiceServer is the server API for XdsUpdateHealthService service.
|
||||||
// All implementations must embed UnimplementedXdsUpdateHealthServiceServer
|
// All implementations must embed UnimplementedXdsUpdateHealthServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// A service to remotely control health status of an xDS test server.
|
// A service to remotely control health status of an xDS test server.
|
||||||
type XdsUpdateHealthServiceServer interface {
|
type XdsUpdateHealthServiceServer interface {
|
||||||
|
|
@ -1174,7 +1174,7 @@ func (c *xdsUpdateClientConfigureServiceClient) Configure(ctx context.Context, i
|
||||||
|
|
||||||
// XdsUpdateClientConfigureServiceServer is the server API for XdsUpdateClientConfigureService service.
|
// XdsUpdateClientConfigureServiceServer is the server API for XdsUpdateClientConfigureService service.
|
||||||
// All implementations must embed UnimplementedXdsUpdateClientConfigureServiceServer
|
// All implementations must embed UnimplementedXdsUpdateClientConfigureServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// A service to dynamically update the configuration of an xDS test client.
|
// A service to dynamically update the configuration of an xDS test client.
|
||||||
type XdsUpdateClientConfigureServiceServer interface {
|
type XdsUpdateClientConfigureServiceServer interface {
|
||||||
|
|
|
||||||
|
|
@ -122,7 +122,7 @@ func (c *workerServiceClient) QuitWorker(ctx context.Context, in *Void, opts ...
|
||||||
|
|
||||||
// WorkerServiceServer is the server API for WorkerService service.
|
// WorkerServiceServer is the server API for WorkerService service.
|
||||||
// All implementations must embed UnimplementedWorkerServiceServer
|
// All implementations must embed UnimplementedWorkerServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
type WorkerServiceServer interface {
|
type WorkerServiceServer interface {
|
||||||
// Start server with specified workload.
|
// Start server with specified workload.
|
||||||
// First request sent specifies the ServerConfig followed by ServerStatus
|
// First request sent specifies the ServerConfig followed by ServerStatus
|
||||||
|
|
|
||||||
|
|
@ -94,7 +94,7 @@ func (c *metricsServiceClient) GetGauge(ctx context.Context, in *GaugeRequest, o
|
||||||
|
|
||||||
// MetricsServiceServer is the server API for MetricsService service.
|
// MetricsServiceServer is the server API for MetricsService service.
|
||||||
// All implementations must embed UnimplementedMetricsServiceServer
|
// All implementations must embed UnimplementedMetricsServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
type MetricsServiceServer interface {
|
type MetricsServiceServer interface {
|
||||||
// Returns the values of all the gauges that are currently being maintained by
|
// Returns the values of all the gauges that are currently being maintained by
|
||||||
// the service
|
// the service
|
||||||
|
|
|
||||||
|
|
@ -81,7 +81,7 @@ func (c *profilingClient) GetStreamStats(ctx context.Context, in *GetStreamStats
|
||||||
|
|
||||||
// ProfilingServer is the server API for Profiling service.
|
// ProfilingServer is the server API for Profiling service.
|
||||||
// All implementations should embed UnimplementedProfilingServer
|
// All implementations should embed UnimplementedProfilingServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
//
|
//
|
||||||
// The Profiling service exposes functions to remotely manage the gRPC
|
// The Profiling service exposes functions to remotely manage the gRPC
|
||||||
// profiling behaviour in a program.
|
// profiling behaviour in a program.
|
||||||
|
|
|
||||||
|
|
@ -75,7 +75,7 @@ type ServerReflection_ServerReflectionInfoClient = grpc.BidiStreamingClient[Serv
|
||||||
|
|
||||||
// ServerReflectionServer is the server API for ServerReflection service.
|
// ServerReflectionServer is the server API for ServerReflection service.
|
||||||
// All implementations should embed UnimplementedServerReflectionServer
|
// All implementations should embed UnimplementedServerReflectionServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
type ServerReflectionServer interface {
|
type ServerReflectionServer interface {
|
||||||
// The reflection service is structured as a bidirectional stream, ensuring
|
// The reflection service is structured as a bidirectional stream, ensuring
|
||||||
// all related requests go to a single server.
|
// all related requests go to a single server.
|
||||||
|
|
|
||||||
|
|
@ -72,7 +72,7 @@ type ServerReflection_ServerReflectionInfoClient = grpc.BidiStreamingClient[Serv
|
||||||
|
|
||||||
// ServerReflectionServer is the server API for ServerReflection service.
|
// ServerReflectionServer is the server API for ServerReflection service.
|
||||||
// All implementations should embed UnimplementedServerReflectionServer
|
// All implementations should embed UnimplementedServerReflectionServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
type ServerReflectionServer interface {
|
type ServerReflectionServer interface {
|
||||||
// The reflection service is structured as a bidirectional stream, ensuring
|
// The reflection service is structured as a bidirectional stream, ensuring
|
||||||
// all related requests go to a single server.
|
// all related requests go to a single server.
|
||||||
|
|
|
||||||
|
|
@ -78,7 +78,7 @@ type SearchService_StreamingSearchClient = grpc.BidiStreamingClient[SearchReques
|
||||||
|
|
||||||
// SearchServiceServer is the server API for SearchService service.
|
// SearchServiceServer is the server API for SearchService service.
|
||||||
// All implementations must embed UnimplementedSearchServiceServer
|
// All implementations must embed UnimplementedSearchServiceServer
|
||||||
// for forward compatibility
|
// for forward compatibility.
|
||||||
type SearchServiceServer interface {
|
type SearchServiceServer interface {
|
||||||
Search(context.Context, *SearchRequest) (*SearchResponse, error)
|
Search(context.Context, *SearchRequest) (*SearchResponse, error)
|
||||||
StreamingSearch(grpc.BidiStreamingServer[SearchRequest, SearchResponse]) error
|
StreamingSearch(grpc.BidiStreamingServer[SearchRequest, SearchResponse]) error
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue