xref: /aosp_15_r20/external/pigweed/pw_rpc/py/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker.. _module-pw_rpc-py:
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard Worker-------------
4*61c4878aSAndroid Build Coastguard WorkerPython client
5*61c4878aSAndroid Build Coastguard Worker-------------
6*61c4878aSAndroid Build Coastguard Worker.. pigweed-module-subpage::
7*61c4878aSAndroid Build Coastguard Worker   :name: pw_rpc
8*61c4878aSAndroid Build Coastguard Worker
9*61c4878aSAndroid Build Coastguard WorkerThe ``pw_rpc`` Python package makes it possible to call Pigweed RPCs from
10*61c4878aSAndroid Build Coastguard WorkerPython. The package includes a ``pw_rpc`` client library, as well as tools for
11*61c4878aSAndroid Build Coastguard Workercreating a ``pw_rpc`` console.
12*61c4878aSAndroid Build Coastguard Worker
13*61c4878aSAndroid Build Coastguard Workerpw_rpc.client
14*61c4878aSAndroid Build Coastguard Worker=============
15*61c4878aSAndroid Build Coastguard Worker.. automodule:: pw_rpc.client
16*61c4878aSAndroid Build Coastguard Worker  :members: Client, ClientImpl
17*61c4878aSAndroid Build Coastguard Worker
18*61c4878aSAndroid Build Coastguard Workerpw_rpc.client_utils
19*61c4878aSAndroid Build Coastguard Worker===================
20*61c4878aSAndroid Build Coastguard Worker.. automodule:: pw_rpc.client_utils
21*61c4878aSAndroid Build Coastguard Worker  :members:
22*61c4878aSAndroid Build Coastguard Worker    NoEncodingSingleChannelRpcClient,
23*61c4878aSAndroid Build Coastguard Worker    RpcClient,
24*61c4878aSAndroid Build Coastguard Worker
25*61c4878aSAndroid Build Coastguard Workerpw_rpc.callback_client
26*61c4878aSAndroid Build Coastguard Worker======================
27*61c4878aSAndroid Build Coastguard Worker.. automodule:: pw_rpc.callback_client
28*61c4878aSAndroid Build Coastguard Worker  :members:
29*61c4878aSAndroid Build Coastguard Worker    UnaryResponse,
30*61c4878aSAndroid Build Coastguard Worker    StreamResponse,
31*61c4878aSAndroid Build Coastguard Worker    UnaryCall,
32*61c4878aSAndroid Build Coastguard Worker    ServerStreamingCall,
33*61c4878aSAndroid Build Coastguard Worker    ClientStreamingCall,
34*61c4878aSAndroid Build Coastguard Worker    BidirectionalStreamingCall,
35*61c4878aSAndroid Build Coastguard Worker
36*61c4878aSAndroid Build Coastguard Workerpw_rpc.descriptors
37*61c4878aSAndroid Build Coastguard Worker==================
38*61c4878aSAndroid Build Coastguard Worker.. automodule:: pw_rpc.descriptors
39*61c4878aSAndroid Build Coastguard Worker  :members:
40*61c4878aSAndroid Build Coastguard Worker    Channel,
41*61c4878aSAndroid Build Coastguard Worker    ChannelManipulator,
42*61c4878aSAndroid Build Coastguard Worker
43*61c4878aSAndroid Build Coastguard Workerpw_rpc.console_tools
44*61c4878aSAndroid Build Coastguard Worker====================
45*61c4878aSAndroid Build Coastguard Worker.. automodule:: pw_rpc.console_tools
46*61c4878aSAndroid Build Coastguard Worker  :members:
47*61c4878aSAndroid Build Coastguard Worker     ClientInfo,
48*61c4878aSAndroid Build Coastguard Worker     Context,
49*61c4878aSAndroid Build Coastguard Worker     Watchdog,
50*61c4878aSAndroid Build Coastguard Worker     alias_deprecated_command,
51*61c4878aSAndroid Build Coastguard Worker     flattened_rpc_completions,
52*61c4878aSAndroid Build Coastguard Worker     help_as_repr,
53