Package io.grpc.channelz.v1

Class ChannelzGrpc.ChannelzStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<ChannelzGrpc.ChannelzStub>

io.grpc.channelz.v1.ChannelzGrpc.ChannelzStub

Enclosing class:

ChannelzGrpc

public static final class ChannelzGrpc.ChannelzStub
extends AbstractAsyncStub<ChannelzGrpc.ChannelzStub>

A stub to allow clients to do asynchronous rpc calls to service Channelz.

 Channelz is a service exposed by gRPC servers that provides detailed debug
 information.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

AbstractStub.StubFactory<T extends AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
protected ChannelzGrpc.ChannelzStub	build(Channel channel, CallOptions callOptions)	Returns a new stub with the given channel for the provided method configurations.
void	getChannel(GetChannelRequest request, StreamObserver<GetChannelResponse> responseObserver)	Returns a single Channel, or else a NOT_FOUND code.
void	getServer(GetServerRequest request, StreamObserver<GetServerResponse> responseObserver)	Returns a single Server, or else a NOT_FOUND code.
void	getServers(GetServersRequest request, StreamObserver<GetServersResponse> responseObserver)	Gets all servers that exist in the process.
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 single Socket or else a NOT_FOUND code.
void	getSubchannel(GetSubchannelRequest request, StreamObserver<GetSubchannelResponse> responseObserver)	Returns a single Subchannel, or else a NOT_FOUND code.
void	getTopChannels(GetTopChannelsRequest request, StreamObserver<GetTopChannelsResponse> responseObserver)	Gets all root channels (i.e.

Methods inherited from class io.grpc.stub.AbstractAsyncStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected ChannelzGrpc.ChannelzStub build(Channel channel,
                                          CallOptions callOptions)

Description copied from class: AbstractStub

Returns a new stub with the given channel for the provided method configurations.

Specified by:

build in class AbstractStub<ChannelzGrpc.ChannelzStub>

Parameters:

channel - the channel that this stub will use to do communications

callOptions - the runtime call options to be applied to every call on this stub

getTopChannels

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

 Gets all root channels (i.e. channels the application has directly
 created). This does not include subchannels nor non-top level channels.
 

getServers

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

 Gets all servers that exist in the process.
 

getServer

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

 Returns a single Server, or else a NOT_FOUND code.
 

getServerSockets

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

 Gets all server sockets that exist in the process.
 

getChannel

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

 Returns a single Channel, or else a NOT_FOUND code.
 

getSubchannel

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

 Returns a single Subchannel, or else a NOT_FOUND code.
 

getSocket

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

 Returns a single Socket or else a NOT_FOUND code.