Package io.grpc.internal
Interface InternalServer
-
- All Known Implementing Classes:
InProcessServer
,NettyServer
,ServletServerBuilder.InternalServerImpl
,ServletServerBuilder.InternalServerImpl
@ThreadSafe public interface InternalServer
An object that accepts new incoming connections on one or more listening socket addresses. This would commonly encapsulate a bound socket thataccept()
s new connections.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.net.SocketAddress
getListenSocketAddress()
Returns the first listening socket address.java.util.List<? extends java.net.SocketAddress>
getListenSocketAddresses()
Returns a list of listening socket addresses.InternalInstrumented<InternalChannelz.SocketStats>
getListenSocketStats()
Returns the first listen socket stats of this server.java.util.List<InternalInstrumented<InternalChannelz.SocketStats>>
getListenSocketStatsList()
Returns a list of 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 java.io.IOException
Starts transport. Implementations must not calllistener
until afterstart()
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:
java.io.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 (onceServerListener.serverShutdown()
callback is called). This method may only be called once. Blocks until the listening socket(s) have been closed. If interrupted, this method will not wait for the close to complete, but it will happen asynchronously.
-
getListenSocketAddress
java.net.SocketAddress getListenSocketAddress()
Returns the first listening socket address. May change afterstart(ServerListener)
is called.
-
getListenSocketStats
@Nullable InternalInstrumented<InternalChannelz.SocketStats> getListenSocketStats()
Returns the first listen socket stats of this server. May returnnull
.
-
getListenSocketAddresses
java.util.List<? extends java.net.SocketAddress> getListenSocketAddresses()
Returns a list of listening socket addresses. May change afterstart(ServerListener)
is called.
-
getListenSocketStatsList
@Nullable java.util.List<InternalInstrumented<InternalChannelz.SocketStats>> getListenSocketStatsList()
Returns a list of listen socket stats of this server. May returnnull
.
-
-