| <!DOCTYPE html> |
| |
| <html lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <title>gRPC — gRPC Python 1.76.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" /> |
| <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=f0f94f3a" /> |
| <script src="_static/documentation_options.js?v=8c3e8212"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="gRPC AsyncIO API" href="grpc_asyncio.html" /> |
| <link rel="prev" title="Welcome to gRPC Python’s documentation!" href="index.html" /> |
| |
| <link rel="stylesheet" href="_static/custom.css" type="text/css" /> |
| |
| |
| |
| |
| |
| </head><body> |
| <div class="document"> |
| |
| <div class="sphinxsidebar" role="navigation" aria-label="Main"> |
| <div class="sphinxsidebarwrapper"> |
| <h1 class="logo"><a href="index.html">gRPC Python</a></h1> |
| |
| |
| |
| <p class="blurb">1.76.0</p> |
| |
| |
| |
| |
| |
| |
| <h3>Navigation</h3> |
| <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">gRPC</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#module-contents">Module Contents</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#version">Version</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#create-client">Create Client</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.insecure_channel"><code class="docutils literal notranslate"><span class="pre">insecure_channel()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.secure_channel"><code class="docutils literal notranslate"><span class="pre">secure_channel()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.intercept_channel"><code class="docutils literal notranslate"><span class="pre">intercept_channel()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#create-client-credentials">Create Client Credentials</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.ssl_channel_credentials"><code class="docutils literal notranslate"><span class="pre">ssl_channel_credentials()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.metadata_call_credentials"><code class="docutils literal notranslate"><span class="pre">metadata_call_credentials()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.access_token_call_credentials"><code class="docutils literal notranslate"><span class="pre">access_token_call_credentials()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.composite_call_credentials"><code class="docutils literal notranslate"><span class="pre">composite_call_credentials()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.composite_channel_credentials"><code class="docutils literal notranslate"><span class="pre">composite_channel_credentials()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.local_channel_credentials"><code class="docutils literal notranslate"><span class="pre">local_channel_credentials()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.compute_engine_channel_credentials"><code class="docutils literal notranslate"><span class="pre">compute_engine_channel_credentials()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#create-server">Create Server</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.server"><code class="docutils literal notranslate"><span class="pre">server()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#create-server-credentials">Create Server Credentials</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.ssl_server_credentials"><code class="docutils literal notranslate"><span class="pre">ssl_server_credentials()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.ssl_server_certificate_configuration"><code class="docutils literal notranslate"><span class="pre">ssl_server_certificate_configuration()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.dynamic_ssl_server_credentials"><code class="docutils literal notranslate"><span class="pre">dynamic_ssl_server_credentials()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.local_server_credentials"><code class="docutils literal notranslate"><span class="pre">local_server_credentials()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#local-connection-type">Local Connection Type</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.LocalConnectionType"><code class="docutils literal notranslate"><span class="pre">LocalConnectionType</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.LocalConnectionType.UDS"><code class="docutils literal notranslate"><span class="pre">LocalConnectionType.UDS</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.LocalConnectionType.LOCAL_TCP"><code class="docutils literal notranslate"><span class="pre">LocalConnectionType.LOCAL_TCP</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#rpc-method-handlers">RPC Method Handlers</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.unary_unary_rpc_method_handler"><code class="docutils literal notranslate"><span class="pre">unary_unary_rpc_method_handler()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.unary_stream_rpc_method_handler"><code class="docutils literal notranslate"><span class="pre">unary_stream_rpc_method_handler()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.stream_unary_rpc_method_handler"><code class="docutils literal notranslate"><span class="pre">stream_unary_rpc_method_handler()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.stream_stream_rpc_method_handler"><code class="docutils literal notranslate"><span class="pre">stream_stream_rpc_method_handler()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.method_handlers_generic_handler"><code class="docutils literal notranslate"><span class="pre">method_handlers_generic_handler()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#channel-ready-future">Channel Ready Future</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.channel_ready_future"><code class="docutils literal notranslate"><span class="pre">channel_ready_future()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#channel-connectivity">Channel Connectivity</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.ChannelConnectivity"><code class="docutils literal notranslate"><span class="pre">ChannelConnectivity</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ChannelConnectivity.IDLE"><code class="docutils literal notranslate"><span class="pre">ChannelConnectivity.IDLE</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ChannelConnectivity.CONNECTING"><code class="docutils literal notranslate"><span class="pre">ChannelConnectivity.CONNECTING</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ChannelConnectivity.READY"><code class="docutils literal notranslate"><span class="pre">ChannelConnectivity.READY</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ChannelConnectivity.TRANSIENT_FAILURE"><code class="docutils literal notranslate"><span class="pre">ChannelConnectivity.TRANSIENT_FAILURE</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ChannelConnectivity.SHUTDOWN"><code class="docutils literal notranslate"><span class="pre">ChannelConnectivity.SHUTDOWN</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#grpc-status-code">gRPC Status Code</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.StatusCode"><code class="docutils literal notranslate"><span class="pre">StatusCode</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.OK"><code class="docutils literal notranslate"><span class="pre">StatusCode.OK</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.CANCELLED"><code class="docutils literal notranslate"><span class="pre">StatusCode.CANCELLED</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.UNKNOWN"><code class="docutils literal notranslate"><span class="pre">StatusCode.UNKNOWN</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.INVALID_ARGUMENT"><code class="docutils literal notranslate"><span class="pre">StatusCode.INVALID_ARGUMENT</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.DEADLINE_EXCEEDED"><code class="docutils literal notranslate"><span class="pre">StatusCode.DEADLINE_EXCEEDED</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.NOT_FOUND"><code class="docutils literal notranslate"><span class="pre">StatusCode.NOT_FOUND</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.ALREADY_EXISTS"><code class="docutils literal notranslate"><span class="pre">StatusCode.ALREADY_EXISTS</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.PERMISSION_DENIED"><code class="docutils literal notranslate"><span class="pre">StatusCode.PERMISSION_DENIED</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.UNAUTHENTICATED"><code class="docutils literal notranslate"><span class="pre">StatusCode.UNAUTHENTICATED</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.RESOURCE_EXHAUSTED"><code class="docutils literal notranslate"><span class="pre">StatusCode.RESOURCE_EXHAUSTED</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.FAILED_PRECONDITION"><code class="docutils literal notranslate"><span class="pre">StatusCode.FAILED_PRECONDITION</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.ABORTED"><code class="docutils literal notranslate"><span class="pre">StatusCode.ABORTED</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.UNIMPLEMENTED"><code class="docutils literal notranslate"><span class="pre">StatusCode.UNIMPLEMENTED</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.INTERNAL"><code class="docutils literal notranslate"><span class="pre">StatusCode.INTERNAL</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.UNAVAILABLE"><code class="docutils literal notranslate"><span class="pre">StatusCode.UNAVAILABLE</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StatusCode.DATA_LOSS"><code class="docutils literal notranslate"><span class="pre">StatusCode.DATA_LOSS</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#channel-object">Channel Object</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.Channel"><code class="docutils literal notranslate"><span class="pre">Channel</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Channel.__enter__"><code class="docutils literal notranslate"><span class="pre">Channel.__enter__()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Channel.__exit__"><code class="docutils literal notranslate"><span class="pre">Channel.__exit__()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Channel.close"><code class="docutils literal notranslate"><span class="pre">Channel.close()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Channel.stream_stream"><code class="docutils literal notranslate"><span class="pre">Channel.stream_stream()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Channel.stream_unary"><code class="docutils literal notranslate"><span class="pre">Channel.stream_unary()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Channel.subscribe"><code class="docutils literal notranslate"><span class="pre">Channel.subscribe()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Channel.unary_stream"><code class="docutils literal notranslate"><span class="pre">Channel.unary_stream()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Channel.unary_unary"><code class="docutils literal notranslate"><span class="pre">Channel.unary_unary()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Channel.unsubscribe"><code class="docutils literal notranslate"><span class="pre">Channel.unsubscribe()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#server-object">Server Object</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.Server"><code class="docutils literal notranslate"><span class="pre">Server</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Server.add_generic_rpc_handlers"><code class="docutils literal notranslate"><span class="pre">Server.add_generic_rpc_handlers()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Server.add_insecure_port"><code class="docutils literal notranslate"><span class="pre">Server.add_insecure_port()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Server.add_registered_method_handlers"><code class="docutils literal notranslate"><span class="pre">Server.add_registered_method_handlers()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Server.add_secure_port"><code class="docutils literal notranslate"><span class="pre">Server.add_secure_port()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Server.start"><code class="docutils literal notranslate"><span class="pre">Server.start()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Server.stop"><code class="docutils literal notranslate"><span class="pre">Server.stop()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Server.wait_for_termination"><code class="docutils literal notranslate"><span class="pre">Server.wait_for_termination()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#authentication-authorization-objects">Authentication & Authorization Objects</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.ChannelCredentials"><code class="docutils literal notranslate"><span class="pre">ChannelCredentials</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.CallCredentials"><code class="docutils literal notranslate"><span class="pre">CallCredentials</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.AuthMetadataContext"><code class="docutils literal notranslate"><span class="pre">AuthMetadataContext</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.AuthMetadataContext.service_url"><code class="docutils literal notranslate"><span class="pre">AuthMetadataContext.service_url</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.AuthMetadataContext.method_name"><code class="docutils literal notranslate"><span class="pre">AuthMetadataContext.method_name</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.AuthMetadataPluginCallback"><code class="docutils literal notranslate"><span class="pre">AuthMetadataPluginCallback</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.AuthMetadataPluginCallback.__call__"><code class="docutils literal notranslate"><span class="pre">AuthMetadataPluginCallback.__call__()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.AuthMetadataPlugin"><code class="docutils literal notranslate"><span class="pre">AuthMetadataPlugin</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.AuthMetadataPlugin.__call__"><code class="docutils literal notranslate"><span class="pre">AuthMetadataPlugin.__call__()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.ServerCredentials"><code class="docutils literal notranslate"><span class="pre">ServerCredentials</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.ServerCertificateConfiguration"><code class="docutils literal notranslate"><span class="pre">ServerCertificateConfiguration</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#grpc-exceptions">gRPC Exceptions</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.RpcError"><code class="docutils literal notranslate"><span class="pre">RpcError</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#rpc-context">RPC Context</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.RpcContext"><code class="docutils literal notranslate"><span class="pre">RpcContext</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.RpcContext.add_callback"><code class="docutils literal notranslate"><span class="pre">RpcContext.add_callback()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.RpcContext.cancel"><code class="docutils literal notranslate"><span class="pre">RpcContext.cancel()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.RpcContext.is_active"><code class="docutils literal notranslate"><span class="pre">RpcContext.is_active()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.RpcContext.time_remaining"><code class="docutils literal notranslate"><span class="pre">RpcContext.time_remaining()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#client-side-context">Client-Side Context</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.Call"><code class="docutils literal notranslate"><span class="pre">Call</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Call.code"><code class="docutils literal notranslate"><span class="pre">Call.code()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Call.details"><code class="docutils literal notranslate"><span class="pre">Call.details()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Call.initial_metadata"><code class="docutils literal notranslate"><span class="pre">Call.initial_metadata()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Call.trailing_metadata"><code class="docutils literal notranslate"><span class="pre">Call.trailing_metadata()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#client-side-interceptor">Client-Side Interceptor</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.ClientCallDetails"><code class="docutils literal notranslate"><span class="pre">ClientCallDetails</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ClientCallDetails.method"><code class="docutils literal notranslate"><span class="pre">ClientCallDetails.method</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ClientCallDetails.timeout"><code class="docutils literal notranslate"><span class="pre">ClientCallDetails.timeout</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ClientCallDetails.metadata"><code class="docutils literal notranslate"><span class="pre">ClientCallDetails.metadata</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ClientCallDetails.credentials"><code class="docutils literal notranslate"><span class="pre">ClientCallDetails.credentials</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ClientCallDetails.wait_for_ready"><code class="docutils literal notranslate"><span class="pre">ClientCallDetails.wait_for_ready</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ClientCallDetails.compression"><code class="docutils literal notranslate"><span class="pre">ClientCallDetails.compression</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.UnaryUnaryClientInterceptor"><code class="docutils literal notranslate"><span class="pre">UnaryUnaryClientInterceptor</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.UnaryUnaryClientInterceptor.intercept_unary_unary"><code class="docutils literal notranslate"><span class="pre">UnaryUnaryClientInterceptor.intercept_unary_unary()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.UnaryStreamClientInterceptor"><code class="docutils literal notranslate"><span class="pre">UnaryStreamClientInterceptor</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.UnaryStreamClientInterceptor.intercept_unary_stream"><code class="docutils literal notranslate"><span class="pre">UnaryStreamClientInterceptor.intercept_unary_stream()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.StreamUnaryClientInterceptor"><code class="docutils literal notranslate"><span class="pre">StreamUnaryClientInterceptor</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StreamUnaryClientInterceptor.intercept_stream_unary"><code class="docutils literal notranslate"><span class="pre">StreamUnaryClientInterceptor.intercept_stream_unary()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.StreamStreamClientInterceptor"><code class="docutils literal notranslate"><span class="pre">StreamStreamClientInterceptor</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StreamStreamClientInterceptor.intercept_stream_stream"><code class="docutils literal notranslate"><span class="pre">StreamStreamClientInterceptor.intercept_stream_stream()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#service-side-context">Service-Side Context</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.ServicerContext"><code class="docutils literal notranslate"><span class="pre">ServicerContext</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.abort"><code class="docutils literal notranslate"><span class="pre">ServicerContext.abort()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.abort_with_status"><code class="docutils literal notranslate"><span class="pre">ServicerContext.abort_with_status()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.auth_context"><code class="docutils literal notranslate"><span class="pre">ServicerContext.auth_context()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.code"><code class="docutils literal notranslate"><span class="pre">ServicerContext.code()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.details"><code class="docutils literal notranslate"><span class="pre">ServicerContext.details()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.disable_next_message_compression"><code class="docutils literal notranslate"><span class="pre">ServicerContext.disable_next_message_compression()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.invocation_metadata"><code class="docutils literal notranslate"><span class="pre">ServicerContext.invocation_metadata()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.peer"><code class="docutils literal notranslate"><span class="pre">ServicerContext.peer()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.peer_identities"><code class="docutils literal notranslate"><span class="pre">ServicerContext.peer_identities()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.peer_identity_key"><code class="docutils literal notranslate"><span class="pre">ServicerContext.peer_identity_key()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.send_initial_metadata"><code class="docutils literal notranslate"><span class="pre">ServicerContext.send_initial_metadata()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.set_code"><code class="docutils literal notranslate"><span class="pre">ServicerContext.set_code()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.set_compression"><code class="docutils literal notranslate"><span class="pre">ServicerContext.set_compression()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.set_details"><code class="docutils literal notranslate"><span class="pre">ServicerContext.set_details()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.set_trailing_metadata"><code class="docutils literal notranslate"><span class="pre">ServicerContext.set_trailing_metadata()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServicerContext.trailing_metadata"><code class="docutils literal notranslate"><span class="pre">ServicerContext.trailing_metadata()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#service-side-handler">Service-Side Handler</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.RpcMethodHandler"><code class="docutils literal notranslate"><span class="pre">RpcMethodHandler</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.RpcMethodHandler.request_streaming"><code class="docutils literal notranslate"><span class="pre">RpcMethodHandler.request_streaming</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.RpcMethodHandler.response_streaming"><code class="docutils literal notranslate"><span class="pre">RpcMethodHandler.response_streaming</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.RpcMethodHandler.request_deserializer"><code class="docutils literal notranslate"><span class="pre">RpcMethodHandler.request_deserializer</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.RpcMethodHandler.response_serializer"><code class="docutils literal notranslate"><span class="pre">RpcMethodHandler.response_serializer</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.RpcMethodHandler.unary_unary"><code class="docutils literal notranslate"><span class="pre">RpcMethodHandler.unary_unary</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.RpcMethodHandler.unary_stream"><code class="docutils literal notranslate"><span class="pre">RpcMethodHandler.unary_stream</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.RpcMethodHandler.stream_unary"><code class="docutils literal notranslate"><span class="pre">RpcMethodHandler.stream_unary</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.RpcMethodHandler.stream_stream"><code class="docutils literal notranslate"><span class="pre">RpcMethodHandler.stream_stream</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.HandlerCallDetails"><code class="docutils literal notranslate"><span class="pre">HandlerCallDetails</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.HandlerCallDetails.method"><code class="docutils literal notranslate"><span class="pre">HandlerCallDetails.method</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.HandlerCallDetails.invocation_metadata"><code class="docutils literal notranslate"><span class="pre">HandlerCallDetails.invocation_metadata</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.GenericRpcHandler"><code class="docutils literal notranslate"><span class="pre">GenericRpcHandler</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.GenericRpcHandler.service"><code class="docutils literal notranslate"><span class="pre">GenericRpcHandler.service()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.ServiceRpcHandler"><code class="docutils literal notranslate"><span class="pre">ServiceRpcHandler</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServiceRpcHandler.service_name"><code class="docutils literal notranslate"><span class="pre">ServiceRpcHandler.service_name()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#service-side-interceptor">Service-Side Interceptor</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.ServerInterceptor"><code class="docutils literal notranslate"><span class="pre">ServerInterceptor</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.ServerInterceptor.intercept_service"><code class="docutils literal notranslate"><span class="pre">ServerInterceptor.intercept_service()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#multi-callable-interfaces">Multi-Callable Interfaces</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.UnaryUnaryMultiCallable"><code class="docutils literal notranslate"><span class="pre">UnaryUnaryMultiCallable</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.UnaryUnaryMultiCallable.__call__"><code class="docutils literal notranslate"><span class="pre">UnaryUnaryMultiCallable.__call__()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.UnaryUnaryMultiCallable.future"><code class="docutils literal notranslate"><span class="pre">UnaryUnaryMultiCallable.future()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.UnaryUnaryMultiCallable.with_call"><code class="docutils literal notranslate"><span class="pre">UnaryUnaryMultiCallable.with_call()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.UnaryStreamMultiCallable"><code class="docutils literal notranslate"><span class="pre">UnaryStreamMultiCallable</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.UnaryStreamMultiCallable.__call__"><code class="docutils literal notranslate"><span class="pre">UnaryStreamMultiCallable.__call__()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.StreamUnaryMultiCallable"><code class="docutils literal notranslate"><span class="pre">StreamUnaryMultiCallable</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StreamUnaryMultiCallable.__call__"><code class="docutils literal notranslate"><span class="pre">StreamUnaryMultiCallable.__call__()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StreamUnaryMultiCallable.future"><code class="docutils literal notranslate"><span class="pre">StreamUnaryMultiCallable.future()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StreamUnaryMultiCallable.with_call"><code class="docutils literal notranslate"><span class="pre">StreamUnaryMultiCallable.with_call()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.StreamStreamMultiCallable"><code class="docutils literal notranslate"><span class="pre">StreamStreamMultiCallable</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.StreamStreamMultiCallable.__call__"><code class="docutils literal notranslate"><span class="pre">StreamStreamMultiCallable.__call__()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#future-interfaces">Future Interfaces</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.FutureTimeoutError"><code class="docutils literal notranslate"><span class="pre">FutureTimeoutError</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.FutureCancelledError"><code class="docutils literal notranslate"><span class="pre">FutureCancelledError</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.Future"><code class="docutils literal notranslate"><span class="pre">Future</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Future.add_done_callback"><code class="docutils literal notranslate"><span class="pre">Future.add_done_callback()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Future.cancel"><code class="docutils literal notranslate"><span class="pre">Future.cancel()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Future.cancelled"><code class="docutils literal notranslate"><span class="pre">Future.cancelled()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Future.done"><code class="docutils literal notranslate"><span class="pre">Future.done()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Future.exception"><code class="docutils literal notranslate"><span class="pre">Future.exception()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Future.result"><code class="docutils literal notranslate"><span class="pre">Future.result()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Future.running"><code class="docutils literal notranslate"><span class="pre">Future.running()</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Future.traceback"><code class="docutils literal notranslate"><span class="pre">Future.traceback()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#compression">Compression</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.Compression"><code class="docutils literal notranslate"><span class="pre">Compression</span></code></a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Compression.NoCompression"><code class="docutils literal notranslate"><span class="pre">Compression.NoCompression</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Compression.Deflate"><code class="docutils literal notranslate"><span class="pre">Compression.Deflate</span></code></a></li> |
| <li class="toctree-l5"><a class="reference internal" href="#grpc.Compression.Gzip"><code class="docutils literal notranslate"><span class="pre">Compression.Gzip</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#runtime-protobuf-parsing">Runtime Protobuf Parsing</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.protos"><code class="docutils literal notranslate"><span class="pre">protos()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.services"><code class="docutils literal notranslate"><span class="pre">services()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#grpc.protos_and_services"><code class="docutils literal notranslate"><span class="pre">protos_and_services()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="grpc_asyncio.html">gRPC AsyncIO API</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="grpc_admin.html">gRPC Admin</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="grpc_channelz.html">gRPC Channelz</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="grpc_csds.html">gRPC CSDS</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="grpc_health_checking.html">gRPC Health Checking</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="grpc_reflection.html">gRPC Reflection</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="grpc_status.html">gRPC Status</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="grpc_testing.html">gRPC Testing</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="grpc_observability.html">gRPC Python Observability</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li> |
| </ul> |
| |
| <div class="relations"> |
| <h3>Related Topics</h3> |
| <ul> |
| <li><a href="index.html">Documentation overview</a><ul> |
| <li>Previous: <a href="index.html" title="previous chapter">Welcome to gRPC Python’s documentation!</a></li> |
| <li>Next: <a href="grpc_asyncio.html" title="next chapter">gRPC AsyncIO API</a></li> |
| </ul></li> |
| </ul> |
| </div> |
| <search id="searchbox" style="display: none" role="search"> |
| <h3 id="searchlabel">Quick search</h3> |
| <div class="searchformwrapper"> |
| <form class="search" action="search.html" method="get"> |
| <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> |
| <input type="submit" value="Go" /> |
| </form> |
| </div> |
| </search> |
| <script>document.getElementById('searchbox').style.display = "block"</script> |
| |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| </div> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| |
| |
| <div class="body" role="main"> |
| |
| <section id="module-grpc"> |
| <span id="grpc"></span><h1>gRPC<a class="headerlink" href="#module-grpc" title="Link to this heading">¶</a></h1> |
| <p>For documentation, examples, and more, see the <a class="reference external" href="https://grpc.io/docs/languages/python/">Python gRPC</a> page on <a class="reference external" href="https://grpc.io/">grpc.io</a>.</p> |
| <section id="module-contents"> |
| <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2> |
| <section id="version"> |
| <h3>Version<a class="headerlink" href="#version" title="Link to this heading">¶</a></h3> |
| <p>The version string is available as <code class="code docutils literal notranslate"><span class="pre">grpc.__version__</span></code>.</p> |
| </section> |
| <section id="create-client"> |
| <h3>Create Client<a class="headerlink" href="#create-client" title="Link to this heading">¶</a></h3> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.insecure_channel"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">insecure_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#insecure_channel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.insecure_channel" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates an insecure Channel to a server.</p> |
| <p>The returned Channel is thread-safe.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>target</strong> – The server address</p></li> |
| <li><p><strong>options</strong> – An optional list of key-value pairs (<a class="reference internal" href="glossary.html#term-channel_arguments"><span class="xref std std-term">channel_arguments</span></a> |
| in gRPC Core runtime) to configure the channel.</p></li> |
| <li><p><strong>compression</strong> – An optional value indicating the compression method to be |
| used over the lifetime of the channel.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A Channel.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.secure_channel"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">secure_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#secure_channel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.secure_channel" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a secure Channel to a server.</p> |
| <p>The returned Channel is thread-safe.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>target</strong> – The server address.</p></li> |
| <li><p><strong>credentials</strong> – A ChannelCredentials instance.</p></li> |
| <li><p><strong>options</strong> – An optional list of key-value pairs (<a class="reference internal" href="glossary.html#term-channel_arguments"><span class="xref std std-term">channel_arguments</span></a> |
| in gRPC Core runtime) to configure the channel.</p></li> |
| <li><p><strong>compression</strong> – An optional value indicating the compression method to be |
| used over the lifetime of the channel.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A Channel.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.intercept_channel"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">intercept_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">interceptors</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#intercept_channel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.intercept_channel" title="Link to this definition">¶</a></dt> |
| <dd><p>Intercepts a channel through a set of interceptors.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>channel</strong> – A Channel.</p></li> |
| <li><p><strong>interceptors</strong> – Zero or more objects of type |
| UnaryUnaryClientInterceptor, |
| UnaryStreamClientInterceptor, |
| StreamUnaryClientInterceptor, or |
| StreamStreamClientInterceptor. |
| Interceptors are given control in the order they are listed.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A Channel that intercepts each invocation via the provided interceptors.</p> |
| </dd> |
| <dt class="field-odd">Raises<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>TypeError</strong> – If interceptor does not derive from any of |
| UnaryUnaryClientInterceptor, |
| UnaryStreamClientInterceptor, |
| StreamUnaryClientInterceptor, or |
| StreamStreamClientInterceptor.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </section> |
| <section id="create-client-credentials"> |
| <h3>Create Client Credentials<a class="headerlink" href="#create-client-credentials" title="Link to this heading">¶</a></h3> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.ssl_channel_credentials"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">ssl_channel_credentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">root_certificates</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">private_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_chain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ssl_channel_credentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ssl_channel_credentials" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a ChannelCredentials for use with an SSL-enabled Channel.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>root_certificates</strong> – The PEM-encoded root certificates as a byte string, |
| or None to retrieve them from a default location chosen by gRPC |
| runtime.</p></li> |
| <li><p><strong>private_key</strong> – The PEM-encoded private key as a byte string, or None if no |
| private key should be used.</p></li> |
| <li><p><strong>certificate_chain</strong> – The PEM-encoded certificate chain as a byte string |
| to use or None if no certificate chain should be used.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A ChannelCredentials for use with an SSL-enabled Channel.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.metadata_call_credentials"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">metadata_call_credentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metadata_plugin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#metadata_call_credentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.metadata_call_credentials" title="Link to this definition">¶</a></dt> |
| <dd><p>Construct CallCredentials from an AuthMetadataPlugin.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>metadata_plugin</strong> – An AuthMetadataPlugin to use for authentication.</p></li> |
| <li><p><strong>name</strong> – An optional name for the plugin.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A CallCredentials.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.access_token_call_credentials"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">access_token_call_credentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">access_token</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#access_token_call_credentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.access_token_call_credentials" title="Link to this definition">¶</a></dt> |
| <dd><p>Construct CallCredentials from an access token.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>access_token</strong> – A string to place directly in the http request |
| authorization header, for example |
| “authorization: Bearer <access_token>”.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A CallCredentials.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.composite_call_credentials"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">composite_call_credentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">call_credentials</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#composite_call_credentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.composite_call_credentials" title="Link to this definition">¶</a></dt> |
| <dd><p>Compose multiple CallCredentials to make a new CallCredentials.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>*call_credentials</strong> – At least two CallCredentials objects.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A CallCredentials object composed of the given CallCredentials objects.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.composite_channel_credentials"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">composite_channel_credentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel_credentials</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">call_credentials</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#composite_channel_credentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.composite_channel_credentials" title="Link to this definition">¶</a></dt> |
| <dd><p>Compose a ChannelCredentials and one or more CallCredentials objects.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>channel_credentials</strong> – A ChannelCredentials object.</p></li> |
| <li><p><strong>*call_credentials</strong> – One or more CallCredentials objects.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><dl class="simple"> |
| <dt>A ChannelCredentials composed of the given ChannelCredentials and</dt><dd><p>CallCredentials objects.</p> |
| </dd> |
| </dl> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.local_channel_credentials"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">local_channel_credentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">local_connect_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">grpc.LocalConnectionType.LOCAL_TCP</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#local_channel_credentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.local_channel_credentials" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a local ChannelCredentials used for local connections.</p> |
| <p>This is an EXPERIMENTAL API.</p> |
| <p>Local credentials are used by local TCP endpoints (e.g. localhost:10000) |
| also UDS connections.</p> |
| <p>The connections created by local channel credentials are not |
| encrypted, but will be checked if they are local or not. |
| The UDS connections are considered secure by providing peer authentication |
| and data confidentiality while TCP connections are considered insecure.</p> |
| <p>It is allowed to transmit call credentials over connections created by |
| local channel credentials.</p> |
| <p>Local channel credentials are useful for 1) eliminating insecure_channel usage; |
| 2) enable unit testing for call credentials without setting up secrets.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>local_connect_type</strong> – Local connection type (either |
| grpc.LocalConnectionType.UDS or grpc.LocalConnectionType.LOCAL_TCP)</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A ChannelCredentials for use with a local Channel</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.compute_engine_channel_credentials"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">compute_engine_channel_credentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">call_credentials</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#compute_engine_channel_credentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.compute_engine_channel_credentials" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a compute engine channel credential.</p> |
| <p>This credential can only be used in a GCP environment as it relies on |
| a handshaker service. For more info about ALTS, see |
| <a class="reference external" href="https://cloud.google.com/security/encryption-in-transit/application-layer-transport-security">https://cloud.google.com/security/encryption-in-transit/application-layer-transport-security</a></p> |
| <p>This channel credential is expected to be used as part of a composite |
| credential in conjunction with a call credentials that authenticates the |
| VM’s default service account. If used with any other sort of call |
| credential, the connection may suddenly and unexpectedly begin failing RPCs.</p> |
| </dd></dl> |
| |
| </section> |
| <section id="create-server"> |
| <h3>Create Server<a class="headerlink" href="#create-server" title="Link to this heading">¶</a></h3> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.server"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">server</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">thread_pool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handlers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interceptors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maximum_concurrent_rpcs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#server"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.server" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a Server with which RPCs can be serviced.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>thread_pool</strong> – A futures.ThreadPoolExecutor to be used by the Server |
| to execute RPC handlers.</p></li> |
| <li><p><strong>handlers</strong> – An optional list of GenericRpcHandlers used for executing RPCs. |
| More handlers may be added by calling add_generic_rpc_handlers any time |
| before the server is started.</p></li> |
| <li><p><strong>interceptors</strong> – An optional list of ServerInterceptor objects that observe |
| and optionally manipulate the incoming RPCs before handing them over to |
| handlers. The interceptors are given control in the order they are |
| specified. This is an EXPERIMENTAL API.</p></li> |
| <li><p><strong>options</strong> – An optional list of key-value pairs (<a class="reference internal" href="glossary.html#term-channel_arguments"><span class="xref std std-term">channel_arguments</span></a> in gRPC runtime) |
| to configure the channel.</p></li> |
| <li><p><strong>maximum_concurrent_rpcs</strong> – The maximum number of concurrent RPCs this server |
| will service before returning RESOURCE_EXHAUSTED status, or None to |
| indicate no limit.</p></li> |
| <li><p><strong>compression</strong> – An element of grpc.compression, e.g. |
| grpc.compression.Gzip. This compression algorithm will be used for the |
| lifetime of the server unless overridden.</p></li> |
| <li><p><strong>xds</strong> – If set to true, retrieves server configuration via xDS. This is an |
| EXPERIMENTAL option.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A Server object.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </section> |
| <section id="create-server-credentials"> |
| <h3>Create Server Credentials<a class="headerlink" href="#create-server-credentials" title="Link to this heading">¶</a></h3> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.ssl_server_credentials"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">ssl_server_credentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">private_key_certificate_chain_pairs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root_certificates</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">require_client_auth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ssl_server_credentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ssl_server_credentials" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a ServerCredentials for use with an SSL-enabled Server.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>private_key_certificate_chain_pairs</strong> – A list of pairs of the form |
| [PEM-encoded private key, PEM-encoded certificate chain].</p></li> |
| <li><p><strong>root_certificates</strong> – An optional byte string of PEM-encoded client root |
| certificates that the server will use to verify client authentication. |
| If omitted, require_client_auth must also be False.</p></li> |
| <li><p><strong>require_client_auth</strong> – A boolean indicating whether or not to require |
| clients to be authenticated. May only be True if root_certificates |
| is not None.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A ServerCredentials for use with an SSL-enabled Server. Typically, this |
| object is an argument to add_secure_port() method during server setup.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.ssl_server_certificate_configuration"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">ssl_server_certificate_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">private_key_certificate_chain_pairs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root_certificates</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ssl_server_certificate_configuration"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ssl_server_certificate_configuration" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a ServerCertificateConfiguration for use with a Server.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>private_key_certificate_chain_pairs</strong> – A collection of pairs of |
| the form [PEM-encoded private key, PEM-encoded certificate |
| chain].</p></li> |
| <li><p><strong>root_certificates</strong> – An optional byte string of PEM-encoded client root |
| certificates that the server will use to verify client authentication.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><dl class="simple"> |
| <dt>A ServerCertificateConfiguration that can be returned in the certificate</dt><dd><p>configuration fetching callback.</p> |
| </dd> |
| </dl> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.dynamic_ssl_server_credentials"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">dynamic_ssl_server_credentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">initial_certificate_configuration</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_configuration_fetcher</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">require_client_authentication</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#dynamic_ssl_server_credentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.dynamic_ssl_server_credentials" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a ServerCredentials for use with an SSL-enabled Server.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>initial_certificate_configuration</strong> (<a class="reference internal" href="#grpc.ServerCertificateConfiguration" title="grpc.ServerCertificateConfiguration"><em>ServerCertificateConfiguration</em></a>) – The |
| certificate configuration with which the server will be initialized.</p></li> |
| <li><p><strong>certificate_configuration_fetcher</strong> (<em>callable</em>) – A callable that takes no |
| arguments and should return a ServerCertificateConfiguration to |
| replace the server’s current certificate, or None for no change |
| (i.e., the server will continue its current certificate |
| config). The library will call this callback on <em>every</em> new |
| client connection before starting the TLS handshake with the |
| client, thus allowing the user application to optionally |
| return a new ServerCertificateConfiguration that the server will then |
| use for the handshake.</p></li> |
| <li><p><strong>require_client_authentication</strong> – A boolean indicating whether or not to |
| require clients to be authenticated.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A ServerCredentials.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.local_server_credentials"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">local_server_credentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">local_connect_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">grpc.LocalConnectionType.LOCAL_TCP</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#local_server_credentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.local_server_credentials" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a local ServerCredentials used for local connections.</p> |
| <p>This is an EXPERIMENTAL API.</p> |
| <p>Local credentials are used by local TCP endpoints (e.g. localhost:10000) |
| also UDS connections.</p> |
| <p>The connections created by local server credentials are not |
| encrypted, but will be checked if they are local or not. |
| The UDS connections are considered secure by providing peer authentication |
| and data confidentiality while TCP connections are considered insecure.</p> |
| <p>It is allowed to transmit call credentials over connections created by local |
| server credentials.</p> |
| <p>Local server credentials are useful for 1) eliminating insecure_channel usage; |
| 2) enable unit testing for call credentials without setting up secrets.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>local_connect_type</strong> – Local connection type (either |
| grpc.LocalConnectionType.UDS or grpc.LocalConnectionType.LOCAL_TCP)</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A ServerCredentials for use with a local Server</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </section> |
| <section id="local-connection-type"> |
| <h3>Local Connection Type<a class="headerlink" href="#local-connection-type" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.LocalConnectionType"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">LocalConnectionType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#LocalConnectionType"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.LocalConnectionType" title="Link to this definition">¶</a></dt> |
| <dd><p>Types of local connection for local credential creation.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.LocalConnectionType.UDS"> |
| <span class="sig-name descname"><span class="pre">UDS</span></span><a class="headerlink" href="#grpc.LocalConnectionType.UDS" title="Link to this definition">¶</a></dt> |
| <dd><p>Unix domain socket connections</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.LocalConnectionType.LOCAL_TCP"> |
| <span class="sig-name descname"><span class="pre">LOCAL_TCP</span></span><a class="headerlink" href="#grpc.LocalConnectionType.LOCAL_TCP" title="Link to this definition">¶</a></dt> |
| <dd><p>Local TCP connections.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="rpc-method-handlers"> |
| <h3>RPC Method Handlers<a class="headerlink" href="#rpc-method-handlers" title="Link to this heading">¶</a></h3> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.unary_unary_rpc_method_handler"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">unary_unary_rpc_method_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">behavior</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_deserializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_serializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#unary_unary_rpc_method_handler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.unary_unary_rpc_method_handler" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates an RpcMethodHandler for a unary-unary RPC method.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>behavior</strong> – The implementation of an RPC that accepts one request |
| and returns one response.</p></li> |
| <li><p><strong>request_deserializer</strong> – An optional <a class="reference internal" href="glossary.html#term-deserializer"><span class="xref std std-term">deserializer</span></a> for request deserialization.</p></li> |
| <li><p><strong>response_serializer</strong> – An optional <a class="reference internal" href="glossary.html#term-serializer"><span class="xref std std-term">serializer</span></a> for response serialization.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An RpcMethodHandler object that is typically used by grpc.Server.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.unary_stream_rpc_method_handler"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">unary_stream_rpc_method_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">behavior</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_deserializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_serializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#unary_stream_rpc_method_handler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.unary_stream_rpc_method_handler" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates an RpcMethodHandler for a unary-stream RPC method.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>behavior</strong> – The implementation of an RPC that accepts one request |
| and returns an iterator of response values.</p></li> |
| <li><p><strong>request_deserializer</strong> – An optional <a class="reference internal" href="glossary.html#term-deserializer"><span class="xref std std-term">deserializer</span></a> for request deserialization.</p></li> |
| <li><p><strong>response_serializer</strong> – An optional <a class="reference internal" href="glossary.html#term-serializer"><span class="xref std std-term">serializer</span></a> for response serialization.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An RpcMethodHandler object that is typically used by grpc.Server.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.stream_unary_rpc_method_handler"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">stream_unary_rpc_method_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">behavior</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_deserializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_serializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#stream_unary_rpc_method_handler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.stream_unary_rpc_method_handler" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates an RpcMethodHandler for a stream-unary RPC method.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>behavior</strong> – The implementation of an RPC that accepts an iterator of |
| request values and returns a single response value.</p></li> |
| <li><p><strong>request_deserializer</strong> – An optional <a class="reference internal" href="glossary.html#term-deserializer"><span class="xref std std-term">deserializer</span></a> for request deserialization.</p></li> |
| <li><p><strong>response_serializer</strong> – An optional <a class="reference internal" href="glossary.html#term-serializer"><span class="xref std std-term">serializer</span></a> for response serialization.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An RpcMethodHandler object that is typically used by grpc.Server.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.stream_stream_rpc_method_handler"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">stream_stream_rpc_method_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">behavior</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_deserializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_serializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#stream_stream_rpc_method_handler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.stream_stream_rpc_method_handler" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates an RpcMethodHandler for a stream-stream RPC method.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>behavior</strong> – The implementation of an RPC that accepts an iterator of |
| request values and returns an iterator of response values.</p></li> |
| <li><p><strong>request_deserializer</strong> – An optional <a class="reference internal" href="glossary.html#term-deserializer"><span class="xref std std-term">deserializer</span></a> for request deserialization.</p></li> |
| <li><p><strong>response_serializer</strong> – An optional <a class="reference internal" href="glossary.html#term-serializer"><span class="xref std std-term">serializer</span></a> for response serialization.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An RpcMethodHandler object that is typically used by grpc.Server.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.method_handlers_generic_handler"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">method_handlers_generic_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method_handlers</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#method_handlers_generic_handler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.method_handlers_generic_handler" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a GenericRpcHandler from RpcMethodHandlers.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>service</strong> – The name of the service that is implemented by the |
| method_handlers.</p></li> |
| <li><p><strong>method_handlers</strong> – A dictionary that maps method names to corresponding |
| RpcMethodHandler.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A GenericRpcHandler. This is typically added to the grpc.Server object |
| with add_generic_rpc_handlers() before starting the server.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </section> |
| <section id="channel-ready-future"> |
| <h3>Channel Ready Future<a class="headerlink" href="#channel-ready-future" title="Link to this heading">¶</a></h3> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.channel_ready_future"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">channel_ready_future</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#channel_ready_future"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.channel_ready_future" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a Future that tracks when a Channel is ready.</p> |
| <p>Cancelling the Future does not affect the channel’s state machine. |
| It merely decouples the Future from channel state machine.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>channel</strong> – A Channel object.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A Future object that matures when the channel connectivity is |
| ChannelConnectivity.READY.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </section> |
| <section id="channel-connectivity"> |
| <h3>Channel Connectivity<a class="headerlink" href="#channel-connectivity" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.ChannelConnectivity"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">ChannelConnectivity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ChannelConnectivity"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ChannelConnectivity" title="Link to this definition">¶</a></dt> |
| <dd><p>Mirrors grpc_connectivity_state in the gRPC Core.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.ChannelConnectivity.IDLE"> |
| <span class="sig-name descname"><span class="pre">IDLE</span></span><a class="headerlink" href="#grpc.ChannelConnectivity.IDLE" title="Link to this definition">¶</a></dt> |
| <dd><p>The channel is idle.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.ChannelConnectivity.CONNECTING"> |
| <span class="sig-name descname"><span class="pre">CONNECTING</span></span><a class="headerlink" href="#grpc.ChannelConnectivity.CONNECTING" title="Link to this definition">¶</a></dt> |
| <dd><p>The channel is connecting.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.ChannelConnectivity.READY"> |
| <span class="sig-name descname"><span class="pre">READY</span></span><a class="headerlink" href="#grpc.ChannelConnectivity.READY" title="Link to this definition">¶</a></dt> |
| <dd><p>The channel is ready to conduct RPCs.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.ChannelConnectivity.TRANSIENT_FAILURE"> |
| <span class="sig-name descname"><span class="pre">TRANSIENT_FAILURE</span></span><a class="headerlink" href="#grpc.ChannelConnectivity.TRANSIENT_FAILURE" title="Link to this definition">¶</a></dt> |
| <dd><p>The channel has seen a failure from which it expects |
| to recover.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.ChannelConnectivity.SHUTDOWN"> |
| <span class="sig-name descname"><span class="pre">SHUTDOWN</span></span><a class="headerlink" href="#grpc.ChannelConnectivity.SHUTDOWN" title="Link to this definition">¶</a></dt> |
| <dd><p>The channel has seen a failure from which it cannot recover.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="grpc-status-code"> |
| <h3>gRPC Status Code<a class="headerlink" href="#grpc-status-code" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.StatusCode"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">StatusCode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#StatusCode"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.StatusCode" title="Link to this definition">¶</a></dt> |
| <dd><p>Mirrors grpc_status_code in the gRPC Core.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.OK"> |
| <span class="sig-name descname"><span class="pre">OK</span></span><a class="headerlink" href="#grpc.StatusCode.OK" title="Link to this definition">¶</a></dt> |
| <dd><p>Not an error; returned on success</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.CANCELLED"> |
| <span class="sig-name descname"><span class="pre">CANCELLED</span></span><a class="headerlink" href="#grpc.StatusCode.CANCELLED" title="Link to this definition">¶</a></dt> |
| <dd><p>The operation was cancelled (typically by the caller).</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.UNKNOWN"> |
| <span class="sig-name descname"><span class="pre">UNKNOWN</span></span><a class="headerlink" href="#grpc.StatusCode.UNKNOWN" title="Link to this definition">¶</a></dt> |
| <dd><p>Unknown error.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.INVALID_ARGUMENT"> |
| <span class="sig-name descname"><span class="pre">INVALID_ARGUMENT</span></span><a class="headerlink" href="#grpc.StatusCode.INVALID_ARGUMENT" title="Link to this definition">¶</a></dt> |
| <dd><p>Client specified an invalid argument.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.DEADLINE_EXCEEDED"> |
| <span class="sig-name descname"><span class="pre">DEADLINE_EXCEEDED</span></span><a class="headerlink" href="#grpc.StatusCode.DEADLINE_EXCEEDED" title="Link to this definition">¶</a></dt> |
| <dd><p>Deadline expired before operation could complete.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.NOT_FOUND"> |
| <span class="sig-name descname"><span class="pre">NOT_FOUND</span></span><a class="headerlink" href="#grpc.StatusCode.NOT_FOUND" title="Link to this definition">¶</a></dt> |
| <dd><p>Some requested entity (e.g., file or directory) was not found.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.ALREADY_EXISTS"> |
| <span class="sig-name descname"><span class="pre">ALREADY_EXISTS</span></span><a class="headerlink" href="#grpc.StatusCode.ALREADY_EXISTS" title="Link to this definition">¶</a></dt> |
| <dd><p>Some entity that we attempted to create (e.g., file or directory) |
| already exists.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.PERMISSION_DENIED"> |
| <span class="sig-name descname"><span class="pre">PERMISSION_DENIED</span></span><a class="headerlink" href="#grpc.StatusCode.PERMISSION_DENIED" title="Link to this definition">¶</a></dt> |
| <dd><p>The caller does not have permission to execute the specified |
| operation.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.UNAUTHENTICATED"> |
| <span class="sig-name descname"><span class="pre">UNAUTHENTICATED</span></span><a class="headerlink" href="#grpc.StatusCode.UNAUTHENTICATED" title="Link to this definition">¶</a></dt> |
| <dd><p>The request does not have valid authentication credentials for the |
| operation.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.RESOURCE_EXHAUSTED"> |
| <span class="sig-name descname"><span class="pre">RESOURCE_EXHAUSTED</span></span><a class="headerlink" href="#grpc.StatusCode.RESOURCE_EXHAUSTED" title="Link to this definition">¶</a></dt> |
| <dd><p>Some resource has been exhausted, perhaps a per-user quota, or |
| perhaps the entire file system is out of space.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.FAILED_PRECONDITION"> |
| <span class="sig-name descname"><span class="pre">FAILED_PRECONDITION</span></span><a class="headerlink" href="#grpc.StatusCode.FAILED_PRECONDITION" title="Link to this definition">¶</a></dt> |
| <dd><p>Operation was rejected because the system is not in a state |
| required for the operation’s execution.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.ABORTED"> |
| <span class="sig-name descname"><span class="pre">ABORTED</span></span><a class="headerlink" href="#grpc.StatusCode.ABORTED" title="Link to this definition">¶</a></dt> |
| <dd><p>The operation was aborted, typically due to a concurrency issue |
| like sequencer check failures, transaction aborts, etc.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.UNIMPLEMENTED"> |
| <span class="sig-name descname"><span class="pre">UNIMPLEMENTED</span></span><a class="headerlink" href="#grpc.StatusCode.UNIMPLEMENTED" title="Link to this definition">¶</a></dt> |
| <dd><p>Operation is not implemented or not supported/enabled in this service.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.INTERNAL"> |
| <span class="sig-name descname"><span class="pre">INTERNAL</span></span><a class="headerlink" href="#grpc.StatusCode.INTERNAL" title="Link to this definition">¶</a></dt> |
| <dd><p>Internal errors. Means some invariants expected by underlying |
| system has been broken.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.UNAVAILABLE"> |
| <span class="sig-name descname"><span class="pre">UNAVAILABLE</span></span><a class="headerlink" href="#grpc.StatusCode.UNAVAILABLE" title="Link to this definition">¶</a></dt> |
| <dd><p>The service is currently unavailable.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.StatusCode.DATA_LOSS"> |
| <span class="sig-name descname"><span class="pre">DATA_LOSS</span></span><a class="headerlink" href="#grpc.StatusCode.DATA_LOSS" title="Link to this definition">¶</a></dt> |
| <dd><p>Unrecoverable data loss or corruption.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="channel-object"> |
| <h3>Channel Object<a class="headerlink" href="#channel-object" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.Channel"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">Channel</span></span><a class="reference internal" href="_modules/grpc.html#Channel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Channel" title="Link to this definition">¶</a></dt> |
| <dd><p>Affords RPC invocation via generic methods on client-side.</p> |
| <p>Channel objects implement the Context Manager type, although they need not |
| support being entered and exited multiple times.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Channel.__enter__"> |
| <span class="sig-name descname"><span class="pre">__enter__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Channel.__enter__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Channel.__enter__" title="Link to this definition">¶</a></dt> |
| <dd><p>Enters the runtime context related to the channel object.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Channel.__exit__"> |
| <span class="sig-name descname"><span class="pre">__exit__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exc_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exc_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exc_tb</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Channel.__exit__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Channel.__exit__" title="Link to this definition">¶</a></dt> |
| <dd><p>Exits the runtime context related to the channel object.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Channel.close"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Channel.close"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Channel.close" title="Link to this definition">¶</a></dt> |
| <dd><p>Closes this Channel and releases all resources held by it.</p> |
| <p>Closing the Channel will immediately terminate all RPCs active with the |
| Channel and it is not valid to invoke new RPCs with the Channel.</p> |
| <p>This method is idempotent.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Channel.stream_stream"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">stream_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_serializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_deserializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_registered_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Channel.stream_stream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Channel.stream_stream" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a StreamStreamMultiCallable for a stream-stream method.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>method</strong> – The name of the RPC method.</p></li> |
| <li><p><strong>request_serializer</strong> – Optional <a class="reference internal" href="glossary.html#term-serializer"><span class="xref std std-term">serializer</span></a> for serializing the request |
| message. Request goes unserialized in case None is passed.</p></li> |
| <li><p><strong>response_deserializer</strong> – Optional <a class="reference internal" href="glossary.html#term-deserializer"><span class="xref std std-term">deserializer</span></a> for deserializing the |
| response message. Response goes undeserialized in case None |
| is passed.</p></li> |
| <li><p><strong>_registered_method</strong> – Implementation Private. A bool representing whether the method |
| is registered.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A StreamStreamMultiCallable value for the named stream-stream method.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Channel.stream_unary"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">stream_unary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_serializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_deserializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_registered_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Channel.stream_unary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Channel.stream_unary" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a StreamUnaryMultiCallable for a stream-unary method.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>method</strong> – The name of the RPC method.</p></li> |
| <li><p><strong>request_serializer</strong> – Optional <a class="reference internal" href="glossary.html#term-serializer"><span class="xref std std-term">serializer</span></a> for serializing the request |
| message. Request goes unserialized in case None is passed.</p></li> |
| <li><p><strong>response_deserializer</strong> – Optional <a class="reference internal" href="glossary.html#term-deserializer"><span class="xref std std-term">deserializer</span></a> for deserializing the |
| response message. Response goes undeserialized in case None is |
| passed.</p></li> |
| <li><p><strong>_registered_method</strong> – Implementation Private. A bool representing whether the method |
| is registered.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A StreamUnaryMultiCallable value for the named stream-unary method.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Channel.subscribe"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">subscribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">try_to_connect</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Channel.subscribe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Channel.subscribe" title="Link to this definition">¶</a></dt> |
| <dd><p>Subscribe to this Channel’s connectivity state machine.</p> |
| <p>A Channel may be in any of the states described by ChannelConnectivity. |
| This method allows application to monitor the state transitions. |
| The typical use case is to debug or gain better visibility into gRPC |
| runtime’s state.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>callback</strong> – A callable to be invoked with ChannelConnectivity argument. |
| ChannelConnectivity describes current state of the channel. |
| The callable will be invoked immediately upon subscription |
| and again for every change to ChannelConnectivity until it |
| is unsubscribed or this Channel object goes out of scope.</p></li> |
| <li><p><strong>try_to_connect</strong> – A boolean indicating whether or not this Channel |
| should attempt to connect immediately. If set to False, gRPC |
| runtime decides when to connect.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Channel.unary_stream"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unary_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_serializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_deserializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_registered_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Channel.unary_stream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Channel.unary_stream" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a UnaryStreamMultiCallable for a unary-stream method.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>method</strong> – The name of the RPC method.</p></li> |
| <li><p><strong>request_serializer</strong> – Optional <a class="reference internal" href="glossary.html#term-serializer"><span class="xref std std-term">serializer</span></a> for serializing the request |
| message. Request goes unserialized in case None is passed.</p></li> |
| <li><p><strong>response_deserializer</strong> – Optional <a class="reference internal" href="glossary.html#term-deserializer"><span class="xref std std-term">deserializer</span></a> for deserializing the |
| response message. Response goes undeserialized in case None is |
| passed.</p></li> |
| <li><p><strong>_registered_method</strong> – Implementation Private. A bool representing whether the method |
| is registered.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A UnaryStreamMultiCallable value for the name unary-stream method.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Channel.unary_unary"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unary_unary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_serializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_deserializer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_registered_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Channel.unary_unary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Channel.unary_unary" title="Link to this definition">¶</a></dt> |
| <dd><p>Creates a UnaryUnaryMultiCallable for a unary-unary method.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>method</strong> – The name of the RPC method.</p></li> |
| <li><p><strong>request_serializer</strong> – Optional <a class="reference internal" href="glossary.html#term-serializer"><span class="xref std std-term">serializer</span></a> for serializing the request |
| message. Request goes unserialized in case None is passed.</p></li> |
| <li><p><strong>response_deserializer</strong> – Optional <a class="reference internal" href="glossary.html#term-deserializer"><span class="xref std std-term">deserializer</span></a> for deserializing the |
| response message. Response goes undeserialized in case None |
| is passed.</p></li> |
| <li><p><strong>_registered_method</strong> – Implementation Private. A bool representing whether the method |
| is registered.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A UnaryUnaryMultiCallable value for the named unary-unary method.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Channel.unsubscribe"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unsubscribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Channel.unsubscribe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Channel.unsubscribe" title="Link to this definition">¶</a></dt> |
| <dd><p>Unsubscribes a subscribed callback from this Channel’s connectivity.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>callback</strong> – A callable previously registered with this Channel from</p></li> |
| <li><p><strong>method.</strong> (<em>having been passed to its "subscribe"</em>)</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="server-object"> |
| <h3>Server Object<a class="headerlink" href="#server-object" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.Server"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">Server</span></span><a class="reference internal" href="_modules/grpc.html#Server"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Server" title="Link to this definition">¶</a></dt> |
| <dd><p>Services RPCs.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Server.add_generic_rpc_handlers"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_generic_rpc_handlers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">generic_rpc_handlers</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Server.add_generic_rpc_handlers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Server.add_generic_rpc_handlers" title="Link to this definition">¶</a></dt> |
| <dd><p>Registers GenericRpcHandlers with this Server.</p> |
| <p>This method is only safe to call before the server is started.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>generic_rpc_handlers</strong> – An iterable of GenericRpcHandlers that will be</p></li> |
| <li><p><strong>RPCs.</strong> (<em>used to service</em>)</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Server.add_insecure_port"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_insecure_port</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Server.add_insecure_port"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Server.add_insecure_port" title="Link to this definition">¶</a></dt> |
| <dd><p>Opens an insecure port for accepting RPCs.</p> |
| <p>This method may only be called before starting the server.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>address</strong> – The address for which to open a port. If the port is 0, |
| or not specified in the address, then gRPC runtime will choose a port.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An integer port on which server will accept RPC requests.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Server.add_registered_method_handlers"> |
| <span class="sig-name descname"><span class="pre">add_registered_method_handlers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method_handlers</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Server.add_registered_method_handlers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Server.add_registered_method_handlers" title="Link to this definition">¶</a></dt> |
| <dd><p>Registers GenericRpcHandlers with this Server.</p> |
| <p>This method is only safe to call before the server is started.</p> |
| <p>If the same method have both generic and registered handler, |
| registered handler will take precedence.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>service_name</strong> – The service name.</p></li> |
| <li><p><strong>method_handlers</strong> – A dictionary that maps method names to corresponding |
| RpcMethodHandler.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Server.add_secure_port"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_secure_port</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_credentials</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Server.add_secure_port"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Server.add_secure_port" title="Link to this definition">¶</a></dt> |
| <dd><p>Opens a secure port for accepting RPCs.</p> |
| <p>This method may only be called before starting the server.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>address</strong> – The address for which to open a port. |
| if the port is 0, or not specified in the address, then gRPC |
| runtime will choose a port.</p></li> |
| <li><p><strong>server_credentials</strong> – A ServerCredentials object.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An integer port on which server will accept RPC requests.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Server.start"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Server.start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Server.start" title="Link to this definition">¶</a></dt> |
| <dd><p>Starts this Server.</p> |
| <p>This method may only be called once. (i.e. it is not idempotent).</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Server.stop"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">stop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">grace</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Server.stop"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Server.stop" title="Link to this definition">¶</a></dt> |
| <dd><p>Stops this Server.</p> |
| <p>This method immediately stop service of new RPCs in all cases.</p> |
| <p>If a grace period is specified, this method waits until all active |
| RPCs are finished or until the grace period is reached. RPCs that haven’t |
| been terminated within the grace period are aborted. |
| If a grace period is not specified (by passing None for <cite>grace</cite>), |
| all existing RPCs are aborted immediately and this method |
| blocks until the last RPC handler terminates.</p> |
| <p>This method is idempotent and may be called at any time. |
| Passing a smaller grace value in a subsequent call will have |
| the effect of stopping the Server sooner (passing None will |
| have the effect of stopping the server immediately). Passing |
| a larger grace value in a subsequent call <em>will not</em> have the |
| effect of stopping the server later (i.e. the most restrictive |
| grace value is used).</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>grace</strong> – A duration of time in seconds or None.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A threading.Event that will be set when this Server has completely |
| stopped, i.e. when running RPCs either complete or are aborted and |
| all handlers have terminated.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Server.wait_for_termination"> |
| <span class="sig-name descname"><span class="pre">wait_for_termination</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Server.wait_for_termination"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Server.wait_for_termination" title="Link to this definition">¶</a></dt> |
| <dd><p>Block current thread until the server stops.</p> |
| <p>This is an EXPERIMENTAL API.</p> |
| <p>The wait will not consume computational resources during blocking, and |
| it will block until one of the two following conditions are met:</p> |
| <ol class="arabic simple"> |
| <li><p>The server is stopped or terminated;</p></li> |
| <li><p>A timeout occurs if timeout is not <cite>None</cite>.</p></li> |
| </ol> |
| <p>The timeout argument works in the same way as <cite>threading.Event.wait()</cite>. |
| <a class="reference external" href="https://docs.python.org/3/library/threading.html#threading.Event.wait">https://docs.python.org/3/library/threading.html#threading.Event.wait</a></p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>timeout</strong> – A floating point number specifying a timeout for the |
| operation in seconds.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A bool indicates if the operation times out.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="authentication-authorization-objects"> |
| <h3>Authentication & Authorization Objects<a class="headerlink" href="#authentication-authorization-objects" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.ChannelCredentials"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">ChannelCredentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ChannelCredentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ChannelCredentials" title="Link to this definition">¶</a></dt> |
| <dd><p>An encapsulation of the data required to create a secure Channel.</p> |
| <p>This class has no supported interface - it exists to define the type of its |
| instances and its instances exist to be passed to other functions. For |
| example, ssl_channel_credentials returns an instance of this class and |
| secure_channel requires an instance of this class.</p> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.CallCredentials"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">CallCredentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#CallCredentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.CallCredentials" title="Link to this definition">¶</a></dt> |
| <dd><p>An encapsulation of the data required to assert an identity over a call.</p> |
| <p>A CallCredentials has to be used with secure Channel, otherwise the |
| metadata will not be transmitted to the server.</p> |
| <p>A CallCredentials may be composed with ChannelCredentials to always assert |
| identity for every call over that Channel.</p> |
| <p>This class has no supported interface - it exists to define the type of its |
| instances and its instances exist to be passed to other functions.</p> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.AuthMetadataContext"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">AuthMetadataContext</span></span><a class="reference internal" href="_modules/grpc.html#AuthMetadataContext"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.AuthMetadataContext" title="Link to this definition">¶</a></dt> |
| <dd><p>Provides information to call credentials metadata plugins.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.AuthMetadataContext.service_url"> |
| <span class="sig-name descname"><span class="pre">service_url</span></span><a class="headerlink" href="#grpc.AuthMetadataContext.service_url" title="Link to this definition">¶</a></dt> |
| <dd><p>A string URL of the service being called into.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.AuthMetadataContext.method_name"> |
| <span class="sig-name descname"><span class="pre">method_name</span></span><a class="headerlink" href="#grpc.AuthMetadataContext.method_name" title="Link to this definition">¶</a></dt> |
| <dd><p>A string of the fully qualified method name being called.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.AuthMetadataPluginCallback"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">AuthMetadataPluginCallback</span></span><a class="reference internal" href="_modules/grpc.html#AuthMetadataPluginCallback"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.AuthMetadataPluginCallback" title="Link to this definition">¶</a></dt> |
| <dd><p>Callback object received by a metadata plugin.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.AuthMetadataPluginCallback.__call__"> |
| <span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#AuthMetadataPluginCallback.__call__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.AuthMetadataPluginCallback.__call__" title="Link to this definition">¶</a></dt> |
| <dd><p>Passes to the gRPC runtime authentication metadata for an RPC.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>metadata</strong> – The <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> used to construct the CallCredentials.</p></li> |
| <li><p><strong>error</strong> – An Exception to indicate error or None to indicate success.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.AuthMetadataPlugin"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">AuthMetadataPlugin</span></span><a class="reference internal" href="_modules/grpc.html#AuthMetadataPlugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.AuthMetadataPlugin" title="Link to this definition">¶</a></dt> |
| <dd><p>A specification for custom authentication.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.AuthMetadataPlugin.__call__"> |
| <span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#AuthMetadataPlugin.__call__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.AuthMetadataPlugin.__call__" title="Link to this definition">¶</a></dt> |
| <dd><p>Implements authentication by passing metadata to a callback.</p> |
| <p>This method will be invoked asynchronously in a separate thread.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – An AuthMetadataContext providing information on the RPC that |
| the plugin is being called to authenticate.</p></li> |
| <li><p><strong>callback</strong> – An AuthMetadataPluginCallback to be invoked either |
| synchronously or asynchronously.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.ServerCredentials"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">ServerCredentials</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">credentials</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServerCredentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServerCredentials" title="Link to this definition">¶</a></dt> |
| <dd><p>An encapsulation of the data required to open a secure port on a Server.</p> |
| <p>This class has no supported interface - it exists to define the type of its |
| instances and its instances exist to be passed to other functions.</p> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.ServerCertificateConfiguration"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">ServerCertificateConfiguration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">certificate_configuration</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServerCertificateConfiguration"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServerCertificateConfiguration" title="Link to this definition">¶</a></dt> |
| <dd><p>A certificate configuration for use with an SSL-enabled Server.</p> |
| <p>Instances of this class can be returned in the certificate configuration |
| fetching callback.</p> |
| <p>This class has no supported interface – it exists to define the |
| type of its instances and its instances exist to be passed to |
| other functions.</p> |
| </dd></dl> |
| |
| </section> |
| <section id="grpc-exceptions"> |
| <h3>gRPC Exceptions<a class="headerlink" href="#grpc-exceptions" title="Link to this heading">¶</a></h3> |
| <dl class="py exception"> |
| <dt class="sig sig-object py" id="grpc.RpcError"> |
| <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">RpcError</span></span><a class="reference internal" href="_modules/grpc.html#RpcError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.RpcError" title="Link to this definition">¶</a></dt> |
| <dd><p>Raised by the gRPC library to indicate non-OK-status RPC termination.</p> |
| </dd></dl> |
| |
| </section> |
| <section id="rpc-context"> |
| <h3>RPC Context<a class="headerlink" href="#rpc-context" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.RpcContext"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">RpcContext</span></span><a class="reference internal" href="_modules/grpc.html#RpcContext"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.RpcContext" title="Link to this definition">¶</a></dt> |
| <dd><p>Provides RPC-related information and action.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.RpcContext.add_callback"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_callback</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#RpcContext.add_callback"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.RpcContext.add_callback" title="Link to this definition">¶</a></dt> |
| <dd><p>Registers a callback to be called on RPC termination.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>callback</strong> – A no-parameter callable to be called on RPC termination.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><dl class="simple"> |
| <dt>True if the callback was added and will be called later; False if</dt><dd><p>the callback was not added and will not be called (because the RPC |
| already terminated or some other reason).</p> |
| </dd> |
| </dl> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.RpcContext.cancel"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#RpcContext.cancel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.RpcContext.cancel" title="Link to this definition">¶</a></dt> |
| <dd><p>Cancels the RPC.</p> |
| <p>Idempotent and has no effect if the RPC has already terminated.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.RpcContext.is_active"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_active</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#RpcContext.is_active"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.RpcContext.is_active" title="Link to this definition">¶</a></dt> |
| <dd><p>Describes whether the RPC is active or has terminated.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>True if RPC is active, False otherwise.</p> |
| </dd> |
| <dt class="field-even">Return type<span class="colon">:</span></dt> |
| <dd class="field-even"><p>bool</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.RpcContext.time_remaining"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">time_remaining</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#RpcContext.time_remaining"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.RpcContext.time_remaining" title="Link to this definition">¶</a></dt> |
| <dd><p>Describes the length of allowed time remaining for the RPC.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A nonnegative float indicating the length of allowed time in seconds |
| remaining for the RPC to complete before it is considered to have |
| timed out, or None if no deadline was specified for the RPC.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="client-side-context"> |
| <h3>Client-Side Context<a class="headerlink" href="#client-side-context" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.Call"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">Call</span></span><a class="reference internal" href="_modules/grpc.html#Call"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Call" title="Link to this definition">¶</a></dt> |
| <dd><p>Invocation-side utility object for an RPC.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Call.code"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">code</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Call.code"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Call.code" title="Link to this definition">¶</a></dt> |
| <dd><p>Accesses the status code sent by the server.</p> |
| <p>This method blocks until the value is available.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The StatusCode value for the RPC.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Call.details"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">details</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Call.details"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Call.details" title="Link to this definition">¶</a></dt> |
| <dd><p>Accesses the details sent by the server.</p> |
| <p>This method blocks until the value is available.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The details string of the RPC.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Call.initial_metadata"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">initial_metadata</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Call.initial_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Call.initial_metadata" title="Link to this definition">¶</a></dt> |
| <dd><p>Accesses the initial metadata sent by the server.</p> |
| <p>This method blocks until the value is available.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The initial <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Call.trailing_metadata"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">trailing_metadata</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Call.trailing_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Call.trailing_metadata" title="Link to this definition">¶</a></dt> |
| <dd><p>Accesses the trailing metadata sent by the server.</p> |
| <p>This method blocks until the value is available.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The trailing <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="client-side-interceptor"> |
| <h3>Client-Side Interceptor<a class="headerlink" href="#client-side-interceptor" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.ClientCallDetails"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">ClientCallDetails</span></span><a class="reference internal" href="_modules/grpc.html#ClientCallDetails"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ClientCallDetails" title="Link to this definition">¶</a></dt> |
| <dd><p>Describes an RPC to be invoked.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.ClientCallDetails.method"> |
| <span class="sig-name descname"><span class="pre">method</span></span><a class="headerlink" href="#grpc.ClientCallDetails.method" title="Link to this definition">¶</a></dt> |
| <dd><p>The method name of the RPC.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.ClientCallDetails.timeout"> |
| <span class="sig-name descname"><span class="pre">timeout</span></span><a class="headerlink" href="#grpc.ClientCallDetails.timeout" title="Link to this definition">¶</a></dt> |
| <dd><p>An optional duration of time in seconds to allow for the RPC.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.ClientCallDetails.metadata"> |
| <span class="sig-name descname"><span class="pre">metadata</span></span><a class="headerlink" href="#grpc.ClientCallDetails.metadata" title="Link to this definition">¶</a></dt> |
| <dd><p>Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to |
| the service-side of the RPC.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.ClientCallDetails.credentials"> |
| <span class="sig-name descname"><span class="pre">credentials</span></span><a class="headerlink" href="#grpc.ClientCallDetails.credentials" title="Link to this definition">¶</a></dt> |
| <dd><p>An optional CallCredentials for the RPC.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.ClientCallDetails.wait_for_ready"> |
| <span class="sig-name descname"><span class="pre">wait_for_ready</span></span><a class="headerlink" href="#grpc.ClientCallDetails.wait_for_ready" title="Link to this definition">¶</a></dt> |
| <dd><p>An optional flag to enable <a class="reference internal" href="glossary.html#term-wait_for_ready"><span class="xref std std-term">wait_for_ready</span></a> mechanism.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.ClientCallDetails.compression"> |
| <span class="sig-name descname"><span class="pre">compression</span></span><a class="headerlink" href="#grpc.ClientCallDetails.compression" title="Link to this definition">¶</a></dt> |
| <dd><p>An element of grpc.compression, e.g. |
| grpc.compression.Gzip.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.UnaryUnaryClientInterceptor"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">UnaryUnaryClientInterceptor</span></span><a class="reference internal" href="_modules/grpc.html#UnaryUnaryClientInterceptor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.UnaryUnaryClientInterceptor" title="Link to this definition">¶</a></dt> |
| <dd><p>Affords intercepting unary-unary invocations.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.UnaryUnaryClientInterceptor.intercept_unary_unary"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">intercept_unary_unary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">continuation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_call_details</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#UnaryUnaryClientInterceptor.intercept_unary_unary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.UnaryUnaryClientInterceptor.intercept_unary_unary" title="Link to this definition">¶</a></dt> |
| <dd><p>Intercepts a unary-unary invocation asynchronously.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>continuation</strong> – A function that proceeds with the invocation by |
| executing the next interceptor in chain or invoking the |
| actual RPC on the underlying Channel. It is the interceptor’s |
| responsibility to call it if it decides to move the RPC forward. |
| The interceptor can use |
| <cite>response_future = continuation(client_call_details, request)</cite> |
| to continue with the RPC. <cite>continuation</cite> returns an object that is |
| both a Call for the RPC and a Future. In the event of RPC |
| completion, the return Call-Future’s result value will be |
| the response message of the RPC. Should the event terminate |
| with non-OK status, the returned Call-Future’s exception value |
| will be an RpcError.</p></li> |
| <li><p><strong>client_call_details</strong> – A ClientCallDetails object describing the |
| outgoing RPC.</p></li> |
| <li><p><strong>request</strong> – The request value for the RPC.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An object that is both a Call for the RPC and a Future. |
| In the event of RPC completion, the return Call-Future’s |
| result value will be the response message of the RPC. |
| Should the event terminate with non-OK status, the returned |
| Call-Future’s exception value will be an RpcError.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.UnaryStreamClientInterceptor"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">UnaryStreamClientInterceptor</span></span><a class="reference internal" href="_modules/grpc.html#UnaryStreamClientInterceptor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.UnaryStreamClientInterceptor" title="Link to this definition">¶</a></dt> |
| <dd><p>Affords intercepting unary-stream invocations.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.UnaryStreamClientInterceptor.intercept_unary_stream"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">intercept_unary_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">continuation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_call_details</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#UnaryStreamClientInterceptor.intercept_unary_stream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.UnaryStreamClientInterceptor.intercept_unary_stream" title="Link to this definition">¶</a></dt> |
| <dd><p>Intercepts a unary-stream invocation.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>continuation</strong> – A function that proceeds with the invocation by |
| executing the next interceptor in chain or invoking the |
| actual RPC on the underlying Channel. It is the interceptor’s |
| responsibility to call it if it decides to move the RPC forward. |
| The interceptor can use |
| <cite>response_iterator = continuation(client_call_details, request)</cite> |
| to continue with the RPC. <cite>continuation</cite> returns an object that is |
| both a Call for the RPC and an iterator for response values. |
| Drawing response values from the returned Call-iterator may |
| raise RpcError indicating termination of the RPC with non-OK |
| status.</p></li> |
| <li><p><strong>client_call_details</strong> – A ClientCallDetails object describing the |
| outgoing RPC.</p></li> |
| <li><p><strong>request</strong> – The request value for the RPC.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An object that is both a Call for the RPC and an iterator of |
| response values. Drawing response values from the returned |
| Call-iterator may raise RpcError indicating termination of |
| the RPC with non-OK status. This object <em>should</em> also fulfill the |
| Future interface, though it may not.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.StreamUnaryClientInterceptor"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">StreamUnaryClientInterceptor</span></span><a class="reference internal" href="_modules/grpc.html#StreamUnaryClientInterceptor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.StreamUnaryClientInterceptor" title="Link to this definition">¶</a></dt> |
| <dd><p>Affords intercepting stream-unary invocations.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.StreamUnaryClientInterceptor.intercept_stream_unary"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">intercept_stream_unary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">continuation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_call_details</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_iterator</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#StreamUnaryClientInterceptor.intercept_stream_unary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.StreamUnaryClientInterceptor.intercept_stream_unary" title="Link to this definition">¶</a></dt> |
| <dd><p>Intercepts a stream-unary invocation asynchronously.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>continuation</strong> – A function that proceeds with the invocation by |
| executing the next interceptor in chain or invoking the |
| actual RPC on the underlying Channel. It is the interceptor’s |
| responsibility to call it if it decides to move the RPC forward. |
| The interceptor can use |
| <cite>response_future = continuation(client_call_details, request_iterator)</cite> |
| to continue with the RPC. <cite>continuation</cite> returns an object that is |
| both a Call for the RPC and a Future. In the event of RPC completion, |
| the return Call-Future’s result value will be the response message |
| of the RPC. Should the event terminate with non-OK status, the |
| returned Call-Future’s exception value will be an RpcError.</p></li> |
| <li><p><strong>client_call_details</strong> – A ClientCallDetails object describing the |
| outgoing RPC.</p></li> |
| <li><p><strong>request_iterator</strong> – An iterator that yields request values for the RPC.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An object that is both a Call for the RPC and a Future. |
| In the event of RPC completion, the return Call-Future’s |
| result value will be the response message of the RPC. |
| Should the event terminate with non-OK status, the returned |
| Call-Future’s exception value will be an RpcError.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.StreamStreamClientInterceptor"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">StreamStreamClientInterceptor</span></span><a class="reference internal" href="_modules/grpc.html#StreamStreamClientInterceptor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.StreamStreamClientInterceptor" title="Link to this definition">¶</a></dt> |
| <dd><p>Affords intercepting stream-stream invocations.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.StreamStreamClientInterceptor.intercept_stream_stream"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">intercept_stream_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">continuation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_call_details</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_iterator</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#StreamStreamClientInterceptor.intercept_stream_stream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.StreamStreamClientInterceptor.intercept_stream_stream" title="Link to this definition">¶</a></dt> |
| <dd><p>Intercepts a stream-stream invocation.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>continuation</strong> – A function that proceeds with the invocation by |
| executing the next interceptor in chain or invoking the |
| actual RPC on the underlying Channel. It is the interceptor’s |
| responsibility to call it if it decides to move the RPC forward. |
| The interceptor can use |
| <cite>response_iterator = continuation(client_call_details, request_iterator)</cite> |
| to continue with the RPC. <cite>continuation</cite> returns an object that is |
| both a Call for the RPC and an iterator for response values. |
| Drawing response values from the returned Call-iterator may |
| raise RpcError indicating termination of the RPC with non-OK |
| status.</p></li> |
| <li><p><strong>client_call_details</strong> – A ClientCallDetails object describing the |
| outgoing RPC.</p></li> |
| <li><p><strong>request_iterator</strong> – An iterator that yields request values for the RPC.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An object that is both a Call for the RPC and an iterator of |
| response values. Drawing response values from the returned |
| Call-iterator may raise RpcError indicating termination of |
| the RPC with non-OK status. This object <em>should</em> also fulfill the |
| Future interface, though it may not.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="service-side-context"> |
| <h3>Service-Side Context<a class="headerlink" href="#service-side-context" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">ServicerContext</span></span><a class="reference internal" href="_modules/grpc.html#ServicerContext"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext" title="Link to this definition">¶</a></dt> |
| <dd><p>A context object passed to method implementations.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.abort"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">abort</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.abort"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.abort" title="Link to this definition">¶</a></dt> |
| <dd><p>Raises an exception to terminate the RPC with a non-OK status.</p> |
| <p>The code and details passed as arguments will supersede any existing |
| ones.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>code</strong> – A StatusCode object to be sent to the client. |
| It must not be StatusCode.OK.</p></li> |
| <li><p><strong>details</strong> – A UTF-8-encodable string to be sent to the client upon |
| termination of the RPC.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Raises<span class="colon">:</span></dt> |
| <dd class="field-even"><p><strong>Exception</strong> – An exception is always raised to signal the abortion the |
| RPC to the gRPC runtime.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.abort_with_status"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">abort_with_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.abort_with_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.abort_with_status" title="Link to this definition">¶</a></dt> |
| <dd><p>Raises an exception to terminate the RPC with a non-OK status.</p> |
| <p>The status passed as argument will supersede any existing status code, |
| status message and trailing metadata.</p> |
| <p>This is an EXPERIMENTAL API.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>status</strong> – A grpc.Status object. The status code in it must not be |
| StatusCode.OK.</p> |
| </dd> |
| <dt class="field-even">Raises<span class="colon">:</span></dt> |
| <dd class="field-even"><p><strong>Exception</strong> – An exception is always raised to signal the abortion the |
| RPC to the gRPC runtime.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.auth_context"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auth_context</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.auth_context"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.auth_context" title="Link to this definition">¶</a></dt> |
| <dd><p>Gets the auth context for the call.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A map of strings to an iterable of bytes for each auth property.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.code"> |
| <span class="sig-name descname"><span class="pre">code</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.code"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.code" title="Link to this definition">¶</a></dt> |
| <dd><p>Accesses the value to be used as status code upon RPC completion.</p> |
| <p>This is an EXPERIMENTAL API.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The StatusCode value for the RPC.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.details"> |
| <span class="sig-name descname"><span class="pre">details</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.details"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.details" title="Link to this definition">¶</a></dt> |
| <dd><p>Accesses the value to be used as detail string upon RPC completion.</p> |
| <p>This is an EXPERIMENTAL API.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The details string of the RPC.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.disable_next_message_compression"> |
| <span class="sig-name descname"><span class="pre">disable_next_message_compression</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.disable_next_message_compression"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.disable_next_message_compression" title="Link to this definition">¶</a></dt> |
| <dd><p>Disables compression for the next response message.</p> |
| <p>This method will override any compression configuration set during |
| server creation or set on the call.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.invocation_metadata"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">invocation_metadata</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.invocation_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.invocation_metadata" title="Link to this definition">¶</a></dt> |
| <dd><p>Accesses the metadata sent by the client.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The invocation <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.peer"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">peer</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.peer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.peer" title="Link to this definition">¶</a></dt> |
| <dd><p>Identifies the peer that invoked the RPC being serviced.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A string identifying the peer that invoked the RPC being serviced. |
| The string format is determined by gRPC runtime.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.peer_identities"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">peer_identities</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.peer_identities"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.peer_identities" title="Link to this definition">¶</a></dt> |
| <dd><p>Gets one or more peer identity(s).</p> |
| <p>Equivalent to |
| servicer_context.auth_context().get(servicer_context.peer_identity_key())</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>An iterable of the identities, or None if the call is not |
| authenticated. Each identity is returned as a raw bytes type.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.peer_identity_key"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">peer_identity_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.peer_identity_key"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.peer_identity_key" title="Link to this definition">¶</a></dt> |
| <dd><p>The auth property used to identify the peer.</p> |
| <p>For example, “x509_common_name” or “x509_subject_alternative_name” are |
| used to identify an SSL peer.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The auth property (string) that indicates the |
| peer identity, or None if the call is not authenticated.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.send_initial_metadata"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">send_initial_metadata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">initial_metadata</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.send_initial_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.send_initial_metadata" title="Link to this definition">¶</a></dt> |
| <dd><p>Sends the initial metadata value to the client.</p> |
| <p>This method need not be called by implementations if they have no |
| metadata to add to what the gRPC runtime will transmit.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>initial_metadata</strong> – The initial <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.set_code"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_code</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.set_code"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.set_code" title="Link to this definition">¶</a></dt> |
| <dd><p>Sets the value to be used as status code upon RPC completion.</p> |
| <p>This method need not be called by method implementations if they wish |
| the gRPC runtime to determine the status code of the RPC.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>code</strong> – A StatusCode object to be sent to the client.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.set_compression"> |
| <span class="sig-name descname"><span class="pre">set_compression</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compression</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.set_compression"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.set_compression" title="Link to this definition">¶</a></dt> |
| <dd><p>Set the compression algorithm to be used for the entire call.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>compression</strong> – An element of grpc.compression, e.g. |
| grpc.compression.Gzip.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.set_details"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_details</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">details</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.set_details"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.set_details" title="Link to this definition">¶</a></dt> |
| <dd><p>Sets the value to be used as detail string upon RPC completion.</p> |
| <p>This method need not be called by method implementations if they have |
| no details to transmit.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>details</strong> – A UTF-8-encodable string to be sent to the client upon |
| termination of the RPC.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.set_trailing_metadata"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_trailing_metadata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trailing_metadata</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.set_trailing_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.set_trailing_metadata" title="Link to this definition">¶</a></dt> |
| <dd><p>Sets the trailing metadata for the RPC.</p> |
| <p>Sets the trailing metadata to be sent upon completion of the RPC.</p> |
| <p>If this method is invoked multiple times throughout the lifetime of an |
| RPC, the value supplied in the final invocation will be the value sent |
| over the wire.</p> |
| <p>This method need not be called by implementations if they have no |
| metadata to add to what the gRPC runtime will transmit.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>trailing_metadata</strong> – The trailing <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServicerContext.trailing_metadata"> |
| <span class="sig-name descname"><span class="pre">trailing_metadata</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServicerContext.trailing_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServicerContext.trailing_metadata" title="Link to this definition">¶</a></dt> |
| <dd><p>Access value to be used as trailing metadata upon RPC completion.</p> |
| <p>This is an EXPERIMENTAL API.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The trailing <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> for the RPC.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="service-side-handler"> |
| <h3>Service-Side Handler<a class="headerlink" href="#service-side-handler" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.RpcMethodHandler"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">RpcMethodHandler</span></span><a class="reference internal" href="_modules/grpc.html#RpcMethodHandler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.RpcMethodHandler" title="Link to this definition">¶</a></dt> |
| <dd><p>An implementation of a single RPC method.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.RpcMethodHandler.request_streaming"> |
| <span class="sig-name descname"><span class="pre">request_streaming</span></span><a class="headerlink" href="#grpc.RpcMethodHandler.request_streaming" title="Link to this definition">¶</a></dt> |
| <dd><p>Whether the RPC supports exactly one request message |
| or any arbitrary number of request messages.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.RpcMethodHandler.response_streaming"> |
| <span class="sig-name descname"><span class="pre">response_streaming</span></span><a class="headerlink" href="#grpc.RpcMethodHandler.response_streaming" title="Link to this definition">¶</a></dt> |
| <dd><p>Whether the RPC supports exactly one response message |
| or any arbitrary number of response messages.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.RpcMethodHandler.request_deserializer"> |
| <span class="sig-name descname"><span class="pre">request_deserializer</span></span><a class="headerlink" href="#grpc.RpcMethodHandler.request_deserializer" title="Link to this definition">¶</a></dt> |
| <dd><p>A callable <a class="reference internal" href="glossary.html#term-deserializer"><span class="xref std std-term">deserializer</span></a> that accepts a byte string and |
| returns an object suitable to be passed to this object’s business |
| logic, or None to indicate that this object’s business logic should be |
| passed the raw request bytes.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.RpcMethodHandler.response_serializer"> |
| <span class="sig-name descname"><span class="pre">response_serializer</span></span><a class="headerlink" href="#grpc.RpcMethodHandler.response_serializer" title="Link to this definition">¶</a></dt> |
| <dd><p>A callable <a class="reference internal" href="glossary.html#term-serializer"><span class="xref std std-term">serializer</span></a> that accepts an object produced |
| by this object’s business logic and returns a byte string, or None to |
| indicate that the byte strings produced by this object’s business logic |
| should be transmitted on the wire as they are.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.RpcMethodHandler.unary_unary"> |
| <span class="sig-name descname"><span class="pre">unary_unary</span></span><a class="headerlink" href="#grpc.RpcMethodHandler.unary_unary" title="Link to this definition">¶</a></dt> |
| <dd><p>This object’s application-specific business logic as a |
| callable value that takes a request value and a ServicerContext object |
| and returns a response value. Only non-None if both request_streaming |
| and response_streaming are False.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.RpcMethodHandler.unary_stream"> |
| <span class="sig-name descname"><span class="pre">unary_stream</span></span><a class="headerlink" href="#grpc.RpcMethodHandler.unary_stream" title="Link to this definition">¶</a></dt> |
| <dd><p>This object’s application-specific business logic as a |
| callable value that takes a request value and a ServicerContext object |
| and returns an iterator of response values. Only non-None if |
| request_streaming is False and response_streaming is True.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.RpcMethodHandler.stream_unary"> |
| <span class="sig-name descname"><span class="pre">stream_unary</span></span><a class="headerlink" href="#grpc.RpcMethodHandler.stream_unary" title="Link to this definition">¶</a></dt> |
| <dd><p>This object’s application-specific business logic as a |
| callable value that takes an iterator of request values and a |
| ServicerContext object and returns a response value. Only non-None if |
| request_streaming is True and response_streaming is False.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.RpcMethodHandler.stream_stream"> |
| <span class="sig-name descname"><span class="pre">stream_stream</span></span><a class="headerlink" href="#grpc.RpcMethodHandler.stream_stream" title="Link to this definition">¶</a></dt> |
| <dd><p>This object’s application-specific business logic as a |
| callable value that takes an iterator of request values and a |
| ServicerContext object and returns an iterator of response values. |
| Only non-None if request_streaming and response_streaming are both |
| True.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.HandlerCallDetails"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">HandlerCallDetails</span></span><a class="reference internal" href="_modules/grpc.html#HandlerCallDetails"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.HandlerCallDetails" title="Link to this definition">¶</a></dt> |
| <dd><p>Describes an RPC that has just arrived for service.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.HandlerCallDetails.method"> |
| <span class="sig-name descname"><span class="pre">method</span></span><a class="headerlink" href="#grpc.HandlerCallDetails.method" title="Link to this definition">¶</a></dt> |
| <dd><p>The method name of the RPC.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.HandlerCallDetails.invocation_metadata"> |
| <span class="sig-name descname"><span class="pre">invocation_metadata</span></span><a class="headerlink" href="#grpc.HandlerCallDetails.invocation_metadata" title="Link to this definition">¶</a></dt> |
| <dd><p>The <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> sent by the client.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.GenericRpcHandler"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">GenericRpcHandler</span></span><a class="reference internal" href="_modules/grpc.html#GenericRpcHandler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.GenericRpcHandler" title="Link to this definition">¶</a></dt> |
| <dd><p>An implementation of arbitrarily many RPC methods.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.GenericRpcHandler.service"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler_call_details</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#GenericRpcHandler.service"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.GenericRpcHandler.service" title="Link to this definition">¶</a></dt> |
| <dd><p>Returns the handler for servicing the RPC.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>handler_call_details</strong> – A HandlerCallDetails describing the RPC.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An RpcMethodHandler with which the RPC may be serviced if the |
| implementation chooses to service this RPC, or None otherwise.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.ServiceRpcHandler"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">ServiceRpcHandler</span></span><a class="reference internal" href="_modules/grpc.html#ServiceRpcHandler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServiceRpcHandler" title="Link to this definition">¶</a></dt> |
| <dd><p>An implementation of RPC methods belonging to a service.</p> |
| <p>A service handles RPC methods with structured names of the form |
| ‘/Service.Name/Service.Method’, where ‘Service.Name’ is the value |
| returned by service_name(), and ‘Service.Method’ is the method |
| name. A service can have multiple method names, but only a single |
| service name.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServiceRpcHandler.service_name"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServiceRpcHandler.service_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServiceRpcHandler.service_name" title="Link to this definition">¶</a></dt> |
| <dd><p>Returns this service’s name.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The service name.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="service-side-interceptor"> |
| <h3>Service-Side Interceptor<a class="headerlink" href="#service-side-interceptor" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.ServerInterceptor"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">ServerInterceptor</span></span><a class="reference internal" href="_modules/grpc.html#ServerInterceptor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServerInterceptor" title="Link to this definition">¶</a></dt> |
| <dd><p>Affords intercepting incoming RPCs on the service-side.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.ServerInterceptor.intercept_service"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">intercept_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">continuation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler_call_details</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#ServerInterceptor.intercept_service"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.ServerInterceptor.intercept_service" title="Link to this definition">¶</a></dt> |
| <dd><p>Intercepts incoming RPCs before handing them over to a handler.</p> |
| <p>State can be passed from an interceptor to downstream interceptors |
| via contextvars. The first interceptor is called from an empty |
| contextvars.Context, and the same Context is used for downstream |
| interceptors and for the final handler call. Note that there are no |
| guarantees that interceptors and handlers will be called from the |
| same thread.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>continuation</strong> – A function that takes a HandlerCallDetails and |
| proceeds to invoke the next interceptor in the chain, if any, |
| or the RPC handler lookup logic, with the call details passed |
| as an argument, and returns an RpcMethodHandler instance if |
| the RPC is considered serviced, or None otherwise.</p></li> |
| <li><p><strong>handler_call_details</strong> – A HandlerCallDetails describing the RPC.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An RpcMethodHandler with which the RPC may be serviced if the |
| interceptor chooses to service this RPC, or None otherwise.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="multi-callable-interfaces"> |
| <h3>Multi-Callable Interfaces<a class="headerlink" href="#multi-callable-interfaces" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.UnaryUnaryMultiCallable"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">UnaryUnaryMultiCallable</span></span><a class="reference internal" href="_modules/grpc.html#UnaryUnaryMultiCallable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.UnaryUnaryMultiCallable" title="Link to this definition">¶</a></dt> |
| <dd><p>Affords invoking a unary-unary RPC from client-side.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.UnaryUnaryMultiCallable.__call__"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait_for_ready</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#UnaryUnaryMultiCallable.__call__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.UnaryUnaryMultiCallable.__call__" title="Link to this definition">¶</a></dt> |
| <dd><p>Synchronously invokes the underlying RPC.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>request</strong> – The request value for the RPC.</p></li> |
| <li><p><strong>timeout</strong> – An optional duration of time in seconds to allow |
| for the RPC.</p></li> |
| <li><p><strong>metadata</strong> – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the |
| service-side of the RPC.</p></li> |
| <li><p><strong>credentials</strong> – An optional CallCredentials for the RPC. Only valid for |
| secure Channel.</p></li> |
| <li><p><strong>wait_for_ready</strong> – An optional flag to enable <a class="reference internal" href="glossary.html#term-wait_for_ready"><span class="xref std std-term">wait_for_ready</span></a> mechanism.</p></li> |
| <li><p><strong>compression</strong> – An element of grpc.compression, e.g. |
| grpc.compression.Gzip.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The response value for the RPC.</p> |
| </dd> |
| <dt class="field-odd">Raises<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><a class="reference internal" href="#grpc.RpcError" title="grpc.RpcError"><strong>RpcError</strong></a> – Indicating that the RPC terminated with non-OK status. The |
| raised RpcError will also be a Call for the RPC affording the RPC’s |
| metadata, status code, and details.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.UnaryUnaryMultiCallable.future"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">future</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait_for_ready</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#UnaryUnaryMultiCallable.future"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.UnaryUnaryMultiCallable.future" title="Link to this definition">¶</a></dt> |
| <dd><p>Asynchronously invokes the underlying RPC.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>request</strong> – The request value for the RPC.</p></li> |
| <li><p><strong>timeout</strong> – An optional duration of time in seconds to allow for |
| the RPC.</p></li> |
| <li><p><strong>metadata</strong> – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the |
| service-side of the RPC.</p></li> |
| <li><p><strong>credentials</strong> – An optional CallCredentials for the RPC. Only valid for |
| secure Channel.</p></li> |
| <li><p><strong>wait_for_ready</strong> – An optional flag to enable <a class="reference internal" href="glossary.html#term-wait_for_ready"><span class="xref std std-term">wait_for_ready</span></a> mechanism.</p></li> |
| <li><p><strong>compression</strong> – An element of grpc.compression, e.g. |
| grpc.compression.Gzip.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An object that is both a Call for the RPC and a Future. |
| In the event of RPC completion, the return Call-Future’s result |
| value will be the response message of the RPC. |
| Should the event terminate with non-OK status, |
| the returned Call-Future’s exception value will be an RpcError.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.UnaryUnaryMultiCallable.with_call"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">with_call</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait_for_ready</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#UnaryUnaryMultiCallable.with_call"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.UnaryUnaryMultiCallable.with_call" title="Link to this definition">¶</a></dt> |
| <dd><p>Synchronously invokes the underlying RPC.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>request</strong> – The request value for the RPC.</p></li> |
| <li><p><strong>timeout</strong> – An optional durating of time in seconds to allow for |
| the RPC.</p></li> |
| <li><p><strong>metadata</strong> – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the |
| service-side of the RPC.</p></li> |
| <li><p><strong>credentials</strong> – An optional CallCredentials for the RPC. Only valid for |
| secure Channel.</p></li> |
| <li><p><strong>wait_for_ready</strong> – An optional flag to enable <a class="reference internal" href="glossary.html#term-wait_for_ready"><span class="xref std std-term">wait_for_ready</span></a> mechanism.</p></li> |
| <li><p><strong>compression</strong> – An element of grpc.compression, e.g. |
| grpc.compression.Gzip.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The response value for the RPC and a Call value for the RPC.</p> |
| </dd> |
| <dt class="field-odd">Raises<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><a class="reference internal" href="#grpc.RpcError" title="grpc.RpcError"><strong>RpcError</strong></a> – Indicating that the RPC terminated with non-OK status. The |
| raised RpcError will also be a Call for the RPC affording the RPC’s |
| metadata, status code, and details.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.UnaryStreamMultiCallable"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">UnaryStreamMultiCallable</span></span><a class="reference internal" href="_modules/grpc.html#UnaryStreamMultiCallable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.UnaryStreamMultiCallable" title="Link to this definition">¶</a></dt> |
| <dd><p>Affords invoking a unary-stream RPC from client-side.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.UnaryStreamMultiCallable.__call__"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait_for_ready</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#UnaryStreamMultiCallable.__call__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.UnaryStreamMultiCallable.__call__" title="Link to this definition">¶</a></dt> |
| <dd><p>Invokes the underlying RPC.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>request</strong> – The request value for the RPC.</p></li> |
| <li><p><strong>timeout</strong> – An optional duration of time in seconds to allow for |
| the RPC. If None, the timeout is considered infinite.</p></li> |
| <li><p><strong>metadata</strong> – An optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the |
| service-side of the RPC.</p></li> |
| <li><p><strong>credentials</strong> – An optional CallCredentials for the RPC. Only valid for |
| secure Channel.</p></li> |
| <li><p><strong>wait_for_ready</strong> – An optional flag to enable <a class="reference internal" href="glossary.html#term-wait_for_ready"><span class="xref std std-term">wait_for_ready</span></a> mechanism.</p></li> |
| <li><p><strong>compression</strong> – An element of grpc.compression, e.g. |
| grpc.compression.Gzip.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An object that is a Call for the RPC, an iterator of response |
| values, and a Future for the RPC. Drawing response values from the |
| returned Call-iterator may raise RpcError indicating termination of |
| the RPC with non-OK status.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.StreamUnaryMultiCallable"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">StreamUnaryMultiCallable</span></span><a class="reference internal" href="_modules/grpc.html#StreamUnaryMultiCallable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.StreamUnaryMultiCallable" title="Link to this definition">¶</a></dt> |
| <dd><p>Affords invoking a stream-unary RPC from client-side.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.StreamUnaryMultiCallable.__call__"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_iterator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait_for_ready</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#StreamUnaryMultiCallable.__call__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.StreamUnaryMultiCallable.__call__" title="Link to this definition">¶</a></dt> |
| <dd><p>Synchronously invokes the underlying RPC.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>request_iterator</strong> – An iterator that yields request values for |
| the RPC.</p></li> |
| <li><p><strong>timeout</strong> – An optional duration of time in seconds to allow for |
| the RPC. If None, the timeout is considered infinite.</p></li> |
| <li><p><strong>metadata</strong> – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the |
| service-side of the RPC.</p></li> |
| <li><p><strong>credentials</strong> – An optional CallCredentials for the RPC. Only valid for |
| secure Channel.</p></li> |
| <li><p><strong>wait_for_ready</strong> – An optional flag to enable <a class="reference internal" href="glossary.html#term-wait_for_ready"><span class="xref std std-term">wait_for_ready</span></a> mechanism.</p></li> |
| <li><p><strong>compression</strong> – An element of grpc.compression, e.g. |
| grpc.compression.Gzip.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The response value for the RPC.</p> |
| </dd> |
| <dt class="field-odd">Raises<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><a class="reference internal" href="#grpc.RpcError" title="grpc.RpcError"><strong>RpcError</strong></a> – Indicating that the RPC terminated with non-OK status. The |
| raised RpcError will also implement grpc.Call, affording methods |
| such as metadata, code, and details.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.StreamUnaryMultiCallable.future"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">future</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_iterator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait_for_ready</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#StreamUnaryMultiCallable.future"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.StreamUnaryMultiCallable.future" title="Link to this definition">¶</a></dt> |
| <dd><p>Asynchronously invokes the underlying RPC on the client.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>request_iterator</strong> – An iterator that yields request values for the RPC.</p></li> |
| <li><p><strong>timeout</strong> – An optional duration of time in seconds to allow for |
| the RPC. If None, the timeout is considered infinite.</p></li> |
| <li><p><strong>metadata</strong> – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the |
| service-side of the RPC.</p></li> |
| <li><p><strong>credentials</strong> – An optional CallCredentials for the RPC. Only valid for |
| secure Channel.</p></li> |
| <li><p><strong>wait_for_ready</strong> – An optional flag to enable <a class="reference internal" href="glossary.html#term-wait_for_ready"><span class="xref std std-term">wait_for_ready</span></a> mechanism.</p></li> |
| <li><p><strong>compression</strong> – An element of grpc.compression, e.g. |
| grpc.compression.Gzip.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An object that is both a Call for the RPC and a Future. |
| In the event of RPC completion, the return Call-Future’s result value |
| will be the response message of the RPC. Should the event terminate |
| with non-OK status, the returned Call-Future’s exception value will |
| be an RpcError.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.StreamUnaryMultiCallable.with_call"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">with_call</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_iterator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait_for_ready</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#StreamUnaryMultiCallable.with_call"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.StreamUnaryMultiCallable.with_call" title="Link to this definition">¶</a></dt> |
| <dd><p>Synchronously invokes the underlying RPC on the client.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>request_iterator</strong> – An iterator that yields request values for |
| the RPC.</p></li> |
| <li><p><strong>timeout</strong> – An optional duration of time in seconds to allow for |
| the RPC. If None, the timeout is considered infinite.</p></li> |
| <li><p><strong>metadata</strong> – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the |
| service-side of the RPC.</p></li> |
| <li><p><strong>credentials</strong> – An optional CallCredentials for the RPC. Only valid for |
| secure Channel.</p></li> |
| <li><p><strong>wait_for_ready</strong> – An optional flag to enable <a class="reference internal" href="glossary.html#term-wait_for_ready"><span class="xref std std-term">wait_for_ready</span></a> mechanism.</p></li> |
| <li><p><strong>compression</strong> – An element of grpc.compression, e.g. |
| grpc.compression.Gzip.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The response value for the RPC and a Call object for the RPC.</p> |
| </dd> |
| <dt class="field-odd">Raises<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><a class="reference internal" href="#grpc.RpcError" title="grpc.RpcError"><strong>RpcError</strong></a> – Indicating that the RPC terminated with non-OK status. The |
| raised RpcError will also be a Call for the RPC affording the RPC’s |
| metadata, status code, and details.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.StreamStreamMultiCallable"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">StreamStreamMultiCallable</span></span><a class="reference internal" href="_modules/grpc.html#StreamStreamMultiCallable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.StreamStreamMultiCallable" title="Link to this definition">¶</a></dt> |
| <dd><p>Affords invoking a stream-stream RPC on client-side.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.StreamStreamMultiCallable.__call__"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_iterator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait_for_ready</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#StreamStreamMultiCallable.__call__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.StreamStreamMultiCallable.__call__" title="Link to this definition">¶</a></dt> |
| <dd><p>Invokes the underlying RPC on the client.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>request_iterator</strong> – An iterator that yields request values for the RPC.</p></li> |
| <li><p><strong>timeout</strong> – An optional duration of time in seconds to allow for |
| the RPC. If not specified, the timeout is considered infinite.</p></li> |
| <li><p><strong>metadata</strong> – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the |
| service-side of the RPC.</p></li> |
| <li><p><strong>credentials</strong> – An optional CallCredentials for the RPC. Only valid for |
| secure Channel.</p></li> |
| <li><p><strong>wait_for_ready</strong> – An optional flag to enable <a class="reference internal" href="glossary.html#term-wait_for_ready"><span class="xref std std-term">wait_for_ready</span></a> mechanism.</p></li> |
| <li><p><strong>compression</strong> – An element of grpc.compression, e.g. |
| grpc.compression.Gzip.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An object that is a Call for the RPC, an iterator of response |
| values, and a Future for the RPC. Drawing response values from the |
| returned Call-iterator may raise RpcError indicating termination of |
| the RPC with non-OK status.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="future-interfaces"> |
| <h3>Future Interfaces<a class="headerlink" href="#future-interfaces" title="Link to this heading">¶</a></h3> |
| <dl class="py exception"> |
| <dt class="sig sig-object py" id="grpc.FutureTimeoutError"> |
| <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">FutureTimeoutError</span></span><a class="reference internal" href="_modules/grpc.html#FutureTimeoutError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.FutureTimeoutError" title="Link to this definition">¶</a></dt> |
| <dd><p>Indicates that a method call on a Future timed out.</p> |
| </dd></dl> |
| |
| <dl class="py exception"> |
| <dt class="sig sig-object py" id="grpc.FutureCancelledError"> |
| <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">FutureCancelledError</span></span><a class="reference internal" href="_modules/grpc.html#FutureCancelledError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.FutureCancelledError" title="Link to this definition">¶</a></dt> |
| <dd><p>Indicates that the computation underlying a Future was cancelled.</p> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.Future"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">Future</span></span><a class="reference internal" href="_modules/grpc.html#Future"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Future" title="Link to this definition">¶</a></dt> |
| <dd><p>A representation of a computation in another control flow.</p> |
| <p>Computations represented by a Future may be yet to be begun, |
| may be ongoing, or may have already completed.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Future.add_done_callback"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_done_callback</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fn</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Future.add_done_callback"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Future.add_done_callback" title="Link to this definition">¶</a></dt> |
| <dd><p>Adds a function to be called at completion of the computation.</p> |
| <p>The callback will be passed this Future object describing the outcome |
| of the computation. Callbacks will be invoked after the future is |
| terminated, whether successfully or not.</p> |
| <p>If the computation has already completed, the callback will be called |
| immediately.</p> |
| <p>Exceptions raised in the callback will be logged at ERROR level, but |
| will not terminate any threads of execution.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>fn</strong> – A callable taking this Future object as its single parameter.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Future.cancel"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Future.cancel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Future.cancel" title="Link to this definition">¶</a></dt> |
| <dd><p>Attempts to cancel the computation.</p> |
| <p>This method does not block.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><p>Returns True if the computation was canceled.</p> |
| <p>Returns False under all other circumstances, for example:</p> |
| <ol class="arabic simple"> |
| <li><p>computation has begun and could not be canceled.</p></li> |
| <li><p>computation has finished</p></li> |
| <li><dl class="simple"> |
| <dt>computation is scheduled for execution and it is impossible</dt><dd><p>to determine its state without blocking.</p> |
| </dd> |
| </dl> |
| </li> |
| </ol> |
| </p> |
| </dd> |
| <dt class="field-even">Return type<span class="colon">:</span></dt> |
| <dd class="field-even"><p>bool</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Future.cancelled"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cancelled</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Future.cancelled"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Future.cancelled" title="Link to this definition">¶</a></dt> |
| <dd><p>Describes whether the computation was cancelled.</p> |
| <p>This method does not block.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><p>Returns True if the computation was cancelled before its result became |
| available.</p> |
| <p>Returns False under all other circumstances, for example:</p> |
| <ol class="arabic simple"> |
| <li><p>computation was not cancelled.</p></li> |
| <li><p>computation’s result is available.</p></li> |
| </ol> |
| </p> |
| </dd> |
| <dt class="field-even">Return type<span class="colon">:</span></dt> |
| <dd class="field-even"><p>bool</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Future.done"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">done</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Future.done"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Future.done" title="Link to this definition">¶</a></dt> |
| <dd><p>Describes whether the computation has taken place.</p> |
| <p>This method does not block.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Returns True if the computation already executed or was cancelled. |
| Returns False if the computation is scheduled for execution or |
| currently executing. |
| This is exactly opposite of the running() method’s result.</p> |
| </dd> |
| <dt class="field-even">Return type<span class="colon">:</span></dt> |
| <dd class="field-even"><p>bool</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Future.exception"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">exception</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Future.exception"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Future.exception" title="Link to this definition">¶</a></dt> |
| <dd><p>Return the exception raised by the computation.</p> |
| <p>This method may return immediately or may block.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>timeout</strong> – The length of time in seconds to wait for the computation to |
| terminate or be cancelled. If None, the call will block until the |
| computations’s termination.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The exception raised by the computation, or None if the computation |
| did not raise an exception.</p> |
| </dd> |
| <dt class="field-odd">Raises<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><a class="reference internal" href="#grpc.FutureTimeoutError" title="grpc.FutureTimeoutError"><strong>FutureTimeoutError</strong></a> – If a timeout value is passed and the computation |
| does not terminate within the allotted time.</p></li> |
| <li><p><a class="reference internal" href="#grpc.FutureCancelledError" title="grpc.FutureCancelledError"><strong>FutureCancelledError</strong></a> – If the computation was cancelled.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Future.result"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Future.result"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Future.result" title="Link to this definition">¶</a></dt> |
| <dd><p>Returns the result of the computation or raises its exception.</p> |
| <p>This method may return immediately or may block.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>timeout</strong> – The length of time in seconds to wait for the computation to |
| finish or be cancelled. If None, the call will block until the |
| computations’s termination.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The return value of the computation.</p> |
| </dd> |
| <dt class="field-odd">Raises<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><a class="reference internal" href="#grpc.FutureTimeoutError" title="grpc.FutureTimeoutError"><strong>FutureTimeoutError</strong></a> – If a timeout value is passed and the computation |
| does not terminate within the allotted time.</p></li> |
| <li><p><a class="reference internal" href="#grpc.FutureCancelledError" title="grpc.FutureCancelledError"><strong>FutureCancelledError</strong></a> – If the computation was cancelled.</p></li> |
| <li><p><strong>Exception</strong> – If the computation raised an exception, this call will |
| raise the same exception.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Future.running"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">running</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Future.running"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Future.running" title="Link to this definition">¶</a></dt> |
| <dd><p>Describes whether the computation is taking place.</p> |
| <p>This method does not block.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><p>Returns True if the computation is scheduled for execution or |
| currently executing.</p> |
| <p>Returns False if the computation already executed or was cancelled.</p> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="grpc.Future.traceback"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">traceback</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Future.traceback"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Future.traceback" title="Link to this definition">¶</a></dt> |
| <dd><p>Access the traceback of the exception raised by the computation.</p> |
| <p>This method may return immediately or may block.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>timeout</strong> – The length of time in seconds to wait for the computation |
| to terminate or be cancelled. If None, the call will block until |
| the computation’s termination.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The traceback of the exception raised by the computation, or None |
| if the computation did not raise an exception.</p> |
| </dd> |
| <dt class="field-odd">Raises<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><a class="reference internal" href="#grpc.FutureTimeoutError" title="grpc.FutureTimeoutError"><strong>FutureTimeoutError</strong></a> – If a timeout value is passed and the computation |
| does not terminate within the allotted time.</p></li> |
| <li><p><a class="reference internal" href="#grpc.FutureCancelledError" title="grpc.FutureCancelledError"><strong>FutureCancelledError</strong></a> – If the computation was cancelled.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="compression"> |
| <h3>Compression<a class="headerlink" href="#compression" title="Link to this heading">¶</a></h3> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="grpc.Compression"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">Compression</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#Compression"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.Compression" title="Link to this definition">¶</a></dt> |
| <dd><p>Indicates the compression method to be used for an RPC.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.Compression.NoCompression"> |
| <span class="sig-name descname"><span class="pre">NoCompression</span></span><a class="headerlink" href="#grpc.Compression.NoCompression" title="Link to this definition">¶</a></dt> |
| <dd><p>Do not use compression algorithm.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.Compression.Deflate"> |
| <span class="sig-name descname"><span class="pre">Deflate</span></span><a class="headerlink" href="#grpc.Compression.Deflate" title="Link to this definition">¶</a></dt> |
| <dd><p>Use “Deflate” compression algorithm.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="grpc.Compression.Gzip"> |
| <span class="sig-name descname"><span class="pre">Gzip</span></span><a class="headerlink" href="#grpc.Compression.Gzip" title="Link to this definition">¶</a></dt> |
| <dd><p>Use “Gzip” compression algorithm.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="runtime-protobuf-parsing"> |
| <h3>Runtime Protobuf Parsing<a class="headerlink" href="#runtime-protobuf-parsing" title="Link to this heading">¶</a></h3> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.protos"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">protos</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">protobuf_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/_runtime_protos.html#protos"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.protos" title="Link to this definition">¶</a></dt> |
| <dd><p>Returns a module generated by the indicated .proto file.</p> |
| <p>THIS IS AN EXPERIMENTAL API.</p> |
| <p>Use this function to retrieve classes corresponding to message |
| definitions in the .proto file.</p> |
| <p>To inspect the contents of the returned module, use the dir function. |
| For example:</p> |
| <p><code class="docutils literal notranslate"><span class="pre">`</span> |
| <span class="pre">protos</span> <span class="pre">=</span> <span class="pre">grpc.protos("foo.proto")</span> |
| <span class="pre">print(dir(protos))</span> |
| <span class="pre">`</span></code></p> |
| <p>The returned module object corresponds to the _pb2.py file generated |
| by protoc. The path is expected to be relative to an entry on sys.path |
| and all transitive dependencies of the file should also be resolvable |
| from an entry on sys.path.</p> |
| <p>To completely disable the machinery behind this function, set the |
| GRPC_PYTHON_DISABLE_DYNAMIC_STUBS environment variable to “true”.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>protobuf_path</strong> – The path to the .proto file on the filesystem. This path |
| must be resolvable from an entry on sys.path and so must all of its |
| transitive dependencies.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A module object corresponding to the message code for the indicated |
| .proto file. Equivalent to a generated _pb2.py file.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.services"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">protobuf_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/_runtime_protos.html#services"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.services" title="Link to this definition">¶</a></dt> |
| <dd><p>Returns a module generated by the indicated .proto file.</p> |
| <p>THIS IS AN EXPERIMENTAL API.</p> |
| <p>Use this function to retrieve classes and functions corresponding to |
| service definitions in the .proto file, including both stub and servicer |
| definitions.</p> |
| <p>To inspect the contents of the returned module, use the dir function. |
| For example:</p> |
| <p><code class="docutils literal notranslate"><span class="pre">`</span> |
| <span class="pre">services</span> <span class="pre">=</span> <span class="pre">grpc.services("foo.proto")</span> |
| <span class="pre">print(dir(services))</span> |
| <span class="pre">`</span></code></p> |
| <p>The returned module object corresponds to the _pb2_grpc.py file generated |
| by protoc. The path is expected to be relative to an entry on sys.path |
| and all transitive dependencies of the file should also be resolvable |
| from an entry on sys.path.</p> |
| <p>To completely disable the machinery behind this function, set the |
| GRPC_PYTHON_DISABLE_DYNAMIC_STUBS environment variable to “true”.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>protobuf_path</strong> – The path to the .proto file on the filesystem. This path |
| must be resolvable from an entry on sys.path and so must all of its |
| transitive dependencies.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A module object corresponding to the stub/service code for the indicated |
| .proto file. Equivalent to a generated _pb2_grpc.py file.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="grpc.protos_and_services"> |
| <span class="sig-prename descclassname"><span class="pre">grpc.</span></span><span class="sig-name descname"><span class="pre">protos_and_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">protobuf_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/_runtime_protos.html#protos_and_services"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc.protos_and_services" title="Link to this definition">¶</a></dt> |
| <dd><p>Returns a 2-tuple of modules corresponding to protos and services.</p> |
| <p>THIS IS AN EXPERIMENTAL API.</p> |
| <p>The return value of this function is equivalent to a call to protos and a |
| call to services.</p> |
| <p>To completely disable the machinery behind this function, set the |
| GRPC_PYTHON_DISABLE_DYNAMIC_STUBS environment variable to “true”.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>protobuf_path</strong> – The path to the .proto file on the filesystem. This path |
| must be resolvable from an entry on sys.path and so must all of its |
| transitive dependencies.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A 2-tuple of module objects corresponding to (protos(path), services(path)).</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </section> |
| </section> |
| </section> |
| |
| |
| </div> |
| |
| </div> |
| </div> |
| <div class="clearer"></div> |
| </div> |
| <div class="footer"> |
| ©2025, The gRPC Authors. |
| |
| | |
| <a href="_sources/grpc.rst.txt" |
| rel="nofollow">Page source</a> |
| </div> |
| |
| |
| |
| |
| <script> |
| |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-60127042-1']); |
| _gaq.push(['_setDomainName', 'none']); |
| _gaq.push(['_setAllowLinker', true]); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'https://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| |
| </script> |
| |
| </body> |
| </html> |
