mirror of
https://github.com/php-win-ext/grpc.git
synced 2026-03-24 09:02:15 +01:00
40f20c0f48
### Description Fix https://github.com/grpc/grpc/issues/24470. Adding one example which demonstrate the following use cases: * Generate RPC ID on client side and propagate to server. * Context propagation from client to server. * Context propagation between different server interceptors and the server handler. ## Use: 1. Start server: `python3 -m async_greeter_server_with_interceptor` 2. Start client: `python3 -m async_greeter_client` ### Expected Logs: * On client side: ``` Sending request with rpc id: 73bb98beff10c2dd7b9f2252a1e2039e Greeter client received: Hello, you! ``` * On server side: ``` INFO:root:Starting server on [::]:50051 INFO:root:Interceptor1 called with rpc_id: default INFO:root:Interceptor2 called with rpc_id: Interceptor1-default INFO:root:Handle rpc with id Interceptor2-Interceptor1-73bb98beff10c2dd7b9f2252a1e2039e in server handler. ```
186 lines
3.6 KiB
ReStructuredText
186 lines
3.6 KiB
ReStructuredText
gRPC
|
|
=============
|
|
|
|
.. module:: grpc
|
|
|
|
For documentation, examples, and more, see the `Python gRPC <https://grpc.io/docs/languages/python/>`_ page on `grpc.io <https://grpc.io/>`_.
|
|
|
|
Module Contents
|
|
---------------
|
|
|
|
Version
|
|
^^^^^^^
|
|
|
|
The version string is available as :code:`grpc.__version__`.
|
|
|
|
Create Client
|
|
^^^^^^^^^^^^^
|
|
|
|
.. autofunction:: insecure_channel
|
|
.. autofunction:: secure_channel
|
|
.. autofunction:: intercept_channel
|
|
|
|
|
|
Create Client Credentials
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autofunction:: ssl_channel_credentials
|
|
.. autofunction:: metadata_call_credentials
|
|
.. autofunction:: access_token_call_credentials
|
|
.. autofunction:: composite_call_credentials
|
|
.. autofunction:: composite_channel_credentials
|
|
.. autofunction:: local_channel_credentials(local_connect_type=grpc.LocalConnectionType.LOCAL_TCP)
|
|
.. autofunction:: compute_engine_channel_credentials
|
|
|
|
|
|
Create Server
|
|
^^^^^^^^^^^^^
|
|
|
|
.. autofunction:: server
|
|
|
|
|
|
Create Server Credentials
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autofunction:: ssl_server_credentials
|
|
.. autofunction:: ssl_server_certificate_configuration
|
|
.. autofunction:: dynamic_ssl_server_credentials
|
|
.. autofunction:: local_server_credentials(local_connect_type=grpc.LocalConnectionType.LOCAL_TCP)
|
|
|
|
|
|
Local Connection Type
|
|
^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: LocalConnectionType
|
|
|
|
|
|
RPC Method Handlers
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autofunction:: unary_unary_rpc_method_handler
|
|
.. autofunction:: unary_stream_rpc_method_handler
|
|
.. autofunction:: stream_unary_rpc_method_handler
|
|
.. autofunction:: stream_stream_rpc_method_handler
|
|
.. autofunction:: method_handlers_generic_handler
|
|
|
|
|
|
Channel Ready Future
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autofunction:: channel_ready_future
|
|
|
|
|
|
Channel Connectivity
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: ChannelConnectivity
|
|
|
|
|
|
gRPC Status Code
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: StatusCode
|
|
|
|
|
|
Channel Object
|
|
^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: Channel
|
|
|
|
|
|
Server Object
|
|
^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: Server
|
|
|
|
|
|
Authentication & Authorization Objects
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: ChannelCredentials
|
|
.. autoclass:: CallCredentials
|
|
.. autoclass:: AuthMetadataContext
|
|
.. autoclass:: AuthMetadataPluginCallback
|
|
.. autoclass:: AuthMetadataPlugin
|
|
.. autoclass:: ServerCredentials
|
|
.. autoclass:: ServerCertificateConfiguration
|
|
|
|
|
|
gRPC Exceptions
|
|
^^^^^^^^^^^^^^^
|
|
|
|
.. autoexception:: RpcError
|
|
|
|
|
|
RPC Context
|
|
^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: RpcContext
|
|
|
|
|
|
Client-Side Context
|
|
^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: Call
|
|
|
|
|
|
Client-Side Interceptor
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: ClientCallDetails
|
|
.. autoclass:: UnaryUnaryClientInterceptor
|
|
.. autoclass:: UnaryStreamClientInterceptor
|
|
.. autoclass:: StreamUnaryClientInterceptor
|
|
.. autoclass:: StreamStreamClientInterceptor
|
|
|
|
|
|
Service-Side Context
|
|
^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: ServicerContext
|
|
|
|
|
|
Service-Side Handler
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: RpcMethodHandler
|
|
.. autoclass:: HandlerCallDetails
|
|
.. autoclass:: GenericRpcHandler
|
|
.. autoclass:: ServiceRpcHandler
|
|
|
|
|
|
Service-Side Interceptor
|
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: ServerInterceptor
|
|
|
|
|
|
Multi-Callable Interfaces
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: UnaryUnaryMultiCallable
|
|
.. autoclass:: UnaryStreamMultiCallable
|
|
.. autoclass:: StreamUnaryMultiCallable
|
|
.. autoclass:: StreamStreamMultiCallable
|
|
|
|
|
|
Future Interfaces
|
|
^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoexception:: FutureTimeoutError
|
|
.. autoexception:: FutureCancelledError
|
|
.. autoclass:: Future
|
|
|
|
|
|
Compression
|
|
^^^^^^^^^^^
|
|
|
|
.. autoclass:: Compression
|
|
|
|
Runtime Protobuf Parsing
|
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autofunction:: protos
|
|
.. autofunction:: services
|
|
.. autofunction:: protos_and_services
|