xref: /aosp_15_r20/external/grpc-grpc/doc/python/sphinx/grpc.rst (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1*cc02d7e2SAndroid Build Coastguard WorkergRPC
2*cc02d7e2SAndroid Build Coastguard Worker=============
3*cc02d7e2SAndroid Build Coastguard Worker
4*cc02d7e2SAndroid Build Coastguard Worker.. module:: grpc
5*cc02d7e2SAndroid Build Coastguard Worker
6*cc02d7e2SAndroid Build Coastguard WorkerFor documentation, examples, and more, see the `Python gRPC <https://grpc.io/docs/languages/python/>`_ page on `grpc.io <https://grpc.io/>`_.
7*cc02d7e2SAndroid Build Coastguard Worker
8*cc02d7e2SAndroid Build Coastguard WorkerModule Contents
9*cc02d7e2SAndroid Build Coastguard Worker---------------
10*cc02d7e2SAndroid Build Coastguard Worker
11*cc02d7e2SAndroid Build Coastguard WorkerVersion
12*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^
13*cc02d7e2SAndroid Build Coastguard Worker
14*cc02d7e2SAndroid Build Coastguard WorkerThe version string is available as :code:`grpc.__version__`.
15*cc02d7e2SAndroid Build Coastguard Worker
16*cc02d7e2SAndroid Build Coastguard WorkerCreate Client
17*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^
18*cc02d7e2SAndroid Build Coastguard Worker
19*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: insecure_channel
20*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: secure_channel
21*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: intercept_channel
22*cc02d7e2SAndroid Build Coastguard Worker
23*cc02d7e2SAndroid Build Coastguard Worker
24*cc02d7e2SAndroid Build Coastguard WorkerCreate Client Credentials
25*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^^^
26*cc02d7e2SAndroid Build Coastguard Worker
27*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: ssl_channel_credentials
28*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: metadata_call_credentials
29*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: access_token_call_credentials
30*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: composite_call_credentials
31*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: composite_channel_credentials
32*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: local_channel_credentials(local_connect_type=grpc.LocalConnectionType.LOCAL_TCP)
33*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: compute_engine_channel_credentials
34*cc02d7e2SAndroid Build Coastguard Worker
35*cc02d7e2SAndroid Build Coastguard Worker
36*cc02d7e2SAndroid Build Coastguard WorkerCreate Server
37*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^
38*cc02d7e2SAndroid Build Coastguard Worker
39*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: server
40*cc02d7e2SAndroid Build Coastguard Worker
41*cc02d7e2SAndroid Build Coastguard Worker
42*cc02d7e2SAndroid Build Coastguard WorkerCreate Server Credentials
43*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^^^
44*cc02d7e2SAndroid Build Coastguard Worker
45*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: ssl_server_credentials
46*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: ssl_server_certificate_configuration
47*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: dynamic_ssl_server_credentials
48*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: local_server_credentials(local_connect_type=grpc.LocalConnectionType.LOCAL_TCP)
49*cc02d7e2SAndroid Build Coastguard Worker
50*cc02d7e2SAndroid Build Coastguard Worker
51*cc02d7e2SAndroid Build Coastguard WorkerLocal Connection Type
52*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^
53*cc02d7e2SAndroid Build Coastguard Worker
54*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: LocalConnectionType
55*cc02d7e2SAndroid Build Coastguard Worker
56*cc02d7e2SAndroid Build Coastguard Worker
57*cc02d7e2SAndroid Build Coastguard WorkerRPC Method Handlers
58*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^^^^
59*cc02d7e2SAndroid Build Coastguard Worker
60*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: unary_unary_rpc_method_handler
61*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: unary_stream_rpc_method_handler
62*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: stream_unary_rpc_method_handler
63*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: stream_stream_rpc_method_handler
64*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: method_handlers_generic_handler
65*cc02d7e2SAndroid Build Coastguard Worker
66*cc02d7e2SAndroid Build Coastguard Worker
67*cc02d7e2SAndroid Build Coastguard WorkerChannel Ready Future
68*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^^^^
69*cc02d7e2SAndroid Build Coastguard Worker
70*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: channel_ready_future
71*cc02d7e2SAndroid Build Coastguard Worker
72*cc02d7e2SAndroid Build Coastguard Worker
73*cc02d7e2SAndroid Build Coastguard WorkerChannel Connectivity
74*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^^^^
75*cc02d7e2SAndroid Build Coastguard Worker
76*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: ChannelConnectivity
77*cc02d7e2SAndroid Build Coastguard Worker
78*cc02d7e2SAndroid Build Coastguard Worker
79*cc02d7e2SAndroid Build Coastguard WorkergRPC Status Code
80*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^^^^
81*cc02d7e2SAndroid Build Coastguard Worker
82*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: StatusCode
83*cc02d7e2SAndroid Build Coastguard Worker
84*cc02d7e2SAndroid Build Coastguard Worker
85*cc02d7e2SAndroid Build Coastguard WorkerChannel Object
86*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^
87*cc02d7e2SAndroid Build Coastguard Worker
88*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: Channel
89*cc02d7e2SAndroid Build Coastguard Worker
90*cc02d7e2SAndroid Build Coastguard Worker
91*cc02d7e2SAndroid Build Coastguard WorkerServer Object
92*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^
93*cc02d7e2SAndroid Build Coastguard Worker
94*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: Server
95*cc02d7e2SAndroid Build Coastguard Worker
96*cc02d7e2SAndroid Build Coastguard Worker
97*cc02d7e2SAndroid Build Coastguard WorkerAuthentication & Authorization Objects
98*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
99*cc02d7e2SAndroid Build Coastguard Worker
100*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: ChannelCredentials
101*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: CallCredentials
102*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: AuthMetadataContext
103*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: AuthMetadataPluginCallback
104*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: AuthMetadataPlugin
105*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: ServerCredentials
106*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: ServerCertificateConfiguration
107*cc02d7e2SAndroid Build Coastguard Worker
108*cc02d7e2SAndroid Build Coastguard Worker
109*cc02d7e2SAndroid Build Coastguard WorkergRPC Exceptions
110*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^
111*cc02d7e2SAndroid Build Coastguard Worker
112*cc02d7e2SAndroid Build Coastguard Worker.. autoexception:: RpcError
113*cc02d7e2SAndroid Build Coastguard Worker
114*cc02d7e2SAndroid Build Coastguard Worker
115*cc02d7e2SAndroid Build Coastguard WorkerRPC Context
116*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^
117*cc02d7e2SAndroid Build Coastguard Worker
118*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: RpcContext
119*cc02d7e2SAndroid Build Coastguard Worker
120*cc02d7e2SAndroid Build Coastguard Worker
121*cc02d7e2SAndroid Build Coastguard WorkerClient-Side Context
122*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^
123*cc02d7e2SAndroid Build Coastguard Worker
124*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: Call
125*cc02d7e2SAndroid Build Coastguard Worker
126*cc02d7e2SAndroid Build Coastguard Worker
127*cc02d7e2SAndroid Build Coastguard WorkerClient-Side Interceptor
128*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
129*cc02d7e2SAndroid Build Coastguard Worker
130*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: ClientCallDetails
131*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: UnaryUnaryClientInterceptor
132*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: UnaryStreamClientInterceptor
133*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: StreamUnaryClientInterceptor
134*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: StreamStreamClientInterceptor
135*cc02d7e2SAndroid Build Coastguard Worker
136*cc02d7e2SAndroid Build Coastguard Worker
137*cc02d7e2SAndroid Build Coastguard WorkerService-Side Context
138*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^
139*cc02d7e2SAndroid Build Coastguard Worker
140*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: ServicerContext
141*cc02d7e2SAndroid Build Coastguard Worker
142*cc02d7e2SAndroid Build Coastguard Worker
143*cc02d7e2SAndroid Build Coastguard WorkerService-Side Handler
144*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
145*cc02d7e2SAndroid Build Coastguard Worker
146*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: RpcMethodHandler
147*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: HandlerCallDetails
148*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: GenericRpcHandler
149*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: ServiceRpcHandler
150*cc02d7e2SAndroid Build Coastguard Worker
151*cc02d7e2SAndroid Build Coastguard Worker
152*cc02d7e2SAndroid Build Coastguard WorkerService-Side Interceptor
153*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^^
154*cc02d7e2SAndroid Build Coastguard Worker
155*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: ServerInterceptor
156*cc02d7e2SAndroid Build Coastguard Worker
157*cc02d7e2SAndroid Build Coastguard Worker
158*cc02d7e2SAndroid Build Coastguard WorkerMulti-Callable Interfaces
159*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^^^
160*cc02d7e2SAndroid Build Coastguard Worker
161*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: UnaryUnaryMultiCallable
162*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: UnaryStreamMultiCallable
163*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: StreamUnaryMultiCallable
164*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: StreamStreamMultiCallable
165*cc02d7e2SAndroid Build Coastguard Worker
166*cc02d7e2SAndroid Build Coastguard Worker
167*cc02d7e2SAndroid Build Coastguard WorkerFuture Interfaces
168*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^
169*cc02d7e2SAndroid Build Coastguard Worker
170*cc02d7e2SAndroid Build Coastguard Worker.. autoexception:: FutureTimeoutError
171*cc02d7e2SAndroid Build Coastguard Worker.. autoexception:: FutureCancelledError
172*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: Future
173*cc02d7e2SAndroid Build Coastguard Worker
174*cc02d7e2SAndroid Build Coastguard Worker
175*cc02d7e2SAndroid Build Coastguard WorkerCompression
176*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^
177*cc02d7e2SAndroid Build Coastguard Worker
178*cc02d7e2SAndroid Build Coastguard Worker.. autoclass:: Compression
179*cc02d7e2SAndroid Build Coastguard Worker
180*cc02d7e2SAndroid Build Coastguard WorkerRuntime Protobuf Parsing
181*cc02d7e2SAndroid Build Coastguard Worker^^^^^^^^^^^^^^^^^^^^^^^^
182*cc02d7e2SAndroid Build Coastguard Worker
183*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: protos
184*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: services
185*cc02d7e2SAndroid Build Coastguard Worker.. autofunction:: protos_and_services
186