xref: /aosp_15_r20/external/parameter-framework/upstream/remote-process/README.md (revision c33452fb792a5495ec310a9626f2638b053af5dd)
1*c33452fbSAndroid Build Coastguard Worker# remote-process
2*c33452fbSAndroid Build Coastguard Worker
3*c33452fbSAndroid Build Coastguard Worker`remote-process` is an executable used to communicate with an instance of the
4*c33452fbSAndroid Build Coastguard Workerparameter-framework through a TCP socket.  It is only possible if the
5*c33452fbSAndroid Build Coastguard Workerparameter-framework's configuration allows it (`TuningAllowed="true"` in the
6*c33452fbSAndroid Build Coastguard WorkerParameterFrameworkConfiguration.xml) and if the port is also defined in the
7*c33452fbSAndroid Build Coastguard Workerconfiguration (by the `ServerPort` attribute):
8*c33452fbSAndroid Build Coastguard Worker
9*c33452fbSAndroid Build Coastguard WorkerFor instance, if your parameter-framework configuration starts with:
10*c33452fbSAndroid Build Coastguard Worker
11*c33452fbSAndroid Build Coastguard Worker    <ParameterFrameworkConfiguration SystemClassName="..." ServerPort="5000" TuningAllowed="true">
12*c33452fbSAndroid Build Coastguard Worker
13*c33452fbSAndroid Build Coastguard Workerthen, it listens on port 5000.
14*c33452fbSAndroid Build Coastguard Worker
15*c33452fbSAndroid Build Coastguard Workerremote-process may also be used to communicate with test-platform
16*c33452fbSAndroid Build Coastguard Worker(see test/test-platform/README.md) thanks to test-platform being a minimal
17*c33452fbSAndroid Build Coastguard Workerparameter-framework client.
18*c33452fbSAndroid Build Coastguard Worker
19*c33452fbSAndroid Build Coastguard Worker## Syntax
20*c33452fbSAndroid Build Coastguard Worker
21*c33452fbSAndroid Build Coastguard Worker    remote-process <hostname port|tcp://[host]:port|unix://path> <command>
22*c33452fbSAndroid Build Coastguard Worker
23*c33452fbSAndroid Build Coastguard WorkerYou can get all available commands with the `help` command.
24