google.golang.org/grpc@v1.72.2/channelz/grpc_channelz_v1/channelz_grpc.pb.go (about) 1 // Copyright 2018 The gRPC Authors 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 // 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 15 // This file defines an interface for exporting monitoring information 16 // out of gRPC servers. See the full design at 17 // https://github.com/grpc/proposal/blob/master/A14-channelz.md 18 // 19 // The canonical version of this proto can be found at 20 // https://github.com/grpc/grpc-proto/blob/master/grpc/channelz/v1/channelz.proto 21 22 // Code generated by protoc-gen-go-grpc. DO NOT EDIT. 23 // versions: 24 // - protoc-gen-go-grpc v1.5.1 25 // - protoc v5.27.1 26 // source: grpc/channelz/v1/channelz.proto 27 28 package grpc_channelz_v1 29 30 import ( 31 context "context" 32 grpc "google.golang.org/grpc" 33 codes "google.golang.org/grpc/codes" 34 status "google.golang.org/grpc/status" 35 ) 36 37 // This is a compile-time assertion to ensure that this generated file 38 // is compatible with the grpc package it is being compiled against. 39 // Requires gRPC-Go v1.64.0 or later. 40 const _ = grpc.SupportPackageIsVersion9 41 42 const ( 43 Channelz_GetTopChannels_FullMethodName = "/grpc.channelz.v1.Channelz/GetTopChannels" 44 Channelz_GetServers_FullMethodName = "/grpc.channelz.v1.Channelz/GetServers" 45 Channelz_GetServer_FullMethodName = "/grpc.channelz.v1.Channelz/GetServer" 46 Channelz_GetServerSockets_FullMethodName = "/grpc.channelz.v1.Channelz/GetServerSockets" 47 Channelz_GetChannel_FullMethodName = "/grpc.channelz.v1.Channelz/GetChannel" 48 Channelz_GetSubchannel_FullMethodName = "/grpc.channelz.v1.Channelz/GetSubchannel" 49 Channelz_GetSocket_FullMethodName = "/grpc.channelz.v1.Channelz/GetSocket" 50 ) 51 52 // ChannelzClient is the client API for Channelz service. 53 // 54 // 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. 55 // 56 // Channelz is a service exposed by gRPC servers that provides detailed debug 57 // information. 58 type ChannelzClient interface { 59 // Gets all root channels (i.e. channels the application has directly 60 // created). This does not include subchannels nor non-top level channels. 61 GetTopChannels(ctx context.Context, in *GetTopChannelsRequest, opts ...grpc.CallOption) (*GetTopChannelsResponse, error) 62 // Gets all servers that exist in the process. 63 GetServers(ctx context.Context, in *GetServersRequest, opts ...grpc.CallOption) (*GetServersResponse, error) 64 // Returns a single Server, or else a NOT_FOUND code. 65 GetServer(ctx context.Context, in *GetServerRequest, opts ...grpc.CallOption) (*GetServerResponse, error) 66 // Gets all server sockets that exist in the process. 67 GetServerSockets(ctx context.Context, in *GetServerSocketsRequest, opts ...grpc.CallOption) (*GetServerSocketsResponse, error) 68 // Returns a single Channel, or else a NOT_FOUND code. 69 GetChannel(ctx context.Context, in *GetChannelRequest, opts ...grpc.CallOption) (*GetChannelResponse, error) 70 // Returns a single Subchannel, or else a NOT_FOUND code. 71 GetSubchannel(ctx context.Context, in *GetSubchannelRequest, opts ...grpc.CallOption) (*GetSubchannelResponse, error) 72 // Returns a single Socket or else a NOT_FOUND code. 73 GetSocket(ctx context.Context, in *GetSocketRequest, opts ...grpc.CallOption) (*GetSocketResponse, error) 74 } 75 76 type channelzClient struct { 77 cc grpc.ClientConnInterface 78 } 79 80 func NewChannelzClient(cc grpc.ClientConnInterface) ChannelzClient { 81 return &channelzClient{cc} 82 } 83 84 func (c *channelzClient) GetTopChannels(ctx context.Context, in *GetTopChannelsRequest, opts ...grpc.CallOption) (*GetTopChannelsResponse, error) { 85 cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...) 86 out := new(GetTopChannelsResponse) 87 err := c.cc.Invoke(ctx, Channelz_GetTopChannels_FullMethodName, in, out, cOpts...) 88 if err != nil { 89 return nil, err 90 } 91 return out, nil 92 } 93 94 func (c *channelzClient) GetServers(ctx context.Context, in *GetServersRequest, opts ...grpc.CallOption) (*GetServersResponse, error) { 95 cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...) 96 out := new(GetServersResponse) 97 err := c.cc.Invoke(ctx, Channelz_GetServers_FullMethodName, in, out, cOpts...) 98 if err != nil { 99 return nil, err 100 } 101 return out, nil 102 } 103 104 func (c *channelzClient) GetServer(ctx context.Context, in *GetServerRequest, opts ...grpc.CallOption) (*GetServerResponse, error) { 105 cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...) 106 out := new(GetServerResponse) 107 err := c.cc.Invoke(ctx, Channelz_GetServer_FullMethodName, in, out, cOpts...) 108 if err != nil { 109 return nil, err 110 } 111 return out, nil 112 } 113 114 func (c *channelzClient) GetServerSockets(ctx context.Context, in *GetServerSocketsRequest, opts ...grpc.CallOption) (*GetServerSocketsResponse, error) { 115 cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...) 116 out := new(GetServerSocketsResponse) 117 err := c.cc.Invoke(ctx, Channelz_GetServerSockets_FullMethodName, in, out, cOpts...) 118 if err != nil { 119 return nil, err 120 } 121 return out, nil 122 } 123 124 func (c *channelzClient) GetChannel(ctx context.Context, in *GetChannelRequest, opts ...grpc.CallOption) (*GetChannelResponse, error) { 125 cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...) 126 out := new(GetChannelResponse) 127 err := c.cc.Invoke(ctx, Channelz_GetChannel_FullMethodName, in, out, cOpts...) 128 if err != nil { 129 return nil, err 130 } 131 return out, nil 132 } 133 134 func (c *channelzClient) GetSubchannel(ctx context.Context, in *GetSubchannelRequest, opts ...grpc.CallOption) (*GetSubchannelResponse, error) { 135 cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...) 136 out := new(GetSubchannelResponse) 137 err := c.cc.Invoke(ctx, Channelz_GetSubchannel_FullMethodName, in, out, cOpts...) 138 if err != nil { 139 return nil, err 140 } 141 return out, nil 142 } 143 144 func (c *channelzClient) GetSocket(ctx context.Context, in *GetSocketRequest, opts ...grpc.CallOption) (*GetSocketResponse, error) { 145 cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...) 146 out := new(GetSocketResponse) 147 err := c.cc.Invoke(ctx, Channelz_GetSocket_FullMethodName, in, out, cOpts...) 148 if err != nil { 149 return nil, err 150 } 151 return out, nil 152 } 153 154 // ChannelzServer is the server API for Channelz service. 155 // All implementations should embed UnimplementedChannelzServer 156 // for forward compatibility. 157 // 158 // Channelz is a service exposed by gRPC servers that provides detailed debug 159 // information. 160 type ChannelzServer interface { 161 // Gets all root channels (i.e. channels the application has directly 162 // created). This does not include subchannels nor non-top level channels. 163 GetTopChannels(context.Context, *GetTopChannelsRequest) (*GetTopChannelsResponse, error) 164 // Gets all servers that exist in the process. 165 GetServers(context.Context, *GetServersRequest) (*GetServersResponse, error) 166 // Returns a single Server, or else a NOT_FOUND code. 167 GetServer(context.Context, *GetServerRequest) (*GetServerResponse, error) 168 // Gets all server sockets that exist in the process. 169 GetServerSockets(context.Context, *GetServerSocketsRequest) (*GetServerSocketsResponse, error) 170 // Returns a single Channel, or else a NOT_FOUND code. 171 GetChannel(context.Context, *GetChannelRequest) (*GetChannelResponse, error) 172 // Returns a single Subchannel, or else a NOT_FOUND code. 173 GetSubchannel(context.Context, *GetSubchannelRequest) (*GetSubchannelResponse, error) 174 // Returns a single Socket or else a NOT_FOUND code. 175 GetSocket(context.Context, *GetSocketRequest) (*GetSocketResponse, error) 176 } 177 178 // UnimplementedChannelzServer should be embedded to have 179 // forward compatible implementations. 180 // 181 // NOTE: this should be embedded by value instead of pointer to avoid a nil 182 // pointer dereference when methods are called. 183 type UnimplementedChannelzServer struct{} 184 185 func (UnimplementedChannelzServer) GetTopChannels(context.Context, *GetTopChannelsRequest) (*GetTopChannelsResponse, error) { 186 return nil, status.Errorf(codes.Unimplemented, "method GetTopChannels not implemented") 187 } 188 func (UnimplementedChannelzServer) GetServers(context.Context, *GetServersRequest) (*GetServersResponse, error) { 189 return nil, status.Errorf(codes.Unimplemented, "method GetServers not implemented") 190 } 191 func (UnimplementedChannelzServer) GetServer(context.Context, *GetServerRequest) (*GetServerResponse, error) { 192 return nil, status.Errorf(codes.Unimplemented, "method GetServer not implemented") 193 } 194 func (UnimplementedChannelzServer) GetServerSockets(context.Context, *GetServerSocketsRequest) (*GetServerSocketsResponse, error) { 195 return nil, status.Errorf(codes.Unimplemented, "method GetServerSockets not implemented") 196 } 197 func (UnimplementedChannelzServer) GetChannel(context.Context, *GetChannelRequest) (*GetChannelResponse, error) { 198 return nil, status.Errorf(codes.Unimplemented, "method GetChannel not implemented") 199 } 200 func (UnimplementedChannelzServer) GetSubchannel(context.Context, *GetSubchannelRequest) (*GetSubchannelResponse, error) { 201 return nil, status.Errorf(codes.Unimplemented, "method GetSubchannel not implemented") 202 } 203 func (UnimplementedChannelzServer) GetSocket(context.Context, *GetSocketRequest) (*GetSocketResponse, error) { 204 return nil, status.Errorf(codes.Unimplemented, "method GetSocket not implemented") 205 } 206 func (UnimplementedChannelzServer) testEmbeddedByValue() {} 207 208 // UnsafeChannelzServer may be embedded to opt out of forward compatibility for this service. 209 // Use of this interface is not recommended, as added methods to ChannelzServer will 210 // result in compilation errors. 211 type UnsafeChannelzServer interface { 212 mustEmbedUnimplementedChannelzServer() 213 } 214 215 func RegisterChannelzServer(s grpc.ServiceRegistrar, srv ChannelzServer) { 216 // If the following call panics, it indicates UnimplementedChannelzServer was 217 // embedded by pointer and is nil. This will cause panics if an 218 // unimplemented method is ever invoked, so we test this at initialization 219 // time to prevent it from happening at runtime later due to I/O. 220 if t, ok := srv.(interface{ testEmbeddedByValue() }); ok { 221 t.testEmbeddedByValue() 222 } 223 s.RegisterService(&Channelz_ServiceDesc, srv) 224 } 225 226 func _Channelz_GetTopChannels_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { 227 in := new(GetTopChannelsRequest) 228 if err := dec(in); err != nil { 229 return nil, err 230 } 231 if interceptor == nil { 232 return srv.(ChannelzServer).GetTopChannels(ctx, in) 233 } 234 info := &grpc.UnaryServerInfo{ 235 Server: srv, 236 FullMethod: Channelz_GetTopChannels_FullMethodName, 237 } 238 handler := func(ctx context.Context, req interface{}) (interface{}, error) { 239 return srv.(ChannelzServer).GetTopChannels(ctx, req.(*GetTopChannelsRequest)) 240 } 241 return interceptor(ctx, in, info, handler) 242 } 243 244 func _Channelz_GetServers_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { 245 in := new(GetServersRequest) 246 if err := dec(in); err != nil { 247 return nil, err 248 } 249 if interceptor == nil { 250 return srv.(ChannelzServer).GetServers(ctx, in) 251 } 252 info := &grpc.UnaryServerInfo{ 253 Server: srv, 254 FullMethod: Channelz_GetServers_FullMethodName, 255 } 256 handler := func(ctx context.Context, req interface{}) (interface{}, error) { 257 return srv.(ChannelzServer).GetServers(ctx, req.(*GetServersRequest)) 258 } 259 return interceptor(ctx, in, info, handler) 260 } 261 262 func _Channelz_GetServer_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { 263 in := new(GetServerRequest) 264 if err := dec(in); err != nil { 265 return nil, err 266 } 267 if interceptor == nil { 268 return srv.(ChannelzServer).GetServer(ctx, in) 269 } 270 info := &grpc.UnaryServerInfo{ 271 Server: srv, 272 FullMethod: Channelz_GetServer_FullMethodName, 273 } 274 handler := func(ctx context.Context, req interface{}) (interface{}, error) { 275 return srv.(ChannelzServer).GetServer(ctx, req.(*GetServerRequest)) 276 } 277 return interceptor(ctx, in, info, handler) 278 } 279 280 func _Channelz_GetServerSockets_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { 281 in := new(GetServerSocketsRequest) 282 if err := dec(in); err != nil { 283 return nil, err 284 } 285 if interceptor == nil { 286 return srv.(ChannelzServer).GetServerSockets(ctx, in) 287 } 288 info := &grpc.UnaryServerInfo{ 289 Server: srv, 290 FullMethod: Channelz_GetServerSockets_FullMethodName, 291 } 292 handler := func(ctx context.Context, req interface{}) (interface{}, error) { 293 return srv.(ChannelzServer).GetServerSockets(ctx, req.(*GetServerSocketsRequest)) 294 } 295 return interceptor(ctx, in, info, handler) 296 } 297 298 func _Channelz_GetChannel_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { 299 in := new(GetChannelRequest) 300 if err := dec(in); err != nil { 301 return nil, err 302 } 303 if interceptor == nil { 304 return srv.(ChannelzServer).GetChannel(ctx, in) 305 } 306 info := &grpc.UnaryServerInfo{ 307 Server: srv, 308 FullMethod: Channelz_GetChannel_FullMethodName, 309 } 310 handler := func(ctx context.Context, req interface{}) (interface{}, error) { 311 return srv.(ChannelzServer).GetChannel(ctx, req.(*GetChannelRequest)) 312 } 313 return interceptor(ctx, in, info, handler) 314 } 315 316 func _Channelz_GetSubchannel_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { 317 in := new(GetSubchannelRequest) 318 if err := dec(in); err != nil { 319 return nil, err 320 } 321 if interceptor == nil { 322 return srv.(ChannelzServer).GetSubchannel(ctx, in) 323 } 324 info := &grpc.UnaryServerInfo{ 325 Server: srv, 326 FullMethod: Channelz_GetSubchannel_FullMethodName, 327 } 328 handler := func(ctx context.Context, req interface{}) (interface{}, error) { 329 return srv.(ChannelzServer).GetSubchannel(ctx, req.(*GetSubchannelRequest)) 330 } 331 return interceptor(ctx, in, info, handler) 332 } 333 334 func _Channelz_GetSocket_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) { 335 in := new(GetSocketRequest) 336 if err := dec(in); err != nil { 337 return nil, err 338 } 339 if interceptor == nil { 340 return srv.(ChannelzServer).GetSocket(ctx, in) 341 } 342 info := &grpc.UnaryServerInfo{ 343 Server: srv, 344 FullMethod: Channelz_GetSocket_FullMethodName, 345 } 346 handler := func(ctx context.Context, req interface{}) (interface{}, error) { 347 return srv.(ChannelzServer).GetSocket(ctx, req.(*GetSocketRequest)) 348 } 349 return interceptor(ctx, in, info, handler) 350 } 351 352 // Channelz_ServiceDesc is the grpc.ServiceDesc for Channelz service. 353 // It's only intended for direct use with grpc.RegisterService, 354 // and not to be introspected or modified (even as a copy) 355 var Channelz_ServiceDesc = grpc.ServiceDesc{ 356 ServiceName: "grpc.channelz.v1.Channelz", 357 HandlerType: (*ChannelzServer)(nil), 358 Methods: []grpc.MethodDesc{ 359 { 360 MethodName: "GetTopChannels", 361 Handler: _Channelz_GetTopChannels_Handler, 362 }, 363 { 364 MethodName: "GetServers", 365 Handler: _Channelz_GetServers_Handler, 366 }, 367 { 368 MethodName: "GetServer", 369 Handler: _Channelz_GetServer_Handler, 370 }, 371 { 372 MethodName: "GetServerSockets", 373 Handler: _Channelz_GetServerSockets_Handler, 374 }, 375 { 376 MethodName: "GetChannel", 377 Handler: _Channelz_GetChannel_Handler, 378 }, 379 { 380 MethodName: "GetSubchannel", 381 Handler: _Channelz_GetSubchannel_Handler, 382 }, 383 { 384 MethodName: "GetSocket", 385 Handler: _Channelz_GetSocket_Handler, 386 }, 387 }, 388 Streams: []grpc.StreamDesc{}, 389 Metadata: "grpc/channelz/v1/channelz.proto", 390 }