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.1 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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: David Zeuthen <davidz@redhat.com>
  19  */
  20
  21 #ifndef __G_DBUS_PRIVATE_H__
  22 #define __G_DBUS_PRIVATE_H__
  23
  24 #if !defined (GIO_COMPILATION)
  25 #error "gdbusprivate.h is a private header file."
  26 #endif
  27
  28 #include <gio/giotypes.h>
  29
  30 G_BEGIN_DECLS
  31
  32 /* ---------------------------------------------------------------------------------------------------- */
  33
  34 typedef struct GDBusWorker GDBusWorker;
  35
  36 typedef void (*GDBusWorkerMessageReceivedCallback) (GDBusMessage  *message,
  37                                                     gpointer       user_data);
  38
  39 typedef GDBusMessage *(*GDBusWorkerMessageAboutToBeSentCallback) (GDBusMessage  *message,
  40                                                                   gpointer       user_data);
  41
  42 typedef void (*GDBusWorkerDisconnectedCallback)    (gboolean       remote_peer_vanished,
  43                                                     GError        *error,
  44                                                     gpointer       user_data);
  45
  46 /* This function may be called from any thread - callbacks will be in the shared private message thread
  47  * and must not block.
  48  */
  49 GDBusWorker *_g_dbus_worker_new          (GIOStream                          *stream,
  50                                           GDBusCapabilityFlags                capabilities,
  51                                           gboolean                            initially_frozen,
  52                                           GDBusWorkerMessageReceivedCallback  message_received_callback,
  53                                           GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback,
  54                                           GDBusWorkerDisconnectedCallback     disconnected_callback,
  55                                           gpointer                            user_data);
  56
  57 /* can be called from any thread - steals blob */
  58 void         _g_dbus_worker_send_message (GDBusWorker    *worker,
  59                                           GDBusMessage   *message,
  60                                           gchar          *blob,
  61                                           gsize           blob_len);
  62
  63 /* can be called from any thread */
  64 void         _g_dbus_worker_stop         (GDBusWorker    *worker);
  65
  66 /* can be called from any thread */
  67 void         _g_dbus_worker_unfreeze     (GDBusWorker    *worker);
  68
  69 /* can be called from any thread (except the worker thread) */
  70 gboolean     _g_dbus_worker_flush_sync   (GDBusWorker    *worker,
  71                                           GCancellable   *cancellable,
  72                                           GError        **error);
  73
  74 /* can be called from any thread */
  75 void         _g_dbus_worker_close        (GDBusWorker         *worker,
  76                                           GTask               *task);
  77
  78 /* ---------------------------------------------------------------------------------------------------- */
  79
  80 void _g_dbus_initialize (void);
  81 gboolean _g_dbus_debug_authentication (void);
  82 gboolean _g_dbus_debug_transport (void);
  83 gboolean _g_dbus_debug_message (void);
  84 gboolean _g_dbus_debug_payload (void);
  85 gboolean _g_dbus_debug_call    (void);
  86 gboolean _g_dbus_debug_signal  (void);
  87 gboolean _g_dbus_debug_incoming (void);
  88 gboolean _g_dbus_debug_return (void);
  89 gboolean _g_dbus_debug_emission (void);
  90 gboolean _g_dbus_debug_address (void);
  91 gboolean _g_dbus_debug_proxy (void);
  92
  93 void     _g_dbus_debug_print_lock (void);
  94 void     _g_dbus_debug_print_unlock (void);
  95
  96 gboolean _g_dbus_address_parse_entry (const gchar  *address_entry,
  97                                       gchar       **out_transport_name,
  98                                       GHashTable  **out_key_value_pairs,
  99                                       GError      **error);
 100
 101 GVariantType * _g_dbus_compute_complete_signature (GDBusArgInfo **args);
 102
 103 gchar *_g_dbus_hexdump (const gchar *data, gsize len, guint indent);
 104
 105 /* ---------------------------------------------------------------------------------------------------- */
 106
 107 #ifdef G_OS_WIN32
 108 gchar *_g_dbus_win32_get_user_sid (void);
 109
 110 #define _GDBUS_ARG_WIN32_RUN_SESSION_BUS "_win32_run_session_bus"
 111 /* The g_win32_run_session_bus is exported from libgio dll on win32,
 112  * but still is NOT part of API/ABI since it is declared in private header
 113  * and used only by tool built from same sources.
 114  * Initially this function was introduces for usage with rundll,
 115  * so the signature is kept rundll-compatible, though parameters aren't used.
 116  */
 117 _GLIB_EXTERN void __stdcall
 118 g_win32_run_session_bus (void* hwnd, void* hinst, const char* cmdline, int cmdshow);
 119 gchar *_g_dbus_win32_get_session_address_dbus_launch (GError **error);
 120 #endif
 121
 122 gchar *_g_dbus_get_machine_id (GError **error);
 123
 124 gchar *_g_dbus_enum_to_string (GType enum_type, gint value);
 125
 126 /* ---------------------------------------------------------------------------------------------------- */
 127
 128 GDBusMethodInvocation *_g_dbus_method_invocation_new (const gchar             *sender,
 129                                                       const gchar             *object_path,
 130                                                       const gchar             *interface_name,
 131                                                       const gchar             *method_name,
 132                                                       const GDBusMethodInfo   *method_info,
 133                                                       const GDBusPropertyInfo *property_info,
 134                                                       GDBusConnection         *connection,
 135                                                       GDBusMessage            *message,
 136                                                       GVariant                *parameters,
 137                                                       gpointer                 user_data);
 138
 139 /* ---------------------------------------------------------------------------------------------------- */
 140
 141 gboolean _g_signal_accumulator_false_handled (GSignalInvocationHint *ihint,
 142                                               GValue                *return_accu,
 143                                               const GValue          *handler_return,
 144                                               gpointer               dummy);
 145
 146 gboolean _g_dbus_object_skeleton_has_authorize_method_handlers (GDBusObjectSkeleton *object);
 147
 148 void _g_dbus_object_proxy_add_interface (GDBusObjectProxy *proxy,
 149                                          GDBusProxy       *interface_proxy);
 150 void _g_dbus_object_proxy_remove_interface (GDBusObjectProxy *proxy,
 151                                             const gchar      *interface_name);
 152
 153 gchar *_g_dbus_hexencode (const gchar *str,
 154                           gsize        str_len);
 155
 156 /* Implemented in gdbusconnection.c */
 157 GDBusConnection *_g_bus_get_singleton_if_exists (GBusType bus_type);
 158 void             _g_bus_forget_singleton        (GBusType bus_type);
 159
 160 void g_dbus_message_init_header_iter (GDBusMessage   *message,
 161                                       GHashTableIter *iter);
 162
 163 GObject *
 164 g_dbus_address_get_stream_internal (const gchar   *address,
 165                                     gboolean       kdbus_okay,
 166                                     gchar        **out_uuid,
 167                                     GCancellable  *cancellable,
 168                                     GError       **error);
 169
 170
 171 G_END_DECLS
 172
 173 #endif /* __G_DBUS_PRIVATE_H__ */