io.grpc.services

Class ChannelzService

java.lang.Object

io.grpc.channelz.v1.ChannelzGrpc.ChannelzImplBase

io.grpc.services.ChannelzService

All Implemented Interfaces:

io.grpc.BindableService

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

The channelz service provides stats about a running gRPC process.

Method Summary

Modifier and Type	Method and Description
static io.grpc.ServerServiceDefinition	createInstance(int maxPageSize) Creates an instance.
void	getChannel(io.grpc.channelz.v1.GetChannelRequest request, io.grpc.stub.StreamObserver<io.grpc.channelz.v1.GetChannelResponse> responseObserver) Returns a top level channel aka ManagedChannelImpl.
void	getServers(io.grpc.channelz.v1.GetServersRequest request, io.grpc.stub.StreamObserver<io.grpc.channelz.v1.GetServersResponse> responseObserver) Returns servers.
void	getServerSockets(io.grpc.channelz.v1.GetServerSocketsRequest request, io.grpc.stub.StreamObserver<io.grpc.channelz.v1.GetServerSocketsResponse> responseObserver)
void	getSocket(io.grpc.channelz.v1.GetSocketRequest request, io.grpc.stub.StreamObserver<io.grpc.channelz.v1.GetSocketResponse> responseObserver) Returns a socket.
void	getSubchannel(io.grpc.channelz.v1.GetSubchannelRequest request, io.grpc.stub.StreamObserver<io.grpc.channelz.v1.GetSubchannelResponse> responseObserver) Returns a subchannel.
void	getTopChannels(io.grpc.channelz.v1.GetTopChannelsRequest request, io.grpc.stub.StreamObserver<io.grpc.channelz.v1.GetTopChannelsResponse> responseObserver) Returns top level channel aka ManagedChannelImpl.
static ChannelzService	newInstance(int maxPageSize) Deprecated. Call createInstance(int), which includes security interceptors.

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

Method Detail

newInstance

@Deprecated
public static ChannelzService newInstance(int maxPageSize)

Deprecated. Call createInstance(int), which includes security interceptors.

Creates an instance.

createInstance

public static io.grpc.ServerServiceDefinition createInstance(int maxPageSize)

Creates an instance. The return value may contain built in interceptors for web security.

Parameters:

maxPageSize - the number of items per set of paginated results.

Returns:

a ServerServiceDefinition that represents the channelz service.

getTopChannels

public void getTopChannels(io.grpc.channelz.v1.GetTopChannelsRequest request,
                           io.grpc.stub.StreamObserver<io.grpc.channelz.v1.GetTopChannelsResponse> responseObserver)

Returns top level channel aka ManagedChannelImpl.

Overrides:

getTopChannels in class io.grpc.channelz.v1.ChannelzGrpc.ChannelzImplBase

getChannel

public void getChannel(io.grpc.channelz.v1.GetChannelRequest request,
                       io.grpc.stub.StreamObserver<io.grpc.channelz.v1.GetChannelResponse> responseObserver)

Returns a top level channel aka ManagedChannelImpl.

Overrides:

getChannel in class io.grpc.channelz.v1.ChannelzGrpc.ChannelzImplBase

getServers

public void getServers(io.grpc.channelz.v1.GetServersRequest request,
                       io.grpc.stub.StreamObserver<io.grpc.channelz.v1.GetServersResponse> responseObserver)

Returns servers.

Overrides:

getServers in class io.grpc.channelz.v1.ChannelzGrpc.ChannelzImplBase

getSubchannel

public void getSubchannel(io.grpc.channelz.v1.GetSubchannelRequest request,
                          io.grpc.stub.StreamObserver<io.grpc.channelz.v1.GetSubchannelResponse> responseObserver)

Returns a subchannel.

Overrides:

getSubchannel in class io.grpc.channelz.v1.ChannelzGrpc.ChannelzImplBase

getSocket

public void getSocket(io.grpc.channelz.v1.GetSocketRequest request,
                      io.grpc.stub.StreamObserver<io.grpc.channelz.v1.GetSocketResponse> responseObserver)

Returns a socket.

Overrides:

getSocket in class io.grpc.channelz.v1.ChannelzGrpc.ChannelzImplBase

getServerSockets

public void getServerSockets(io.grpc.channelz.v1.GetServerSocketsRequest request,
                             io.grpc.stub.StreamObserver<io.grpc.channelz.v1.GetServerSocketsResponse> responseObserver)

Overrides:

getServerSockets in class io.grpc.channelz.v1.ChannelzGrpc.ChannelzImplBase