io.grpc

Class ServerImpl

java.lang.Object

io.grpc.Server

io.grpc.ServerImpl

public final class ServerImpl
extends Server

Default implementation of Server, for creation by transports.

Expected usage (by a theoretical TCP transport):

public class TcpTransportServerFactory {
   public static Server newServer(Executor executor, HandlerRegistry registry,
       String configuration) {
     return new ServerImpl(executor, registry, new TcpTransportServer(configuration));
   }
 }

Starting the server starts the underlying transport for servicing requests. Stopping the server stops servicing new requests and waits for all connections to terminate.

Constructor Summary

Constructors

Constructor and Description
ServerImpl(Executor executor, HandlerRegistry registry, Server transportServer) Construct a server.

Method Summary

Modifier and Type	Method and Description
void	awaitTerminated() Waits for the server to become terminated.
boolean	awaitTerminated(long timeout, TimeUnit unit) Waits for the server to become terminated, giving up if the timeout is reached.
boolean	isShutdown() Returns whether the server is shutdown.
boolean	isTerminated() Returns whether the server is terminated.
ServerImpl	shutdown() Initiates an orderly shutdown in which preexisting calls continue but new calls are rejected.
ServerImpl	shutdownNow() Initiates a forceful shutdown in which preexisting and new calls are rejected.
ServerImpl	start() Bind and start the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerImpl

public ServerImpl(Executor executor,
                  HandlerRegistry registry,
                  Server transportServer)

Construct a server.

Parameters:

executor - to call methods on behalf of remote clients

registry - of methods to expose to remote clients.

Method Detail

start

public ServerImpl start()
                 throws IOException

Bind and start the server.

Returns:

this object

Throws:

IllegalStateException - if already started

IOException - if unable to bind

shutdown

public ServerImpl shutdown()

Initiates an orderly shutdown in which preexisting calls continue but new calls are rejected.

shutdownNow

public ServerImpl shutdownNow()

Initiates a forceful shutdown in which preexisting and new calls are rejected. Although forceful, the shutdown process is still not instantaneous; isTerminated() will likely return false immediately after this method returns.

NOT YET IMPLEMENTED. This method currently behaves identically to shutdown().

isShutdown

public boolean isShutdown()

Returns whether the server is shutdown. Shutdown servers reject any new calls, but may still have some calls being processed.

See Also:

shutdown(), isTerminated()

awaitTerminated

public boolean awaitTerminated(long timeout,
                               TimeUnit unit)
                        throws InterruptedException

Waits for the server to become terminated, giving up if the timeout is reached.

Returns:

whether the server is terminated, as would be done by isTerminated().

Throws:

InterruptedException

awaitTerminated

public void awaitTerminated()
                     throws InterruptedException

Waits for the server to become terminated.

Throws:

InterruptedException

isTerminated

public boolean isTerminated()

Returns whether the server is terminated. Terminated servers have no running calls and relevant resources released (like TCP connections).

See Also:

isShutdown()