Gio::DBusMethodInvocation Class Reference

DBusMethodInvocation - Object for handling remote calls. More...

#include <giomm/dbusmethodinvocation.h>

Inheritance diagram for Gio::DBusMethodInvocation:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~DBusMethodInvocation ()
GDBusMethodInvocation* gobj ()
 Provides access to the underlying C GObject.
const GDBusMethodInvocation* gobj () const
 Provides access to the underlying C GObject.
GDBusMethodInvocation* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::ustring get_sender () const
Glib::ustring get_object_path () const
Glib::ustring get_interface_name () const
Glib::ustring get_method_name () const
Glib::RefPtr< DBusConnectionget_connection ()
Glib::RefPtr< const
DBusConnection
get_connection () const
Glib::RefPtr< DBusMessageget_message ()
Glib::RefPtr< const DBusMessageget_message () const
void get_parameters (Glib::VariantBase&value) const
 Gets the parameters of the method invocation.
void return_value (const Glib::VariantBase& parameters)
void return_error_literal (const Glib::ustring& domain, int code, const Glib::ustring& message)
void return_gerror (const Glib::Error& error)
void return_dbus_error (const Glib::ustring& error_name, const Glib::ustring& error_message)

Protected Member Functions

 DBusMethodInvocation ()

Related Functions

(Note that these are not member functions.)



Glib::RefPtr
< Gio::DBusMethodInvocation
wrap (GDBusMethodInvocation* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

DBusMethodInvocation - Object for handling remote calls.

Instances of the DBusMethodInvocation class are used when handling D-Bus method calls. It provides a way to asynchronously return results and errors.

The normal way to obtain a DBusMethodInvocation object is to receive it as an argument to the SlotMethodCall that was passed to Gio::DBusConnection::register_object().

Since glibmm 2.26:

Constructor & Destructor Documentation

virtual Gio::DBusMethodInvocation::~DBusMethodInvocation (  )  [virtual]
Gio::DBusMethodInvocation::DBusMethodInvocation (  )  [protected]

Member Function Documentation

Glib::RefPtr<const DBusConnection> Gio::DBusMethodInvocation::get_connection (  )  const
Glib::RefPtr<DBusConnection> Gio::DBusMethodInvocation::get_connection (  ) 
Glib::ustring Gio::DBusMethodInvocation::get_interface_name (  )  const
Glib::RefPtr<const DBusMessage> Gio::DBusMethodInvocation::get_message (  )  const
Glib::RefPtr<DBusMessage> Gio::DBusMethodInvocation::get_message (  ) 
Glib::ustring Gio::DBusMethodInvocation::get_method_name (  )  const
Glib::ustring Gio::DBusMethodInvocation::get_object_path (  )  const
void Gio::DBusMethodInvocation::get_parameters ( Glib::VariantBase value  )  const

Gets the parameters of the method invocation.

Parameters:
value The location in which to return the parameters.
Since glibmm 2.26:
Glib::ustring Gio::DBusMethodInvocation::get_sender (  )  const
const GDBusMethodInvocation* Gio::DBusMethodInvocation::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GDBusMethodInvocation* Gio::DBusMethodInvocation::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GDBusMethodInvocation* Gio::DBusMethodInvocation::gobj_copy (  ) 

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

void Gio::DBusMethodInvocation::return_dbus_error ( const Glib::ustring error_name,
const Glib::ustring error_message 
)
void Gio::DBusMethodInvocation::return_error_literal ( const Glib::ustring domain,
int  code,
const Glib::ustring message 
)
void Gio::DBusMethodInvocation::return_gerror ( const Glib::Error error  ) 
void Gio::DBusMethodInvocation::return_value ( const Glib::VariantBase parameters  ) 

Friends And Related Function Documentation

Glib::RefPtr< Gio::DBusMethodInvocation > wrap ( GDBusMethodInvocation *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.

Generated on Tue Aug 3 16:50:04 2010 for glibmm by  doxygen 1.6.1