glib-2.0/gio/gdbusinterfaceskeleton.h

0001 /* GDBus - GLib D-Bus Library
0002  *
0003  * Copyright (C) 2008-2010 Red Hat, Inc.
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  *
0020  * Author: David Zeuthen <davidz@redhat.com>
0021  */
0022
0023 #ifndef __G_DBUS_INTERFACE_SKELETON_H__
0024 #define __G_DBUS_INTERFACE_SKELETON_H__
0025
0026 #include <gio/gdbusconnection.h>
0027 #include <gio/giotypes.h>
0028
0029 G_BEGIN_DECLS
0030
0031 #define G_TYPE_DBUS_INTERFACE_SKELETON         (g_dbus_interface_skeleton_get_type ())
0032 #define G_DBUS_INTERFACE_SKELETON(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_INTERFACE_SKELETON, GDBusInterfaceSkeleton))
0033 #define G_DBUS_INTERFACE_SKELETON_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DBUS_INTERFACE_SKELETON, GDBusInterfaceSkeletonClass))
0034 #define G_DBUS_INTERFACE_SKELETON_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DBUS_INTERFACE_SKELETON, GDBusInterfaceSkeletonClass))
0035 #define G_IS_DBUS_INTERFACE_SKELETON(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_INTERFACE_SKELETON))
0036 #define G_IS_DBUS_INTERFACE_SKELETON_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DBUS_INTERFACE_SKELETON))
0037
0038 typedef struct _GDBusInterfaceSkeletonClass   GDBusInterfaceSkeletonClass;
0039 typedef struct _GDBusInterfaceSkeletonPrivate GDBusInterfaceSkeletonPrivate;
0040
0041 struct _GDBusInterfaceSkeleton
0042 {
0043   /*< private >*/
0044   GObject parent_instance;
0045   GDBusInterfaceSkeletonPrivate *priv;
0046 };
0047
0048 /**
0049  * GDBusInterfaceSkeletonClass:
0050  * @parent_class: The parent class.
0051  * @get_info: Returns a #GDBusInterfaceInfo. See g_dbus_interface_skeleton_get_info() for details.
0052  * @get_vtable: Returns a #GDBusInterfaceVTable. See g_dbus_interface_skeleton_get_vtable() for details.
0053  * @get_properties: Returns a #GVariant with all properties. See g_dbus_interface_skeleton_get_properties().
0054  * @flush: Emits outstanding changes, if any. See g_dbus_interface_skeleton_flush().
0055  * @method_dispatch: Dispatches a method invocation. (Since: 2.88)
0056  * @g_authorize_method: Signal class handler for the #GDBusInterfaceSkeleton::g-authorize-method signal.
0057  *
0058  * Class structure for #GDBusInterfaceSkeleton.
0059  *
0060  * Since: 2.30
0061  */
0062 struct _GDBusInterfaceSkeletonClass
0063 {
0064   GObjectClass parent_class;
0065
0066   /* Virtual Functions */
0067   GDBusInterfaceInfo   *(*get_info)       (GDBusInterfaceSkeleton  *interface_);
0068   GDBusInterfaceVTable *(*get_vtable)     (GDBusInterfaceSkeleton  *interface_);
0069   GVariant             *(*get_properties) (GDBusInterfaceSkeleton  *interface_);
0070   void                  (*flush)          (GDBusInterfaceSkeleton  *interface_);
0071   void                  (*method_dispatch) (GDBusInterfaceSkeleton       *interface_,
0072                                             GDBusInterfaceMethodCallFunc  method_call_func,
0073                                             GDBusMethodInvocation        *invocation,
0074                                             GDBusInterfaceSkeletonFlags   flags,
0075                                             GDBusObject                  *object);
0076
0077   /*< private >*/
0078   gpointer vfunc_padding[7];
0079   /*< public >*/
0080
0081   /* Signals */
0082   gboolean (*g_authorize_method) (GDBusInterfaceSkeleton  *interface_,
0083                                   GDBusMethodInvocation   *invocation);
0084
0085   /*< private >*/
0086   gpointer signal_padding[8];
0087 };
0088
0089 GIO_AVAILABLE_IN_ALL
0090 GType                        g_dbus_interface_skeleton_get_type        (void) G_GNUC_CONST;
0091 GIO_AVAILABLE_IN_ALL
0092 GDBusInterfaceSkeletonFlags  g_dbus_interface_skeleton_get_flags       (GDBusInterfaceSkeleton      *interface_);
0093 GIO_AVAILABLE_IN_ALL
0094 void                         g_dbus_interface_skeleton_set_flags       (GDBusInterfaceSkeleton      *interface_,
0095                                                                         GDBusInterfaceSkeletonFlags  flags);
0096 GIO_AVAILABLE_IN_ALL
0097 GDBusInterfaceInfo          *g_dbus_interface_skeleton_get_info        (GDBusInterfaceSkeleton      *interface_);
0098 GIO_AVAILABLE_IN_ALL
0099 GDBusInterfaceVTable        *g_dbus_interface_skeleton_get_vtable      (GDBusInterfaceSkeleton      *interface_);
0100 GIO_AVAILABLE_IN_ALL
0101 GVariant                    *g_dbus_interface_skeleton_get_properties  (GDBusInterfaceSkeleton      *interface_);
0102 GIO_AVAILABLE_IN_ALL
0103 void                         g_dbus_interface_skeleton_flush           (GDBusInterfaceSkeleton      *interface_);
0104
0105 GIO_AVAILABLE_IN_ALL
0106 gboolean                     g_dbus_interface_skeleton_export          (GDBusInterfaceSkeleton      *interface_,
0107                                                                         GDBusConnection             *connection,
0108                                                                         const gchar                 *object_path,
0109                                                                         GError                     **error);
0110 GIO_AVAILABLE_IN_ALL
0111 void                         g_dbus_interface_skeleton_unexport        (GDBusInterfaceSkeleton      *interface_);
0112 GIO_AVAILABLE_IN_ALL
0113 void                g_dbus_interface_skeleton_unexport_from_connection (GDBusInterfaceSkeleton      *interface_,
0114                                                                         GDBusConnection             *connection);
0115
0116 GIO_AVAILABLE_IN_ALL
0117 GDBusConnection             *g_dbus_interface_skeleton_get_connection  (GDBusInterfaceSkeleton      *interface_);
0118 GIO_AVAILABLE_IN_ALL
0119 GList                       *g_dbus_interface_skeleton_get_connections (GDBusInterfaceSkeleton      *interface_);
0120 GIO_AVAILABLE_IN_ALL
0121 gboolean                     g_dbus_interface_skeleton_has_connection  (GDBusInterfaceSkeleton      *interface_,
0122                                                                         GDBusConnection             *connection);
0123 GIO_AVAILABLE_IN_ALL
0124 const gchar                 *g_dbus_interface_skeleton_get_object_path (GDBusInterfaceSkeleton      *interface_);
0125
0126 G_END_DECLS
0127
0128 #endif /* __G_DBUS_INTERFACE_SKELETON_H */