io.grpc.internal

Interface InternalServer

@ThreadSafe
public interface InternalServer

An object that accepts new incoming connections. This would commonly encapsulate a bound socket that accept()s new connections.

Method Summary

Modifier and Type	Method and Description
SocketAddress	getListenSocketAddress() Returns the listening socket address.
io.grpc.InternalInstrumented<io.grpc.InternalChannelz.SocketStats>	getListenSocketStats() Returns the listen socket stats of this server.
void	shutdown() Initiates an orderly shutdown of the server.
void	start(ServerListener listener) Starts transport.

Method Detail

start

void start(ServerListener listener)
    throws IOException

Starts transport. Implementations must not call listener until after start() returns. The method only returns after it has done the equivalent of bind()ing, so it will be able to service any connections created after returning.

Parameters:

listener - non-null listener of server events

Throws:

IOException - if unable to bind

shutdown

void shutdown()

Initiates an orderly shutdown of the server. Existing transports continue, but new transports will not be created (once ServerListener.serverShutdown() callback is called). This method may only be called once.

getListenSocketAddress

SocketAddress getListenSocketAddress()

Returns the listening socket address. May change after start(ServerListener) is called.

getListenSocketStats

@Nullable
io.grpc.InternalInstrumented<io.grpc.InternalChannelz.SocketStats> getListenSocketStats()

Returns the listen socket stats of this server. May return null.