/usr/include/giomm-2.4/giomm/dbusmethodinvocation.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 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_DBUSMETHODINVOCATION_H
#define _GIOMM_DBUSMETHODINVOCATION_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 <giomm/dbusconnection.h>
#include <giomm/dbusmessage.h>
#include <giomm/dbusintrospection.h>
#include <glibmm/object.h>
#include <glibmm/variant.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GDBusMethodInvocation GDBusMethodInvocation;
typedef struct _GDBusMethodInvocationClass GDBusMethodInvocationClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
namespace DBus
{ class MethodInvocation_Class; } // namespace DBus
} // namespace Gio
namespace Glib
{
class Error;
}
namespace Gio
{
namespace DBus
{
class Connection;
/** An Object for handling remote calls.
* Instances of the MethodInvocation 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 MethodInvocation object is to receive it as
* an argument to the SlotMethodCall that was passed to
* Gio::DBus::Connection::register_object().
*
* @newin{2,28}
* @ingroup DBus
*/
class MethodInvocation : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef MethodInvocation CppObjectType;
typedef MethodInvocation_Class CppClassType;
typedef GDBusMethodInvocation BaseObjectType;
typedef GDBusMethodInvocationClass BaseClassType;
private: friend class MethodInvocation_Class;
static CppClassType methodinvocation_class_;
private:
// noncopyable
MethodInvocation(const MethodInvocation&);
MethodInvocation& operator=(const MethodInvocation&);
protected:
explicit MethodInvocation(const Glib::ConstructParams& construct_params);
explicit MethodInvocation(GDBusMethodInvocation* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~MethodInvocation();
/** 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.
GDBusMethodInvocation* gobj() { return reinterpret_cast<GDBusMethodInvocation*>(gobject_); }
///Provides access to the underlying C GObject.
const GDBusMethodInvocation* gobj() const { return reinterpret_cast<GDBusMethodInvocation*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GDBusMethodInvocation* gobj_copy();
private:
public:
/** Gets the bus name that invoked the method.
*
* @newin{2,26}
*
* @return A string. Do not free, it is owned by @a invocation.
*/
Glib::ustring get_sender() const;
/** Gets the object path the method was invoked on.
*
* @newin{2,26}
*
* @return A string. Do not free, it is owned by @a invocation.
*/
Glib::ustring get_object_path() const;
/** Gets the name of the D-Bus interface the method was invoked on.
*
* If this method call is a property Get, Set or GetAll call that has
* been redirected to the method call handler then
* "org.freedesktop.DBus.Properties" will be returned. See
* DBusInterfaceVTable for more information.
*
* @newin{2,26}
*
* @return A string. Do not free, it is owned by @a invocation.
*/
Glib::ustring get_interface_name() const;
/** Gets the name of the method that was invoked.
*
* @newin{2,26}
*
* @return A string. Do not free, it is owned by @a invocation.
*/
Glib::ustring get_method_name() const;
// The C API only returns a const GDBusMethodInfo.
/** Gets information about the method call, if any.
*
* If this method invocation is a property Get, Set or GetAll call that
* has been redirected to the method call handler then <tt>0</tt> will be
* returned. See g_dbus_method_invocation_get_property_info() and
* DBusInterfaceVTable for more information.
*
* @newin{2,26}
*
* @return A DBusMethodInfo or <tt>0</tt>. Do not free, it is owned by @a invocation.
*/
Glib::RefPtr<const MethodInfo> get_method_info() const;
/** Gets the DBusConnection the method was invoked on.
*
* @newin{2,26}
*
* @return A DBusConnection. Do not free, it is owned by @a invocation.
*/
Glib::RefPtr<Connection> get_connection();
/** Gets the DBusConnection the method was invoked on.
*
* @newin{2,26}
*
* @return A DBusConnection. Do not free, it is owned by @a invocation.
*/
Glib::RefPtr<const Connection> get_connection() const;
/** Gets the DBusMessage for the method invocation. This is useful if
* you need to use low-level protocol features, such as UNIX file
* descriptor passing, that cannot be properly expressed in the
* Variant API.
*
* See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
* for an example of how to use this low-level API to send and receive
* UNIX file descriptors.
*
* @newin{2,26}
*
* @return DBusMessage. Do not free, it is owned by @a invocation.
*/
Glib::RefPtr<Message> get_message();
/** Gets the DBusMessage for the method invocation. This is useful if
* you need to use low-level protocol features, such as UNIX file
* descriptor passing, that cannot be properly expressed in the
* Variant API.
*
* See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
* for an example of how to use this low-level API to send and receive
* UNIX file descriptors.
*
* @newin{2,26}
*
* @return DBusMessage. Do not free, it is owned by @a invocation.
*/
Glib::RefPtr<const Message> get_message() const;
//We assume that this is a tuple (VariantContainerBase).
//See https://bugzilla.gnome.org/show_bug.cgi?id=646420
/** Gets the parameters of the method invocation. If there are no input
* parameters then this will return a GVariant with 0 children rather than <tt>0</tt>.
*
* @newin{2,26}
*
* @return A Variant tuple. Do not unref this because it is owned by @a invocation.
*/
Glib::VariantContainerBase get_parameters() const;
//TODO: Add a return_single_value() method?
//A return_value(VariantBase) would probably be ambiguous to people
//even if it isn't ambiguous to the compiler.
/** Finishes handling a D-Bus method call by returning @a parameters.
* If the @a parameters GVariant is floating, it is consumed.
*
* It is an error if @a parameters is not of the right format.
*
* This method will free @a invocation, you cannot use it afterwards.
*
* @newin{2,26}
*
* @param parameters A Variant tuple with out parameters for the method or <tt>0</tt> if not passing any parameters.
*/
void return_value(const Glib::VariantContainerBase& parameters);
#ifdef G_OS_UNIX
/** Like g_dbus_method_invocation_return_value() but also takes a UnixFDList.
*
* This method is only available on UNIX.
*
* This method will free @a invocation, you cannot use it afterwards.
*
* @newin{2,30}
*
* @param parameters A Variant tuple with out parameters for the method or <tt>0</tt> if not passing any parameters.
* @param fd_list A UnixFDList or <tt>0</tt>.
*/
void return_value(const Glib::VariantContainerBase& parameters, const Glib::RefPtr<UnixFDList>& fd_list);
#endif // G_OS_UNIX
/** Like g_dbus_method_invocation_return_error() but without printf()-style formatting.
*
* This method will free @a invocation, you cannot use it afterwards.
*
* @newin{2,26}
*
* @param domain A Quark for the Error error domain.
* @param code The error code.
* @param message The error message.
*/
void return_error(const Glib::ustring& domain, int code, const Glib::ustring& message);
// This function does not have to be wrapped because it's a convenience C
// function to avoid having to unreference the error (in C).
/** Like g_dbus_method_invocation_return_error() but takes a Error
* instead of the error domain, error code and message.
*
* This method will free @a invocation, you cannot use it afterwards.
*
* @newin{2,26}
*
*/
void return_error(const Glib::Error& error);
/** Finishes handling a D-Bus method call by returning an error.
*
* This method will free @a invocation, you cannot use it afterwards.
*
* @newin{2,26}
*
* @param error_name A valid D-Bus error name.
* @param error_message A valid D-Bus error message.
*/
void return_dbus_error(const Glib::ustring& error_name, const Glib::ustring& error_message);
// Ignore vararg methods and ones that don't make sense for C++ API.
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::MethodInvocation
*/
Glib::RefPtr<Gio::DBus::MethodInvocation> wrap(GDBusMethodInvocation* object, bool take_copy = false);
}
#endif /* _GIOMM_DBUSMETHODINVOCATION_H */
|