[libvirt] [dbus PATCH 02/10] GetVcpus API method: Renamed to GetVcpusFlags

[Daniel P. Berrangé]

On Fri, Mar 23, 2018 at 03:16:59PM +0100, Katerina Koukiou wrote:
> Same for internal virtDBusDomainGetVcpus:
> Renamed to virtDBusDomainGetVcpusFlags
> 
> Following naming from libvirt API.
> 
> Signed-off-by: Katerina Koukiou <kkoukiou at redhat.com>
> ---
>  data/org.libvirt.Domain.xml |  2 +-
>  src/domain.c                | 17 ++++++++---------
>  test/test_domain.py         |  2 +-
>  3 files changed, 10 insertions(+), 11 deletions(-)
> 
> diff --git a/data/org.libvirt.Domain.xml b/data/org.libvirt.Domain.xml
> index 1ecf826..46cc8a7 100644
> --- a/data/org.libvirt.Domain.xml
> +++ b/data/org.libvirt.Domain.xml
> @@ -11,7 +11,7 @@
>      <property name="Persistent" type="b" access="read"/>
>      <property name="State" type="s" access="read"/>
>      <property name="Autostart" type="b" access="read"/>
> -    <method name="GetVcpus">
> +    <method name="GetVcpusFlags">

We only added Flags as a suffix in our C apis because we have no other
way to fix it without breaking ABI compat.

In some language bindings, however, we didn't preserve that naming,
instead just adding 'flags' as an optional parameter.

DBus doesn't have optional params, but since this is a green-field API,
we don't have a backcompat problem to worry about.

IOW, I suggest *not* adding "Flags" as a suffix to any of the DBus
method names, even if you ultimately call a libvirt API named
with a "Flags" suffix.

>        <arg name="flags" type="u" direction="in"/>
>        <arg name="vcpus" type="u" direction="out"/>
>      </method>
> diff --git a/src/domain.c b/src/domain.c
> index 09b3440..333b5e8 100644
> --- a/src/domain.c
> +++ b/src/domain.c
> @@ -219,14 +219,13 @@ virtDBusDomainGetAutostart(const gchar *objectPath,
>  }
>  
>  static void
> -virtDBusDomainGetVcpus(GVariant *inArgs,
> -                       GUnixFDList *inFDs G_GNUC_UNUSED,
> -                       const gchar *objectPath,
> -                       gpointer userData,
> -                       GVariant **outArgs,
> -                       GUnixFDList **outFDs G_GNUC_UNUSED,
> -                       GError **error)
> -
> +virtDBusDomainGetVcpusFlags(GVariant *inArgs,
> +                            GUnixFDList *inFDs G_GNUC_UNUSED,
> +                            const gchar *objectPath,
> +                            gpointer userData,
> +                            GVariant **outArgs,
> +                            GUnixFDList **outFDs G_GNUC_UNUSED,
> +                            GError **error)
>  {
>      virtDBusConnect *connect = userData;
>      g_autoptr(virDomain) domain = NULL;
> @@ -451,7 +450,7 @@ static virtDBusGDBusPropertyTable virtDBusDomainPropertyTable[] = {
>  };
>  
>  static virtDBusGDBusMethodTable virtDBusDomainMethodTable[] = {
> -    { "GetVcpus", virtDBusDomainGetVcpus },
> +    { "GetVcpusFlags", virtDBusDomainGetVcpusFlags },
>      { "GetXMLDesc", virtDBusDomainGetXMLDesc },
>      { "GetStats", virtDBusDomainGetStats },
>      { "Shutdown", virtDBusDomainShutdown },
> diff --git a/test/test_domain.py b/test/test_domain.py
> index 22039dc..c7f9ca2 100755
> --- a/test/test_domain.py
> +++ b/test/test_domain.py
> @@ -28,7 +28,7 @@ class TestDomain(libvirttest.BaseTestClass):
>  
>          xml = domain.GetXMLDesc(0)
>          assert isinstance(xml, dbus.String)
> -        vcpus = domain.GetVcpus(0)
> +        vcpus = domain.GetVcpusFlags(0)
>          assert isinstance(vcpus, dbus.UInt32)
>  
>          domain.Reboot(0)
> -- 
> 2.15.0
> 
> --
> libvir-list mailing list
> libvir-list at redhat.com
> https://www.redhat.com/mailman/listinfo/libvir-list

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|