diff options
Diffstat (limited to 'src/python/grpcio/grpc/beta/interfaces.py')
| -rw-r--r-- | src/python/grpcio/grpc/beta/interfaces.py | 78 |
1 files changed, 39 insertions, 39 deletions
diff --git a/src/python/grpcio/grpc/beta/interfaces.py b/src/python/grpcio/grpc/beta/interfaces.py index 90f6bbbfcc..361d1bcffe 100644 --- a/src/python/grpcio/grpc/beta/interfaces.py +++ b/src/python/grpcio/grpc/beta/interfaces.py @@ -26,7 +26,6 @@ # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - """Constants and interfaces of the Beta API of gRPC Python.""" import abc @@ -43,21 +42,21 @@ StatusCode = grpc.StatusCode class GRPCCallOptions(object): - """A value encapsulating gRPC-specific options passed on RPC invocation. + """A value encapsulating gRPC-specific options passed on RPC invocation. This class and its instances have no supported interface - it exists to define the type of its instances and its instances exist to be passed to other functions. """ - def __init__(self, disable_compression, subcall_of, credentials): - self.disable_compression = disable_compression - self.subcall_of = subcall_of - self.credentials = credentials + def __init__(self, disable_compression, subcall_of, credentials): + self.disable_compression = disable_compression + self.subcall_of = subcall_of + self.credentials = credentials def grpc_call_options(disable_compression=False, credentials=None): - """Creates a GRPCCallOptions value to be passed at RPC invocation. + """Creates a GRPCCallOptions value to be passed at RPC invocation. All parameters are optional and should always be passed by keyword. @@ -67,7 +66,8 @@ def grpc_call_options(disable_compression=False, credentials=None): request-unary RPCs. credentials: A CallCredentials object to use for the invoked RPC. """ - return GRPCCallOptions(disable_compression, None, credentials) + return GRPCCallOptions(disable_compression, None, credentials) + GRPCAuthMetadataContext = grpc.AuthMetadataContext GRPCAuthMetadataPluginCallback = grpc.AuthMetadataPluginCallback @@ -75,38 +75,38 @@ GRPCAuthMetadataPlugin = grpc.AuthMetadataPlugin class GRPCServicerContext(six.with_metaclass(abc.ABCMeta)): - """Exposes gRPC-specific options and behaviors to code servicing RPCs.""" + """Exposes gRPC-specific options and behaviors to code servicing RPCs.""" - @abc.abstractmethod - def peer(self): - """Identifies the peer that invoked the RPC being serviced. + @abc.abstractmethod + def peer(self): + """Identifies the peer that invoked the RPC being serviced. Returns: A string identifying the peer that invoked the RPC being serviced. """ - raise NotImplementedError() + raise NotImplementedError() - @abc.abstractmethod - def disable_next_response_compression(self): - """Disables compression of the next response passed by the application.""" - raise NotImplementedError() + @abc.abstractmethod + def disable_next_response_compression(self): + """Disables compression of the next response passed by the application.""" + raise NotImplementedError() class GRPCInvocationContext(six.with_metaclass(abc.ABCMeta)): - """Exposes gRPC-specific options and behaviors to code invoking RPCs.""" + """Exposes gRPC-specific options and behaviors to code invoking RPCs.""" - @abc.abstractmethod - def disable_next_request_compression(self): - """Disables compression of the next request passed by the application.""" - raise NotImplementedError() + @abc.abstractmethod + def disable_next_request_compression(self): + """Disables compression of the next request passed by the application.""" + raise NotImplementedError() class Server(six.with_metaclass(abc.ABCMeta)): - """Services RPCs.""" + """Services RPCs.""" - @abc.abstractmethod - def add_insecure_port(self, address): - """Reserves a port for insecure RPC service once this Server becomes active. + @abc.abstractmethod + def add_insecure_port(self, address): + """Reserves a port for insecure RPC service once this Server becomes active. This method may only be called before calling this Server's start method is called. @@ -120,11 +120,11 @@ class Server(six.with_metaclass(abc.ABCMeta)): in the passed address, but will likely be different if the port number contained in the passed address was zero. """ - raise NotImplementedError() + raise NotImplementedError() - @abc.abstractmethod - def add_secure_port(self, address, server_credentials): - """Reserves a port for secure RPC service after this Server becomes active. + @abc.abstractmethod + def add_secure_port(self, address, server_credentials): + """Reserves a port for secure RPC service after this Server becomes active. This method may only be called before calling this Server's start method is called. @@ -139,20 +139,20 @@ class Server(six.with_metaclass(abc.ABCMeta)): in the passed address, but will likely be different if the port number contained in the passed address was zero. """ - raise NotImplementedError() + raise NotImplementedError() - @abc.abstractmethod - def start(self): - """Starts this Server's service of RPCs. + @abc.abstractmethod + def start(self): + """Starts this Server's service of RPCs. This method may only be called while the server is not serving RPCs (i.e. it is not idempotent). """ - raise NotImplementedError() + raise NotImplementedError() - @abc.abstractmethod - def stop(self, grace): - """Stops this Server's service of RPCs. + @abc.abstractmethod + def stop(self, grace): + """Stops this Server's service of RPCs. All calls to this method immediately stop service of new RPCs. When existing RPCs are aborted is controlled by the grace period parameter passed to this @@ -177,4 +177,4 @@ class Server(six.with_metaclass(abc.ABCMeta)): at the time it was stopped or if all RPCs that it had underway completed very early in the grace period). """ - raise NotImplementedError() + raise NotImplementedError() |