Python: wordsmith documentation on Server.stop()

@nathanielmanistaatgoogle and I just had a good session helping me
figure out how to use this API correctly, and this rewording of the
documentation was the result.
pull/15592/head
Augie Fackler 7 years ago
parent 2a0d447d27
commit 38689e6587
  1. 19
      src/python/grpcio/grpc/__init__.py

@ -1250,19 +1250,20 @@ class Server(six.with_metaclass(abc.ABCMeta)):
"""Stops this Server. """Stops this Server.
This method immediately stop service of new RPCs in all cases. This method immediately stop service of new RPCs in all cases.
If a grace period is specified, this method returns immediately If a grace period is specified, this method returns immediately
and all RPCs active at the end of the grace period are aborted. and all RPCs active at the end of the grace period are aborted.
If a grace period is not specified (by passing None for `grace`),
If a grace period is not specified, then all existing RPCs are all existing RPCs are aborted immediately and this method
teriminated immediately and the this method blocks until the last blocks until the last RPC handler terminates.
RPC handler terminates.
This method is idempotent and may be called at any time. This method is idempotent and may be called at any time.
Passing a smaller grace value in subsequent call will have Passing a smaller grace value in a subsequent call will have
the effect of stopping the Server sooner. Passing a larger the effect of stopping the Server sooner (passing None will
grace value in subsequent call *will not* have the effect of have the effect of stopping the server immediately). Passing
stopping the server later (i.e. the most restrictive grace a larger grace value in a subsequent call *will not* have the
value is used). effect of stopping the server later (i.e. the most restrictive
grace value is used).
Args: Args:
grace: A duration of time in seconds or None. grace: A duration of time in seconds or None.

Loading…
Cancel
Save