/usr/include/giomm-2.4/giomm/dbusproxy.h is in libglibmm-2.4-dev 2.42.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_DBUSPROXY_H
#define _GIOMM_DBUSPROXY_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* Copyright (C) 2010 The giomm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmm/object.h>
#include <giomm/asyncresult.h>
#include <giomm/dbusintrospection.h>
#include <giomm/initable.h>
#include <giomm/asyncinitable.h>
#include <giomm/dbusconnection.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GDBusProxy GDBusProxy;
typedef struct _GDBusProxyClass GDBusProxyClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
namespace DBus
{ class Proxy_Class; } // namespace DBus
} // namespace Gio
namespace Gio
{
namespace DBus
{
//The GMMPROC_EXTRA_NAMESPACE() macro is a hint to generate_wrap_init.pl to put it in the DBus sub-namespace
/** @addtogroup giommEnums giomm Enums and Flags */
/**
* @var ProxyFlags PROXY_FLAGS_NONE
* No flags set.
*
* @var ProxyFlags PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES
* Don't load properties.
*
* @var ProxyFlags PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS
* Don't connect to signals on the remote object.
*
* @var ProxyFlags PROXY_FLAGS_DO_NOT_AUTO_START
* If not set and the proxy if for a well-known name, then request the bus to launch an owner for the name if no-one owns the name. This flag can only be used in proxies for well-known names.
*
* @var ProxyFlags PROXY_FLAGS_GET_INVALIDATED_PROPERTIES
* If set, the property value for any <em>invalidated property</em> will be (asynchronously) retrieved upon receiving the PropertiesChanged D-Bus signal and the property will not cause emission of the DBusProxy::signal_g_properties_changed() signal. When the value is received the DBusProxy::signal_g_properties_changed() signal is emitted for the property along with the retrieved value. Since 2.32.
*
* @var ProxyFlags PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION
* If the proxy is for a well-known name, do not ask the bus to launch an owner during proxy initialization, but allow it to be autostarted by a method call. This flag is only meaningful in proxies for well-known names, and only if DBUS_PROXY_FLAGS_DO_NOT_AUTOSTART is not also specified.
*
* @enum ProxyFlags
*
* Flags used when constructing an instance of a DBusProxy derived class.
*
* @newin{2,26}
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%ProxyFlags operator|(ProxyFlags, ProxyFlags)</tt><br>
* <tt>%ProxyFlags operator&(ProxyFlags, ProxyFlags)</tt><br>
* <tt>%ProxyFlags operator^(ProxyFlags, ProxyFlags)</tt><br>
* <tt>%ProxyFlags operator~(ProxyFlags)</tt><br>
* <tt>%ProxyFlags& operator|=(ProxyFlags&, ProxyFlags)</tt><br>
* <tt>%ProxyFlags& operator&=(ProxyFlags&, ProxyFlags)</tt><br>
* <tt>%ProxyFlags& operator^=(ProxyFlags&, ProxyFlags)</tt><br>
*/
enum ProxyFlags
{
PROXY_FLAGS_NONE = 0x0,
PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES = (1<<0),
PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS = (1<<1),
PROXY_FLAGS_DO_NOT_AUTO_START = (1<<2),
PROXY_FLAGS_GET_INVALIDATED_PROPERTIES = (1<<3),
PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION = (1<<4)
};
/** @ingroup giommEnums */
inline ProxyFlags operator|(ProxyFlags lhs, ProxyFlags rhs)
{ return static_cast<ProxyFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline ProxyFlags operator&(ProxyFlags lhs, ProxyFlags rhs)
{ return static_cast<ProxyFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline ProxyFlags operator^(ProxyFlags lhs, ProxyFlags rhs)
{ return static_cast<ProxyFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline ProxyFlags operator~(ProxyFlags flags)
{ return static_cast<ProxyFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline ProxyFlags& operator|=(ProxyFlags& lhs, ProxyFlags rhs)
{ return (lhs = static_cast<ProxyFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline ProxyFlags& operator&=(ProxyFlags& lhs, ProxyFlags rhs)
{ return (lhs = static_cast<ProxyFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline ProxyFlags& operator^=(ProxyFlags& lhs, ProxyFlags rhs)
{ return (lhs = static_cast<ProxyFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
/** A client-side proxy.
* This is a base class used for proxies to access a D-Bus interface on
* a remote object. It can be constructed for both well-known and
* unique names.
*
* By default, Proxy will cache all properties (and listen to changes) of
* the remote object, and proxy all signals that gets emitted. This behaviour
* can be changed by passing suitable ProxyFlags when the proxy is
* created. If the proxy is for a well-known name, the property cache is
* flushed when the name owner vanishes and reloaded when a name owner
* appears.
*
* If a Proxy is used for a well-known name, the owner of the name is
* tracked and can be read from property_g_name_owner().
*
* The generic signal_g_properties_changed() and signal_g_signal() signals are
* not very convenient to work with. Therefore, the recommended way of working
* with proxies is to subclass Proxy, and have more natural properties and
* signals in your derived class.
*
* This documentation was adapted from the C API documentation. The C API docs
* has more information and an example.
*
* @newin{2,28}
* @ingroup DBus
*/
class Proxy
: public Glib::Object,
public Initable,
public AsyncInitable
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef Proxy CppObjectType;
typedef Proxy_Class CppClassType;
typedef GDBusProxy BaseObjectType;
typedef GDBusProxyClass BaseClassType;
private: friend class Proxy_Class;
static CppClassType proxy_class_;
private:
// noncopyable
Proxy(const Proxy&);
Proxy& operator=(const Proxy&);
protected:
explicit Proxy(const Glib::ConstructParams& construct_params);
explicit Proxy(GDBusProxy* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~Proxy();
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GDBusProxy* gobj() { return reinterpret_cast<GDBusProxy*>(gobject_); }
///Provides access to the underlying C GObject.
const GDBusProxy* gobj() const { return reinterpret_cast<GDBusProxy*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GDBusProxy* gobj_copy();
private:
protected:
Proxy(const Glib::RefPtr<Connection>& connection,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const SlotAsyncReady& slot,
const Glib::RefPtr<Cancellable>& cancellable,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
Proxy(const Glib::RefPtr<Connection>& connection,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const SlotAsyncReady& slot,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
Proxy(const Glib::RefPtr<Connection>& connection,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const Glib::RefPtr<Cancellable>& cancellable,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
Proxy(const Glib::RefPtr<Connection>& connection,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
Proxy(BusType bus_type,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const SlotAsyncReady& slot,
const Glib::RefPtr<Cancellable>& cancellable,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
Proxy(BusType bus_type,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const SlotAsyncReady& slot,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
Proxy(BusType bus_type,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const Glib::RefPtr<Cancellable>& cancellable,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
Proxy(BusType bus_type,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
public:
/** Creates a proxy for accessing @a interface_name on the remote object
* at @a object_path owned by @a name at @a connection and asynchronously
* loads D-Bus properties unless the
* DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. Connect to
* the DBusProxy::signal_g_properties_changed() signal to get notified about
* property changes.
*
* If the DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
* match rules for signals. Connect to the DBusProxy::signal_g_signal() signal
* to handle signals from the remote object.
*
* If @a name is a well-known name and the
* DBUS_PROXY_FLAGS_DO_NOT_AUTO_START and DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION
* flags aren't set and no name owner currently exists, the message bus
* will be requested to launch a name owner for the name.
*
* This is a failable asynchronous constructor - when the proxy is
* ready, @a slot will be invoked and you can use
* g_dbus_proxy_new_finish() to get the result.
*
* See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
*
* DBusProxy is used in this [example][gdbus-wellknown-proxy].
*
* @newin{2,26}
*
* @param connection A DBusConnection.
* @param flags Flags used when constructing the proxy.
* @param info A DBusInterfaceInfo specifying the minimal interface that @a proxy conforms to or <tt>0</tt>.
* @param name A bus name (well-known or unique) or <tt>0</tt> if @a connection is not a message bus connection.
* @param object_path An object path.
* @param interface_name A D-Bus interface name.
* @param cancellable A Cancellable or <tt>0</tt>.
* @param slot Callback function to invoke when the proxy is ready.
* @param user_data User data to pass to @a callback.
*/
static void create(const Glib::RefPtr<Connection>& connection,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const SlotAsyncReady& slot,
const Glib::RefPtr<Cancellable>& cancellable,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
/// Non-cancellable version of create().
static void create(const Glib::RefPtr<Connection>& connection,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const SlotAsyncReady& slot,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
/** Finishes creating a DBusProxy.
*
* @newin{2,26}
*
* @param res A AsyncResult obtained from the SlotAsyncReady function passed to g_dbus_proxy_new().
* @return A DBusProxy or <tt>0</tt> if @a error is set. Free with Glib::object_unref().
*/
/** @throw Glib::Error.
*/
static Glib::RefPtr<Proxy> create_finish(const Glib::RefPtr<AsyncResult>& res);
/** Creates a proxy for accessing @a interface_name on the remote object
* at @a object_path owned by @a name at @a connection and synchronously
* loads D-Bus properties unless the
* DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used.
*
* If the DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
* match rules for signals. Connect to the DBusProxy::signal_g_signal() signal
* to handle signals from the remote object.
*
* If @a name is a well-known name and the
* DBUS_PROXY_FLAGS_DO_NOT_AUTO_START and DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION
* flags aren't set and no name owner currently exists, the message bus
* will be requested to launch a name owner for the name.
*
* This is a synchronous failable constructor. See g_dbus_proxy_new()
* and g_dbus_proxy_new_finish() for the asynchronous version.
*
* DBusProxy is used in this [example][gdbus-wellknown-proxy].
*
* @newin{2,26}
*
* @param connection A DBusConnection.
* @param flags Flags used when constructing the proxy.
* @param info A DBusInterfaceInfo specifying the minimal interface that @a proxy conforms to or <tt>0</tt>.
* @param name A bus name (well-known or unique) or <tt>0</tt> if @a connection is not a message bus connection.
* @param object_path An object path.
* @param interface_name A D-Bus interface name.
* @param cancellable A Cancellable or <tt>0</tt>.
* @return A DBusProxy or <tt>0</tt> if error is set. Free with Glib::object_unref().
*/
static Glib::RefPtr<Proxy>
create_sync(const Glib::RefPtr<Connection>& connection,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const Glib::RefPtr<Cancellable>& cancellable,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
/// Non-cancellable version of create_sync().
static Glib::RefPtr<Proxy>
create_sync(const Glib::RefPtr<Connection>& connection,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
/** Like g_dbus_proxy_new() but takes a BusType instead of a DBusConnection.
*
* DBusProxy is used in this [example][gdbus-wellknown-proxy].
*
* @newin{2,26}
*
* @param bus_type A BusType.
* @param flags Flags used when constructing the proxy.
* @param info A DBusInterfaceInfo specifying the minimal interface that @a proxy conforms to or <tt>0</tt>.
* @param name A bus name (well-known or unique).
* @param object_path An object path.
* @param interface_name A D-Bus interface name.
* @param cancellable A Cancellable or <tt>0</tt>.
* @param slot Callback function to invoke when the proxy is ready.
* @param user_data User data to pass to @a callback.
*/
static void create_for_bus(BusType bus_type,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const SlotAsyncReady& slot,
const Glib::RefPtr<Cancellable>& cancellable,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
/// Non-cancellable version of create_for_bus().
static void create_for_bus(BusType bus_type,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const SlotAsyncReady& slot,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
/** Finishes creating a DBusProxy.
*
* @newin{2,26}
*
* @param res A AsyncResult obtained from the SlotAsyncReady function passed to g_dbus_proxy_new_for_bus().
* @return A DBusProxy or <tt>0</tt> if @a error is set. Free with Glib::object_unref().
*/
/** @throw Glib::Error.
*/
static Glib::RefPtr<Proxy> create_for_bus_finish(const Glib::RefPtr<AsyncResult>& res);
/** Like g_dbus_proxy_new_sync() but takes a BusType instead of a DBusConnection.
*
* DBusProxy is used in this [example][gdbus-wellknown-proxy].
*
* @newin{2,26}
*
* @param bus_type A BusType.
* @param flags Flags used when constructing the proxy.
* @param info A DBusInterfaceInfo specifying the minimal interface
* that @a proxy conforms to or <tt>0</tt>.
* @param name A bus name (well-known or unique).
* @param object_path An object path.
* @param interface_name A D-Bus interface name.
* @param cancellable A Cancellable or <tt>0</tt>.
* @return A DBusProxy or <tt>0</tt> if error is set. Free with Glib::object_unref().
*/
static Glib::RefPtr<Proxy>
create_for_bus_sync(BusType bus_type,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const Glib::RefPtr<Cancellable>& cancellable,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
/// Non-cancellable version of create_for_bus_sync().
static Glib::RefPtr<Proxy>
create_for_bus_sync(BusType bus_type,
const Glib::ustring& name,
const Glib::ustring& object_path,
const Glib::ustring& interface_name,
const Glib::RefPtr<InterfaceInfo>& info = Glib::RefPtr<InterfaceInfo>(),
ProxyFlags flags = PROXY_FLAGS_NONE);
/** Gets the flags that @a proxy was constructed with.
*
* @newin{2,26}
*
* @return Flags from the DBusProxyFlags enumeration.
*/
ProxyFlags get_flags() const;
/** Gets the connection @a proxy is for.
*
* @newin{2,26}
*
* @return A DBusConnection owned by @a proxy. Do not free.
*/
Glib::RefPtr<Connection> get_connection();
/** Gets the connection @a proxy is for.
*
* @newin{2,26}
*
* @return A DBusConnection owned by @a proxy. Do not free.
*/
Glib::RefPtr<const Connection> get_connection() const;
/** Gets the name that @a proxy was constructed for.
*
* @newin{2,26}
*
* @return A string owned by @a proxy. Do not free.
*/
Glib::ustring get_name() const;
/** The unique name that owns the name that @a proxy is for or <tt>0</tt> if
* no-one currently owns that name. You may connect to the
* Object::signal_notify() signal to track changes to the
* DBusProxy::property_g_name_owner() property.
*
* @newin{2,26}
*
* @return The name owner or <tt>0</tt> if no name owner exists. Free with Glib::free().
*/
Glib::ustring get_name_owner() const;
/** Gets the object path @a proxy is for.
*
* @newin{2,26}
*
* @return A string owned by @a proxy. Do not free.
*/
Glib::ustring get_object_path() const;
/** Gets the D-Bus interface name @a proxy is for.
*
* @newin{2,26}
*
* @return A string owned by @a proxy. Do not free.
*/
Glib::ustring get_interface_name() const;
/** Gets the timeout to use if -1 (specifying default timeout) is
* passed as @a timeout_msec in the g_dbus_proxy_call() and
* g_dbus_proxy_call_sync() functions.
*
* See the DBusProxy::property_g_default_timeout() property for more details.
*
* @newin{2,26}
*
* @return Timeout to use for @a proxy.
*/
int get_default_timeout() const;
/** Sets the timeout to use if -1 (specifying default timeout) is
* passed as @a timeout_msec in the g_dbus_proxy_call() and
* g_dbus_proxy_call_sync() functions.
*
* See the DBusProxy::property_g_default_timeout() property for more details.
*
* @newin{2,26}
*
* @param timeout_msec Timeout in milliseconds.
*/
void set_default_timeout(int timeout_msec = -1);
/** Looks up the value for a property from the cache. This call does no
* blocking IO.
*
* If proxy has an expected interface (see property_g_interface_info()),
* then @a property_name (for existence) is checked against it.
*
* @param property An output parameter in which to hold to the variant
* instance that holds the value for @a property_name.
* @param property_name Property name.
*
* @newin{2,28}
*/
void get_cached_property(Glib::VariantBase& property,
const Glib::ustring& property_name) const;
/** If @a value is not <tt>0</tt>, sets the cached value for the property with
* name @a property_name to the value in @a value.
*
* If @a value is <tt>0</tt>, then the cached value is removed from the
* property cache.
*
* If @a proxy has an expected interface (see
* DBusProxy::property_g_interface_info()) and @a property_name is referenced by
* it, then @a value is checked against the type of the property.
*
* If the @a value Variant is floating, it is consumed. This allows
* convenient 'inline' use of Glib::variant_new(), e.g.
*
* [C example ellipted]
*
* Normally you will not need to use this method since @a proxy
* is tracking changes using the
* `org.freedesktop.DBus.Properties.PropertiesChanged`
* D-Bus signal. However, for performance reasons an object may
* decide to not use this signal for some properties and instead
* use a proprietary out-of-band mechanism to transmit changes.
*
* As a concrete example, consider an object with a property
* `ChatroomParticipants` which is an array of strings. Instead of
* transmitting the same (long) array every time the property changes,
* it is more efficient to only transmit the delta using e.g. signals
* `ChatroomParticipantJoined(String name)` and
* `ChatroomParticipantParted(String name)`.
*
* @newin{2,26}
*
* @param property_name Property name.
* @param value Value for the property or <tt>0</tt> to remove it from the cache.
*/
void set_cached_property(const Glib::ustring& property_name, const Glib::VariantBase& value);
/** Gets the names of all cached properties on @a proxy.
*
* @newin{2,26}
*
* @return A <tt>0</tt>-terminated array of strings or <tt>0</tt> if
* @a proxy has no cached properties. Free the returned array with
* Glib::strfreev().
*/
Glib::StringArrayHandle get_cached_property_names() const;
/** Ensure that interactions with @a proxy conform to the given
* interface. See the DBusProxy::property_g_interface_info() property for more
* details.
*
* @newin{2,26}
*
* @param info Minimum interface this proxy conforms to or <tt>0</tt> to unset.
*/
void set_interface_info(const Glib::RefPtr<InterfaceInfo>& info);
/** Returns the DBusInterfaceInfo, if any, specifying the interface
* that @a proxy conforms to. See the DBusProxy::property_g_interface_info()
* property for more details.
*
* @newin{2,26}
*
* @return A DBusInterfaceInfo or <tt>0</tt>. Do not unref the returned
* object, it is owned by @a proxy.
*/
Glib::RefPtr<InterfaceInfo> get_interface_info();
/** Returns the DBusInterfaceInfo, if any, specifying the interface
* that @a proxy conforms to. See the DBusProxy::property_g_interface_info()
* property for more details.
*
* @newin{2,26}
*
* @return A DBusInterfaceInfo or <tt>0</tt>. Do not unref the returned
* object, it is owned by @a proxy.
*/
Glib::RefPtr<const InterfaceInfo> get_interface_info() const;
/** Asynchronously invokes the @a method_name method on @a proxy.
*
* If @a method_name contains any dots, then @a name is split into interface and
* method name parts. This allows using @a proxy for invoking methods on
* other interfaces.
*
* If the DBusConnection associated with @a proxy is closed then
* the operation will fail with IO_ERROR_CLOSED. If
* @a cancellable is canceled, the operation will fail with
* IO_ERROR_CANCELLED. If @a parameters contains a value not
* compatible with the D-Bus protocol, the operation fails with
* IO_ERROR_INVALID_ARGUMENT.
*
* If the @a parameters Variant is floating, it is consumed. This allows
* convenient 'inline' use of Glib::variant_new(), e.g.:
*
* [C example ellipted]
*
* If @a proxy has an expected interface (see
* DBusProxy::property_g_interface_info()) and @a method_name is referenced by it,
* then the return value is checked against the return type.
*
* This is an asynchronous method. When the operation is finished,
* @a slot will be invoked in the
* [thread-default main context][g-main-context-push-thread-default]
* of the thread you are calling this method from.
* You can then call g_dbus_proxy_call_finish() to get the result of
* the operation. See g_dbus_proxy_call_sync() for the synchronous
* version of this method.
*
* If @a slot is <tt>0</tt> then the D-Bus method call message will be sent with
* the DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.
*
* @newin{2,26}
*
* @param method_name Name of method to invoke.
* @param parameters A Variant tuple with parameters for the signal or <tt>0</tt> if not passing parameters.
* @param flags Flags from the DBusCallFlags enumeration.
* @param timeout_msec The timeout in milliseconds (with MAXINT meaning
* "infinite") or -1 to use the proxy default timeout.
* @param cancellable A Cancellable or <tt>0</tt>.
* @param slot A SlotAsyncReady to call when the request is satisfied or <tt>0</tt> if you don't
* care about the result of the method invocation.
* @param user_data The data to pass to @a callback.
*/
void call(
const Glib::ustring& method_name,
const SlotAsyncReady& slot,
const Glib::RefPtr<Cancellable>& cancellable,
const Glib::VariantContainerBase& parameters = Glib::VariantContainerBase(),
int timeout_msec = -1,
CallFlags flags = Gio::DBus::CALL_FLAGS_NONE
);
/// A non-cancellable version of call().
void call(
const Glib::ustring& method_name,
const SlotAsyncReady& slot,
const Glib::VariantContainerBase& parameters = Glib::VariantContainerBase(),
int timeout_msec = -1,
CallFlags flags = Gio::DBus::CALL_FLAGS_NONE
);
/** Finishes an operation started with call().
*
* @param res An AsyncResult obtained from the SlotAsyncReady passed to
* call().
* @result A Variant tuple with return values.
*
* @throw Glib::Error.
*/
Glib::VariantContainerBase call_finish(const Glib::RefPtr<AsyncResult>& res);
//TODO: Use _WRAP_METHOD() for this?
/** Synchronously invokes the method_name method on proxy.
* See call(), the asynchronous version of this method for more information.
*
* @param method_name Name of method to invoke.
* @param timeout_msec The timeout in milliseconds or -1 to use the proxy
* default timeout.
* @param flags Flags from the CallFlags enumeration.
* @param parameters A Glib::VariantContainerBase tuple with parameters for the
* signal.
* @param cancellable A Cancellable.
* @result A Variant tuple with return values.
*
* @throw Glib::Error.
*/
Glib::VariantContainerBase call_sync(
const Glib::ustring& method_name,
const Glib::RefPtr<Cancellable>& cancellable,
const Glib::VariantContainerBase& parameters = Glib::VariantContainerBase(),
int timeout_msec = -1,
CallFlags flags = Gio::DBus::CALL_FLAGS_NONE
);
/// A non-cancellable version of call_sync().
Glib::VariantContainerBase call_sync(
const Glib::ustring& method_name,
const Glib::VariantContainerBase& parameters = Glib::VariantContainerBase(),
int timeout_msec = -1,
CallFlags flags = Gio::DBus::CALL_FLAGS_NONE
);
#ifdef G_OS_UNIX
//TODO: Use _WRAP_METHOD() for this?
/** Like call() but also takes a GUnixFDList object.
* This method is only available on UNIX.
*
* This is an asynchronous method. When the operation is finished, callback
* will be invoked in the thread-default main loop of the thread you are
* calling this method from. You can then call call_with_unix_fd_finish() to
* get the result of the operation. See call_sync() for the synchronous
* version of this function.
*
* @param method_name The name of the method to invoke.
* @param parameters A Glib::VariantContainerBase tuple with parameters for the
* method or <tt>0</tt> if not passing parameters.
* @param slot A SlotAsyncReady to call when the request is satisfied.
* @param cancellable A Cancellable.
* @param fd_list A UnixFDList.
* @param timeout_msec The timeout in milliseconds, -1 to use the default
* timeout or G_MAXINT for no timeout.
* @param flags Flags from the Gio::DBus::CallFlags enumeration.
* @newin{2,34}
*/
void call(
const Glib::ustring& method_name,
const Glib::VariantContainerBase& parameters,
const SlotAsyncReady& slot,
const Glib::RefPtr<Cancellable>& cancellable,
const Glib::RefPtr<UnixFDList>& fd_list,
int timeout_msec = -1,
CallFlags flags = Gio::DBus::CALL_FLAGS_NONE);
/** A non-cancellable version of call() (with a UnixFDList).
* @newin{2,34}
*/
void call(
const Glib::ustring& method_name,
const Glib::VariantContainerBase& parameters,
const SlotAsyncReady& slot,
const Glib::RefPtr<UnixFDList>& fd_list,
int timeout_msec = -1,
CallFlags flags = Gio::DBus::CALL_FLAGS_NONE);
#ifdef G_OS_UNIX
/** Finishes an operation started with call() (with a UnixFDList).
* @param res A AsyncResult obtained from the SlotAsyncReady passed to
* call().
* @param out_fd_list Return location for a UnixFDList.
* @result A Variant tuple with return values.
* @throw Glib::Error.
* @newin{2,34}
*/
Glib::VariantContainerBase call_finish(const Glib::RefPtr<AsyncResult>& res, Glib::RefPtr<UnixFDList>& out_fd_list);
#endif // G_OS_UNIX
#endif // G_OS_UNIX
#ifdef G_OS_UNIX
/** Like g_dbus_proxy_call_sync() but also takes and returns UnixFDList objects.
*
* This method is only available on UNIX.
*
* @newin{2,30}
*
* @param method_name Name of method to invoke.
* @param parameters A Variant tuple with parameters for the signal
* or <tt>0</tt> if not passing parameters.
* @param flags Flags from the DBusCallFlags enumeration.
* @param timeout_msec The timeout in milliseconds (with MAXINT meaning
* "infinite") or -1 to use the proxy default timeout.
* @param fd_list A UnixFDList or <tt>0</tt>.
* @param out_fd_list Return location for a UnixFDList or <tt>0</tt>.
* @param cancellable A Cancellable or <tt>0</tt>.
* @return <tt>0</tt> if @a error is set. Otherwise a Variant tuple with
* return values. Free with Glib::variant_unref().
*/
Glib::VariantContainerBase call_sync(const Glib::ustring& method_name, const Glib::VariantContainerBase& parameters, const Glib::RefPtr<Cancellable>& cancellable, const Glib::RefPtr<UnixFDList>& fd_list, Glib::RefPtr<UnixFDList>& out_fd_list, int timeout_msec = -1, CallFlags flags = Gio::DBus::CALL_FLAGS_NONE);
#endif // G_OS_UNIX
#ifdef G_OS_UNIX
/// A call_sync() convenience overload.
Glib::VariantContainerBase call_sync(const Glib::ustring& method_name, const Glib::VariantContainerBase& parameters, const Glib::RefPtr<UnixFDList>& fd_list, Glib::RefPtr<UnixFDList>& out_fd_list, int timeout_msec = -1, CallFlags flags = Gio::DBus::CALL_FLAGS_NONE);
#endif // G_OS_UNIX
//_WRAP_PROPERTY("g-bus-type", BusType) // write-only construct-only
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The connection the proxy is for.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Connection> > property_g_connection() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Timeout for remote method invocation.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< int > property_g_default_timeout() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Timeout for remote method invocation.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< int > property_g_default_timeout() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Flags for the proxy.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< ProxyFlags > property_g_flags() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Interface Information.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<InterfaceInfo> > property_g_interface_info() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Interface Information.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<InterfaceInfo> > property_g_interface_info() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The D-Bus interface name the proxy is for.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_g_interface_name() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The well-known or unique name that the proxy is for.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_g_name() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The unique name for the owner.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_g_name_owner() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The object path the proxy is for.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_g_object_path() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
typedef std::map<Glib::ustring, Glib::VariantBase> MapChangedProperties;
// TODO: Should the signal names match the C API names (ie. the C API names
// are g_signal_name while these are just signal_name).
// The DBus API ensures that the variant changed_properties is of type "DICT<STRING,VARIANT>"
/**
* @par Slot Prototype:
* <tt>void on_my_%properties_changed(const MapChangedProperties& changed_properties, const std::vector<Glib::ustring>& invalidated_properties)</tt>
*
* Emitted when one or more D-Bus properties on @a proxy changes. The
* local cache has already been updated when this signal fires. Note
* that both @a changed_properties and @a invalidated_properties are
* guaranteed to never be <tt>0</tt> (either may be empty though).
*
* If the proxy has the flag
* DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES set, then
* @a invalidated_properties will always be empty.
*
* This signal corresponds to the
* `PropertiesChanged` D-Bus signal on the
* `org.freedesktop.DBus.Properties` interface.
*
* @newin{2,26}
*
* @param changed_properties A Variant containing the properties that changed.
* @param invalidated_properties A <tt>0</tt> terminated array of properties that was invalidated.
*/
Glib::SignalProxy2< void,const MapChangedProperties&,const std::vector<Glib::ustring>& > signal_properties_changed();
/**
* @par Slot Prototype:
* <tt>void on_my_%signal(const Glib::ustring& sender_name, const Glib::ustring& signal_name, const Glib::VariantContainerBase& parameters)</tt>
*
* Emitted when a signal from the remote object and interface that @a proxy is for, has been received.
*
* @newin{2,26}
*
* @param sender_name The sender of the signal or <tt>0</tt> if the connection is not a bus connection.
* @param signal_name The name of the signal.
* @param parameters A Variant tuple with parameters for the signal.
*/
Glib::SignalProxy3< void,const Glib::ustring&,const Glib::ustring&,const Glib::VariantContainerBase& > signal_signal();
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
/// This is a default handler for the signal signal_properties_changed().
virtual void on_properties_changed(const MapChangedProperties& changed_properties, const std::vector<Glib::ustring>& invalidated_properties);
/// This is a default handler for the signal signal_signal().
virtual void on_signal(const Glib::ustring& sender_name, const Glib::ustring& signal_name, const Glib::VariantContainerBase& parameters);
};
} //namespace
} // namespace Gio
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::DBus::Proxy
*/
Glib::RefPtr<Gio::DBus::Proxy> wrap(GDBusProxy* object, bool take_copy = false);
}
#endif /* _GIOMM_DBUSPROXY_H */
|