gio/gdbusprivate.h

   1 /* GDBus - GLib D-Bus Library
   2  *
   3  * Copyright (C) 2008-2010 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: David Zeuthen <davidz@redhat.com>
  21  */
  22
  23 #if !defined (GIO_COMPILATION)
  24 #error "gdbusprivate.h is a private header file."
  25 #endif
  26
  27 #ifndef __G_DBUS_PRIVATE_H__
  28 #define __G_DBUS_PRIVATE_H__
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 /* ---------------------------------------------------------------------------------------------------- */
  35
  36 typedef struct GDBusWorker GDBusWorker;
  37
  38 typedef void (*GDBusWorkerMessageReceivedCallback) (GDBusWorker   *worker,
  39                                                     GDBusMessage  *message,
  40                                                     gpointer       user_data);
  41
  42 typedef GDBusMessage *(*GDBusWorkerMessageAboutToBeSentCallback) (GDBusWorker   *worker,
  43                                                                   GDBusMessage  *message,
  44                                                                   gpointer       user_data);
  45
  46 typedef void (*GDBusWorkerDisconnectedCallback)    (GDBusWorker   *worker,
  47                                                     gboolean       remote_peer_vanished,
  48                                                     GError        *error,
  49                                                     gpointer       user_data);
  50
  51 /* This function may be called from any thread - callbacks will be in the shared private message thread
  52  * and must not block.
  53  */
  54 GDBusWorker *_g_dbus_worker_new          (GIOStream                          *stream,
  55                                           GDBusCapabilityFlags                capabilities,
  56                                           gboolean                            initially_frozen,
  57                                           GDBusWorkerMessageReceivedCallback  message_received_callback,
  58                                           GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback,
  59                                           GDBusWorkerDisconnectedCallback     disconnected_callback,
  60                                           gpointer                            user_data);
  61
  62 /* can be called from any thread - steals blob */
  63 void         _g_dbus_worker_send_message (GDBusWorker    *worker,
  64                                           GDBusMessage   *message,
  65                                           gchar          *blob,
  66                                           gsize           blob_len);
  67
  68 /* can be called from any thread */
  69 void         _g_dbus_worker_stop         (GDBusWorker    *worker);
  70
  71 /* can be called from any thread */
  72 void         _g_dbus_worker_unfreeze     (GDBusWorker    *worker);
  73
  74 /* can be called from any thread (except the worker thread) */
  75 gboolean     _g_dbus_worker_flush_sync   (GDBusWorker    *worker,
  76                                           GCancellable   *cancellable,
  77                                           GError        **error);
  78
  79 /* can be called from any thread */
  80 void         _g_dbus_worker_close        (GDBusWorker         *worker,
  81                                           GCancellable        *cancellable,
  82                                           GSimpleAsyncResult  *result);
  83
  84 /* ---------------------------------------------------------------------------------------------------- */
  85
  86 void _g_dbus_initialize (void);
  87 gboolean _g_dbus_debug_authentication (void);
  88 gboolean _g_dbus_debug_transport (void);
  89 gboolean _g_dbus_debug_message (void);
  90 gboolean _g_dbus_debug_payload (void);
  91 gboolean _g_dbus_debug_call    (void);
  92 gboolean _g_dbus_debug_signal  (void);
  93 gboolean _g_dbus_debug_incoming (void);
  94 gboolean _g_dbus_debug_return (void);
  95 gboolean _g_dbus_debug_emission (void);
  96 gboolean _g_dbus_debug_address (void);
  97
  98 void     _g_dbus_debug_print_lock (void);
  99 void     _g_dbus_debug_print_unlock (void);
 100
 101 gboolean _g_dbus_address_parse_entry (const gchar  *address_entry,
 102                                       gchar       **out_transport_name,
 103                                       GHashTable  **out_key_value_pairs,
 104                                       GError      **error);
 105
 106 GVariantType * _g_dbus_compute_complete_signature (GDBusArgInfo **args);
 107
 108 gchar *_g_dbus_hexdump (const gchar *data, gsize len, guint indent);
 109
 110 /* ---------------------------------------------------------------------------------------------------- */
 111
 112 #ifdef G_OS_WIN32
 113 gchar *_g_dbus_win32_get_user_sid (void);
 114 #endif
 115
 116 gchar *_g_dbus_get_machine_id (GError **error);
 117
 118 gchar *_g_dbus_enum_to_string (GType enum_type, gint value);
 119
 120 /* ---------------------------------------------------------------------------------------------------- */
 121
 122 GDBusMethodInvocation *_g_dbus_method_invocation_new (const gchar           *sender,
 123                                                       const gchar           *object_path,
 124                                                       const gchar           *interface_name,
 125                                                       const gchar           *method_name,
 126                                                       const GDBusMethodInfo *method_info,
 127                                                       GDBusConnection       *connection,
 128                                                       GDBusMessage          *message,
 129                                                       GVariant              *parameters,
 130                                                       gpointer               user_data);
 131
 132 /* ---------------------------------------------------------------------------------------------------- */
 133
 134 gboolean _g_signal_accumulator_false_handled (GSignalInvocationHint *ihint,
 135                                               GValue                *return_accu,
 136                                               const GValue          *handler_return,
 137                                               gpointer               dummy);
 138
 139 gboolean _g_dbus_object_skeleton_has_authorize_method_handlers (GDBusObjectSkeleton *object);
 140
 141 void _g_dbus_object_proxy_add_interface (GDBusObjectProxy *proxy,
 142                                          GDBusProxy       *interface_proxy);
 143 void _g_dbus_object_proxy_remove_interface (GDBusObjectProxy *proxy,
 144                                             const gchar      *interface_name);
 145
 146 /* Implemented in gdbusconnection.c */
 147 GDBusConnection *_g_bus_get_singleton_if_exists (GBusType bus_type);
 148
 149 G_END_DECLS
 150
 151 #endif /* __G_DBUS_PRIVATE_H__ */