External/cloud-hypervisor
1
0
Fork 0
mirror of https://github.com/cloud-hypervisor/cloud-hypervisor.git synced 2024-10-01 11:05:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: api: document newly added event signal to the D-Bus API

Browse Source 
Signed-off-by: Omer Faruk Bayram <omer.faruk@sartura.hr>
This commit is contained in:
Omer Faruk Bayram 2023-08-13 20:43:02 +00:00 committed by Bo Chen
parent 2ed96cd3ed
commit cc5dd8c297
1 changed files with 25 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/api.md
View File

@ -206,11 +206,14 @@ curl --unix-socket /tmp/cloud-hypervisor.sock -i -X PUT 'http://localhost/api/v1
### D-Bus API ### D-Bus API
Cloud Hypervisor offers a D-Bus API as an alternative to its REST API. As of Cloud Hypervisor offers a D-Bus API as an alternative to its REST API. This
writing this document, the D-Bus API mirrors the functionality of the REST D-Bus API fully reflects the functionality of the REST API, exposing the
API and shares the same set of endpoints, meaning that it supports every call same group of endpoints. It can be a drop-in replacement since it also
that is supported by the REST API and can be a drop-in replacement since it consumes/produces JSON.
also consumes/produces JSON.
In addition, the D-Bus API also exposes events from `event-monitor` in the
form of a D-Bus signal to which users can subscribe. For more information,
see [D-Bus API Interface](#d-bus-api-interface).
#### D-Bus API Location and availability #### D-Bus API Location and availability
@ -245,8 +248,23 @@ which in turn can be used to control and manage Cloud Hypervisor.
#### D-Bus API Interface #### D-Bus API Interface
Please refer to the [REST API](#rest-api) documentation. As previously Please refer to the [REST API](#rest-api) documentation for everything that
mentioned, the D-Bus API currently mirrors the behaviour of the REST API. is in common with the REST API. As previously mentioned, the D-Bus API can
be used as a drop-in replacement for the [REST API](#rest-api).
The D-Bus interface also exposes a signal, named `Event`, which is emitted
whenever a new event is published from the `event-monitor` crate. Here is its
definition in XML format:
```xml
<node>
<interface name="org.cloudhypervisor.DBusApi1">
<signal name="Event">
<arg name="event" type="s"/>
</signal>
</interface>
</node>
```
### Command Line Interface ### Command Line Interface