Package io.grpc.protobuf.services

Class ChannelzService

java.lang.Object

io.grpc.channelz.v1.ChannelzGrpc.ChannelzImplBase

io.grpc.protobuf.services.ChannelzService

All Implemented Interfaces:

BindableService, ChannelzGrpc.AsyncService

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/4206")
public final class ChannelzService
extends ChannelzGrpc.ChannelzImplBase

The channelz service provides stats about a running gRPC process.

Field Summary

Fields

Modifier and Type	Field	Description
private final InternalChannelz	channelz
private final int	maxPageSize

Constructor Summary

Constructors

Constructor	Description
ChannelzService(InternalChannelz channelz, int maxPageSize)

Method Summary

Modifier and Type	Method	Description
void	getChannel(GetChannelRequest request, StreamObserver<GetChannelResponse> responseObserver)	Returns a top level channel aka ManagedChannel.
void	getServer(GetServerRequest request, StreamObserver<GetServerResponse> responseObserver)	Returns a server.
void	getServers(GetServersRequest request, StreamObserver<GetServersResponse> responseObserver)	Returns servers.
void	getServerSockets(GetServerSocketsRequest request, StreamObserver<GetServerSocketsResponse> responseObserver)	Gets all server sockets that exist in the process.
void	getSocket(GetSocketRequest request, StreamObserver<GetSocketResponse> responseObserver)	Returns a socket.
void	getSubchannel(GetSubchannelRequest request, StreamObserver<GetSubchannelResponse> responseObserver)	Returns a subchannel.
void	getTopChannels(GetTopChannelsRequest request, StreamObserver<GetTopChannelsResponse> responseObserver)	Returns top level channel aka ManagedChannel.
static ChannelzService	newInstance(int maxPageSize)	Creates an instance.

Methods inherited from class io.grpc.channelz.v1.ChannelzGrpc.ChannelzImplBase

bindService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

channelz

private final InternalChannelz channelz

maxPageSize

private final int maxPageSize

Constructor Details

ChannelzService

ChannelzService(InternalChannelz channelz,
 int maxPageSize)

Method Details

newInstance

public static ChannelzService newInstance(int maxPageSize)

Creates an instance.

getTopChannels

public void getTopChannels(GetTopChannelsRequest request,
 StreamObserver<GetTopChannelsResponse> responseObserver)

Returns top level channel aka ManagedChannel.

getChannel

public void getChannel(GetChannelRequest request,
 StreamObserver<GetChannelResponse> responseObserver)

Returns a top level channel aka ManagedChannel.

getServers

public void getServers(GetServersRequest request,
 StreamObserver<GetServersResponse> responseObserver)

Returns servers.

getServer

public void getServer(GetServerRequest request,
 StreamObserver<GetServerResponse> responseObserver)

Returns a server.

getSubchannel

public void getSubchannel(GetSubchannelRequest request,
 StreamObserver<GetSubchannelResponse> responseObserver)

Returns a subchannel.

getSocket

public void getSocket(GetSocketRequest request,
 StreamObserver<GetSocketResponse> responseObserver)

Returns a socket.

getServerSockets

public void getServerSockets(GetServerSocketsRequest request,
 StreamObserver<GetServerSocketsResponse> responseObserver)

Description copied from interface: ChannelzGrpc.AsyncService

 Gets all server sockets that exist in the process.