/usr/include/giomm-2.4/giomm/dbusmessage.h is in libglibmm-2.4-dev 2.32.1-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 | // -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GIOMM_DBUSMESSAGE_H
#define _GIOMM_DBUSMESSAGE_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 <glibmm/variant.h>
#include <glibmm/utility.h>
#ifdef G_OS_UNIX
# include <giomm/unixfdlist.h>
#endif
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GDBusMessage GDBusMessage;
typedef struct _GDBusMessageClass GDBusMessageClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
namespace DBus
{ class Message_Class; } // namespace DBus
} // namespace Gio
namespace Gio
{
namespace DBus
{
/** @addtogroup giommEnums giomm Enums and Flags */
/**
* @ingroup giommEnums
*/
enum MessageType
{
MESSAGE_TYPE_INVALID,
MESSAGE_TYPE_METHOD_CALL,
MESSAGE_TYPE_METHOD_RETURN,
MESSAGE_TYPE_ERROR,
MESSAGE_TYPE_SIGNAL
};
/**
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%MessageFlags operator|(MessageFlags, MessageFlags)</tt><br>
* <tt>%MessageFlags operator&(MessageFlags, MessageFlags)</tt><br>
* <tt>%MessageFlags operator^(MessageFlags, MessageFlags)</tt><br>
* <tt>%MessageFlags operator~(MessageFlags)</tt><br>
* <tt>%MessageFlags& operator|=(MessageFlags&, MessageFlags)</tt><br>
* <tt>%MessageFlags& operator&=(MessageFlags&, MessageFlags)</tt><br>
* <tt>%MessageFlags& operator^=(MessageFlags&, MessageFlags)</tt><br>
*/
enum MessageFlags
{
MESSAGE_FLAGS_NONE = 0x0,
MESSAGE_FLAGS_NO_REPLY_EXPECTED = (1<<0),
MESSAGE_FLAGS_NO_AUTO_START = (1<<1)
};
/** @ingroup giommEnums */
inline MessageFlags operator|(MessageFlags lhs, MessageFlags rhs)
{ return static_cast<MessageFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline MessageFlags operator&(MessageFlags lhs, MessageFlags rhs)
{ return static_cast<MessageFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline MessageFlags operator^(MessageFlags lhs, MessageFlags rhs)
{ return static_cast<MessageFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline MessageFlags operator~(MessageFlags flags)
{ return static_cast<MessageFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline MessageFlags& operator|=(MessageFlags& lhs, MessageFlags rhs)
{ return (lhs = static_cast<MessageFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline MessageFlags& operator&=(MessageFlags& lhs, MessageFlags rhs)
{ return (lhs = static_cast<MessageFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline MessageFlags& operator^=(MessageFlags& lhs, MessageFlags rhs)
{ return (lhs = static_cast<MessageFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
/**
* @ingroup giommEnums
*/
enum MessageHeaderField
{
MESSAGE_HEADER_FIELD_INVALID,
MESSAGE_HEADER_FIELD_PATH,
MESSAGE_HEADER_FIELD_INTERFACE,
MESSAGE_HEADER_FIELD_MEMBER,
MESSAGE_HEADER_FIELD_ERROR_NAME,
MESSAGE_HEADER_FIELD_REPLY_SERIAL,
MESSAGE_HEADER_FIELD_DESTINATION,
MESSAGE_HEADER_FIELD_SENDER,
MESSAGE_HEADER_FIELD_SIGNATURE,
MESSAGE_HEADER_FIELD_NUM_UNIX_FDS
};
/**
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%CapabilityFlags operator|(CapabilityFlags, CapabilityFlags)</tt><br>
* <tt>%CapabilityFlags operator&(CapabilityFlags, CapabilityFlags)</tt><br>
* <tt>%CapabilityFlags operator^(CapabilityFlags, CapabilityFlags)</tt><br>
* <tt>%CapabilityFlags operator~(CapabilityFlags)</tt><br>
* <tt>%CapabilityFlags& operator|=(CapabilityFlags&, CapabilityFlags)</tt><br>
* <tt>%CapabilityFlags& operator&=(CapabilityFlags&, CapabilityFlags)</tt><br>
* <tt>%CapabilityFlags& operator^=(CapabilityFlags&, CapabilityFlags)</tt><br>
*/
enum CapabilityFlags
{
CAPABILITY_FLAGS_NONE = 0x0,
CAPABILITY_FLAGS_UNIX_FD_PASSING = (1<<0)
};
/** @ingroup giommEnums */
inline CapabilityFlags operator|(CapabilityFlags lhs, CapabilityFlags rhs)
{ return static_cast<CapabilityFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline CapabilityFlags operator&(CapabilityFlags lhs, CapabilityFlags rhs)
{ return static_cast<CapabilityFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline CapabilityFlags operator^(CapabilityFlags lhs, CapabilityFlags rhs)
{ return static_cast<CapabilityFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline CapabilityFlags operator~(CapabilityFlags flags)
{ return static_cast<CapabilityFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline CapabilityFlags& operator|=(CapabilityFlags& lhs, CapabilityFlags rhs)
{ return (lhs = static_cast<CapabilityFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline CapabilityFlags& operator&=(CapabilityFlags& lhs, CapabilityFlags rhs)
{ return (lhs = static_cast<CapabilityFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline CapabilityFlags& operator^=(CapabilityFlags& lhs, CapabilityFlags rhs)
{ return (lhs = static_cast<CapabilityFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
/** A type for representing D-Bus messages that can be sent or received on a
* Connection.
*
* @newin{2,28}
* @ingroup DBus
*/
class Message : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef Message CppObjectType;
typedef Message_Class CppClassType;
typedef GDBusMessage BaseObjectType;
typedef GDBusMessageClass BaseClassType;
private: friend class Message_Class;
static CppClassType message_class_;
private:
// noncopyable
Message(const Message&);
Message& operator=(const Message&);
protected:
explicit Message(const Glib::ConstructParams& construct_params);
explicit Message(GDBusMessage* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~Message();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_type() G_GNUC_CONST;
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GDBusMessage* gobj() { return reinterpret_cast<GDBusMessage*>(gobject_); }
///Provides access to the underlying C GObject.
const GDBusMessage* gobj() const { return reinterpret_cast<GDBusMessage*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GDBusMessage* gobj_copy();
private:
protected:
Message();
public:
/** Creates a new empty DBusMessage.
*
* @newin{2,26}
* @return A DBusMessage. Free with Glib::object_unref().
*/
static Glib::RefPtr<Message> create();
// Note that we can't use _WRAP_CTOR() and _WRAP_CREATE() because the C functions do more than just call g_object_new():
// See http://bugzilla.gnome.org/show_bug.cgi?id=624977
// See here about whether the parameters should be ustring or std::string:
// http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names
// They are generally UTF-8 that can only contain the ASCII subset,
// so ustring still seems preferrable to std::string, which generally implies an unknown endoding for us.
/** Creates a new DBusMessage for a signal emission.
*
* @newin{2,26}
* @param path A valid object path.
* @param interface A valid D-Bus interface name.
* @param signal A valid signal name.
* @return A DBusMessage. Free with Glib::object_unref().
*/
static Glib::RefPtr<Message> create_signal(const Glib::ustring& path, const Glib::ustring& interface, const Glib::ustring& signal);
/** Creates a new DBusMessage for a method call.
*
* @newin{2,26}
* @param name A valid D-Bus name or <tt>0</tt>.
* @param path A valid object path.
* @param interface A valid D-Bus interface name or <tt>0</tt>.
* @param method A valid method name.
* @return A DBusMessage. Free with Glib::object_unref().
*/
static Glib::RefPtr<Message> create_method_call(const Glib::ustring& name, const Glib::ustring& path, const Glib::ustring& interface, const Glib::ustring& method);
/** Creates a new DBusMessage that is a reply to @a method_call_message.
*
* @newin{2,26}
* @return DBusMessage. Free with Glib::object_unref().
*/
static Glib::RefPtr<Message> create_method_reply(const Glib::RefPtr<Message>& method_call_message);
/** Creates a new DBusMessage that is an error reply to @a method_call_message.
*
* @newin{2,26}
* @param error_name A valid D-Bus error name.
* @param error_message The D-Bus error message.
* @return A DBusMessage. Free with Glib::object_unref().
*/
static Glib::RefPtr<Message> create_method_error_literal(const Glib::RefPtr<const Message>& method_call_message, const Glib::ustring& error_name, const Glib::ustring& error_message);
// Ignore variable argument function.
/** Creates a new DBusMessage from the data stored at @a blob. The byte
* order that the message was in can be retrieved using
* g_dbus_message_get_byte_order().
*
* @newin{2,26}
* @param blob A blob represent a binary D-Bus message.
* @param blob_len The length of @a blob.
* @param capabilities A DBusCapabilityFlags describing what protocol features are supported.
* @return A new DBusMessage or <tt>0</tt> if @a error is set. Free with
* Glib::object_unref().
*/
static Glib::RefPtr<Message> create_from_blob(const guchar* blob, gsize blob_len, CapabilityFlags capabilities = CAPABILITY_FLAGS_NONE);
/** Produces a human-readable multi-line description of @a message.
*
* The contents of the description has no ABI guarantees, the contents
* and formatting is subject to change at any time. Typical output
* looks something like this:
*
* Type: method-call
* Flags: none
* Version: 0
* Serial: 4
* Headers:
* path -> objectpath '/org/gtk/GDBus/TestObject'
* interface -> 'org.gtk.GDBus.TestInterface'
* member -> 'GimmeStdout'
* destination -> ':1.146'
* Body: ()
* UNIX File Descriptors:
* (none)
*
* or
*
* Type: method-return
* Flags: no-reply-expected
* Version: 0
* Serial: 477
* Headers:
* reply-serial -> uint32 4
* destination -> ':1.159'
* sender -> ':1.146'
* num-unix-fds -> uint32 1
* Body: ()
* UNIX File Descriptors:
* fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
*
*
* @newin{2,26}
* @param indent Indentation level.
* @return A string that should be freed with Glib::free().
*/
Glib::ustring print(guint indent);
/** Checks whether @a message is locked. To monitor changes to this
* value, conncet to the Object::signal_notify() signal to listen for changes
* on the DBusMessage::property_locked() property.
*
* @newin{2,26}
* @return <tt>true</tt> if @a message is locked, <tt>false</tt> otherwise.
*/
bool get_locked() const;
/** If @a message is locked, does nothing. Otherwise locks the message.
*
* @newin{2,26}
*/
void lock();
/** Copies @a message. The copy is a deep copy and the returned
* DBusMessage is completely identical except that it is guaranteed
* to not be locked.
*
* This operation can fail if e.g. @a message contains file descriptors
* and the per-process or system-wide open files limit is reached.
*
* @newin{2,26}
* @return A new DBusMessage or <tt>0</tt> if @a error is set.
* Free with Glib::object_unref().
*/
Glib::RefPtr<Message> copy() const;
/** Gets the type of @a message.
*
* @newin{2,26}
* @return A 8-bit unsigned integer (typically a value from the DBusMessageType enumeration).
*/
MessageType get_message_type() const;
/** Sets @a message to be of @a type.
*
* @newin{2,26}
* @param type A 8-bit unsigned integer (typically a value from the DBusMessageType enumeration).
*/
void set_message_type(MessageType type);
//gmmproc can't handle the character literals, and this won't be expanded in future,
//so we just wrap it by hand.
enum ByteOrder
{
BYTE_ORDER_BIG_ENDIAN = 'B',
BYTE_ORDER_LITTLE_ENDIAN = 'l'
};
/** Gets the byte order of @a message.
* @return The byte order.
*/
ByteOrder get_byte_order() const;
/** Sets the byte order of @a message.
* @param byte_order The byte order.
*/
void set_byte_order(ByteOrder byte_order);
/** Gets the serial for @a message.
*
* @newin{2,26}
* @return A #guint32.
*/
guint32 get_serial() const;
/** Sets the serial for @a message.
*
* @newin{2,26}
* @param serial A #guint32.
*/
void set_serial(guint32 serial);
/** Gets the flags for @a message.
*
* @newin{2,26}
* @return Flags that are set (typically values from the DBusMessageFlags enumeration bitwise ORed together).
*/
MessageFlags get_flags() const;
/** Sets the flags to set on @a message.
*
* @newin{2,26}
* @param flags Flags for @a message that are set (typically values from the DBusMessageFlags
* enumeration bitwise ORed together).
*/
void set_flags(MessageFlags flags);
/** Gets the body of a message. The body is returned in @a value.
* @param value Location in which to store the header.
*/
void get_body(Glib::VariantBase& value) const;
/** Sets the body @a message. As a side-effect the
* DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
* type string of @a body (or cleared if @a body is <tt>0</tt>).
*
* If @a body is floating, @a message assumes ownership of @a body.
*
* @newin{2,26}
* @param body Either <tt>0</tt> or a Variant that is a tuple.
*/
void set_body(const Glib::VariantBase& body);
/** Gets the UNIX file descriptors associated with @a message, if any.
*
* This method is only available on UNIX.
*
* @newin{2,26}
* @return A UnixFDList or <tt>0</tt> if no file descriptors are
* associated. Do not free, this object is owned by @a message.
*/
#ifdef G_OS_UNIX
Glib::RefPtr<UnixFDList> get_unix_fd_list();
#endif // G_OS_UNIX
/** Gets the UNIX file descriptors associated with @a message, if any.
*
* This method is only available on UNIX.
*
* @newin{2,26}
* @return A UnixFDList or <tt>0</tt> if no file descriptors are
* associated. Do not free, this object is owned by @a message.
*/
#ifdef G_OS_UNIX
Glib::RefPtr<const UnixFDList> get_unix_fd_list() const;
#endif // G_OS_UNIX
/** Sets the UNIX file descriptors associated with @a message. As a
* side-effect the DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
* field is set to the number of fds in @a fd_list (or cleared if
* @a fd_list is <tt>0</tt>).
*
* This method is only available on UNIX.
*
* @newin{2,26}
* @param fd_list A UnixFDList or <tt>0</tt>.
*/
#ifdef G_OS_UNIX
void set_unix_fd_list(const Glib::RefPtr<UnixFDList>& fd_list);
#endif // G_OS_UNIX
#ifdef G_OS_UNIX
/** Clears the existing UNIX file descriptor list.
*/
void unset_unix_fd_list();
#endif //G_OS_UNIX
/** Convenience getter for the DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
*
* @newin{2,26}
* @return The value.
*/
guint32 get_num_unix_fds() const;
/** Convenience setter for the DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
*
* @newin{2,26}
* @param value The value to set.
*/
void set_num_unix_fds(guint32 value);
//TODO: _WRAP_METHOD(std::vector<whattypeshallweuse>) get_header_fields() const, g_dbus_message_get_header_fields)
/** Gets a header field on the message. The header is returned in @a value.
* @param value Location in which to store the header.
* @param header_field The header field type.
*/
void get_header(Glib::VariantBase& value, MessageHeaderField header_field) const;
/** Sets a header field on @a message.
*
* If @a value is floating, @a message assumes ownership of @a value.
*
* @newin{2,26}
* @param header_field A 8-bit unsigned integer (typically a value from the DBusMessageHeaderField enumeration).
* @param value A Variant to set the header field or <tt>0</tt> to clear the header field.
*/
void set_header(MessageHeaderField header_field, const Glib::VariantBase& value);
/** Gets an array of all header fields on @a message that are set.
*
* @newin{2,26}
* @return An array of header fields
* terminated by DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element
* is a #guchar. Free with Glib::free().
*/
Glib::ArrayHandle<guchar> get_header_fields() const;
/** Convenience getter for the DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
*
* @newin{2,26}
* @return The value.
*/
Glib::ustring get_destination() const;
/** Convenience setter for the DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
*
* @newin{2,26}
* @param value The value to set.
*/
void set_destination(const Glib::ustring& value);
/** Convenience getter for the DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
*
* @newin{2,26}
* @return The value.
*/
Glib::ustring get_error_name() const;
/** Convenience setter for the DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
*
* @newin{2,26}
* @param value The value to set.
*/
void set_error_name(const Glib::ustring& value);
/** Convenience getter for the DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
*
* @newin{2,26}
* @return The value.
*/
Glib::ustring get_interface() const;
/** Convenience setter for the DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
*
* @newin{2,26}
* @param value The value to set.
*/
void set_interface(const Glib::ustring& value);
/** Convenience getter for the DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
*
* @newin{2,26}
* @return The value.
*/
Glib::ustring get_member() const;
/** Convenience setter for the DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
*
* @newin{2,26}
* @param value The value to set.
*/
void set_member(const Glib::ustring& value);
/** Convenience getter for the DBUS_MESSAGE_HEADER_FIELD_PATH header field.
*
* @newin{2,26}
* @return The value.
*/
Glib::ustring get_path() const;
/** Convenience setter for the DBUS_MESSAGE_HEADER_FIELD_PATH header field.
*
* @newin{2,26}
* @param value The value to set.
*/
void set_path(const Glib::ustring& value);
/** Convenience getter for the DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
*
* @newin{2,26}
* @return The value.
*/
guint32 get_reply_serial() const;
/** Convenience setter for the DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
*
* @newin{2,26}
* @param value The value to set.
*/
void set_reply_serial(guint32 value);
/** Convenience getter for the DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
*
* @newin{2,26}
* @return The value.
*/
Glib::ustring get_sender() const;
/** Convenience setter for the DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
*
* @newin{2,26}
* @param value The value to set.
*/
void set_sender(const Glib::ustring& value);
/** Convenience getter for the DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
*
* @newin{2,26}
* @return The value.
*/
Glib::ustring get_signature() const;
/** Convenience setter for the DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
*
* @newin{2,26}
* @param value The value to set.
*/
void set_signature(const Glib::ustring& value);
/** Convenience to get the first item in the body of @a message.
*
* @newin{2,26}
* @return The string item or <tt>0</tt> if the first item in the body of
* @a message is not a string.
*/
Glib::ustring get_arg0() const;
/** Utility function to calculate how many bytes are needed to
* completely deserialize the D-Bus message stored at @a blob.
*
* @newin{2,26}
* @param blob A blob represent a binary D-Bus message.
* @param blob_len The length of @a blob (must be at least 16).
* @return Number of bytes needed or -1 if @a error is set (e.g. if
* @a blob contains invalid data or not enough data is available to
* determine the size).
*/
static gssize bytes_needed(const guchar* blob, gsize blob_len);
/** Serializes @a message to a blob. The byte order returned by
* g_dbus_message_get_byte_order() will be used.
*
* @newin{2,26}
* @param out_size Return location for size of generated blob.
* @param capabilities A DBusCapabilityFlags describing what protocol features are supported.
* @return A pointer to a
* valid binary D-Bus message of @a out_size bytes generated by @a message
* or <tt>0</tt> if @a error is set. Free with Glib::free().
*/
guchar* to_blob(gsize& out_size, CapabilityFlags capabilities = CAPABILITY_FLAGS_NONE);
/** If @a message is not of type DBUS_MESSAGE_TYPE_ERROR does
* nothing and returns <tt>false</tt>.
*
* Otherwise this method encodes the error in @a message as a Error
* using g_dbus_error_set_dbus_error() using the information in the
* DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @a message as
* well as the first string item in @a message's body.
*
* @newin{2,26}
* @return <tt>true</tt> if @a error was set, <tt>false</tt> otherwise.
*/
void to_exception();
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether the message is locked.
*
* 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 property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_locked() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
} //namespace DBus
} // 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::Message
*/
Glib::RefPtr<Gio::DBus::Message> wrap(GDBusMessage* object, bool take_copy = false);
}
#endif /* _GIOMM_DBUSMESSAGE_H */
|