dbus/dbus-message-internal.h

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-message-internal.h DBusMessage object internal interfaces
   3  *
   4  * Copyright (C) 2002  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  *
  22  */
  23 #ifndef DBUS_MESSAGE_INTERNAL_H
  24 #define DBUS_MESSAGE_INTERNAL_H
  25
  26 #include <dbus/dbus-marshal-validate.h>
  27 #include <dbus/dbus-message.h>
  28 #include <dbus/dbus-resources.h>
  29 #include <dbus/dbus-list.h>
  30
  31 DBUS_BEGIN_DECLS
  32
  33 #ifdef DBUS_ENABLE_VERBOSE_MODE
  34 void _dbus_message_trace_ref (DBusMessage *message,
  35                               int          old_refcount,
  36                               int          new_refcount,
  37                               const char  *why);
  38 #else
  39 /* this bypasses any "unused" warnings for the old and new refcount */
  40 #define _dbus_message_trace_ref(m, o, n, w) \
  41   do \
  42   {\
  43     (void) (o); \
  44     (void) (n); \
  45   } while (0)
  46 #endif
  47
  48 typedef struct DBusMessageLoader DBusMessageLoader;
  49
  50 void _dbus_message_get_network_data  (DBusMessage       *message,
  51                                       const DBusString **header,
  52                                       const DBusString **body);
  53 void _dbus_message_set_timeout_ms(DBusMessage *message, int timeout_ms);
  54 int _dbus_message_get_timeout_ms(DBusMessage const *message);
  55 DBUS_PRIVATE_EXPORT
  56 void _dbus_message_get_unix_fds      (DBusMessage *message,
  57                                       const int **fds,
  58                                       unsigned *n_fds);
  59
  60 unsigned int _dbus_message_get_n_unix_fds       (DBusMessage  *message);
  61 void        _dbus_message_lock                  (DBusMessage  *message);
  62 void        _dbus_message_unlock                (DBusMessage  *message);
  63 dbus_bool_t _dbus_message_add_counter           (DBusMessage  *message,
  64                                                  DBusCounter  *counter);
  65 void        _dbus_message_add_counter_link      (DBusMessage  *message,
  66                                                  DBusList     *link);
  67 void        _dbus_message_remove_counter        (DBusMessage  *message,
  68                                                  DBusCounter  *counter);
  69
  70 DBUS_PRIVATE_EXPORT
  71 DBusMessageLoader* _dbus_message_loader_new                   (void);
  72 DBUS_PRIVATE_EXPORT
  73 DBusMessageLoader* _dbus_message_loader_ref                   (DBusMessageLoader  *loader);
  74 DBUS_PRIVATE_EXPORT
  75 void               _dbus_message_loader_unref                 (DBusMessageLoader  *loader);
  76
  77 DBUS_PRIVATE_EXPORT
  78 void               _dbus_message_loader_get_buffer            (DBusMessageLoader  *loader,
  79                                                                DBusString        **buffer,
  80                                                                int                *max_to_read,
  81                                                                dbus_bool_t        *may_read_unix_fds);
  82 DBUS_PRIVATE_EXPORT
  83 void               _dbus_message_loader_return_buffer         (DBusMessageLoader  *loader,
  84                                                                DBusString         *buffer);
  85
  86
  87 #ifdef HAVE_UNIX_FD_PASSING
  88 DBUS_PRIVATE_EXPORT
  89 dbus_bool_t        _dbus_message_loader_get_unix_fds          (DBusMessageLoader  *loader,
  90                                                                int               **fds,
  91                                                                unsigned           *max_n_fds);
  92
  93 DBUS_PRIVATE_EXPORT
  94 void               _dbus_message_loader_return_unix_fds       (DBusMessageLoader  *loader,
  95                                                                int                *fds,
  96                                                                unsigned            n_fds);
  97 #endif
  98
  99 DBUS_PRIVATE_EXPORT
 100 dbus_bool_t        _dbus_message_loader_queue_messages        (DBusMessageLoader  *loader);
 101 DBusMessage*       _dbus_message_loader_peek_message          (DBusMessageLoader  *loader);
 102 DBUS_PRIVATE_EXPORT
 103 DBusMessage*       _dbus_message_loader_pop_message           (DBusMessageLoader  *loader);
 104 DBusList*          _dbus_message_loader_pop_message_link      (DBusMessageLoader  *loader);
 105 void               _dbus_message_loader_putback_message_link  (DBusMessageLoader  *loader,
 106                                                                DBusList           *link);
 107
 108 DBUS_PRIVATE_EXPORT
 109 dbus_bool_t        _dbus_message_loader_get_is_corrupted      (DBusMessageLoader  *loader);
 110 DBusValidity       _dbus_message_loader_get_corruption_reason (DBusMessageLoader  *loader);
 111
 112 void               _dbus_message_loader_set_max_message_size  (DBusMessageLoader  *loader,
 113                                                                long                size);
 114 DBUS_PRIVATE_EXPORT
 115 long               _dbus_message_loader_get_max_message_size  (DBusMessageLoader  *loader);
 116
 117 void               _dbus_message_loader_set_max_message_unix_fds(DBusMessageLoader  *loader,
 118                                                                  long                n);
 119 long               _dbus_message_loader_get_max_message_unix_fds(DBusMessageLoader  *loader);
 120 int                _dbus_message_loader_get_pending_fds_count (DBusMessageLoader  *loader);
 121 void               _dbus_message_loader_set_pending_fds_function (DBusMessageLoader *loader,
 122                                                                   void (* callback) (void *),
 123                                                                   void *data);
 124 void               _dbus_message_loader_set_unique_sender_id (DBusMessageLoader *loader,
 125                                                               uint64_t           id);
 126 uint64_t           _dbus_message_loader_get_unique_sender_id (DBusMessageLoader *loader);
 127
 128 typedef struct DBusVariant DBusVariant;
 129 DBUS_PRIVATE_EXPORT
 130 DBusVariant       *_dbus_variant_read                            (DBusMessageIter *reader);
 131 DBUS_PRIVATE_EXPORT
 132 dbus_bool_t        _dbus_variant_write                           (DBusVariant *self,
 133                                                                   DBusMessageIter *writer);
 134 DBUS_PRIVATE_EXPORT
 135 void               _dbus_variant_free                            (DBusVariant *self);
 136 DBUS_PRIVATE_EXPORT
 137 int                _dbus_variant_get_length                      (DBusVariant *self);
 138 DBUS_PRIVATE_EXPORT
 139 const DBusString  *_dbus_variant_peek                            (DBusVariant *self);
 140 DBUS_PRIVATE_EXPORT
 141 const char        *_dbus_variant_get_signature                   (DBusVariant *self);
 142
 143 static inline void
 144 _dbus_clear_variant (DBusVariant **variant_p)
 145 {
 146   _dbus_clear_pointer_impl (DBusVariant, variant_p, _dbus_variant_free);
 147 }
 148
 149 typedef struct DBusInitialFDs DBusInitialFDs;
 150 DBusInitialFDs *_dbus_check_fdleaks_enter (void);
 151 void            _dbus_check_fdleaks_leave (DBusInitialFDs *fds);
 152
 153 DBusMessage *      _dbus_message_remarshal(DBusMessage *message, dbus_bool_t gvariant);
 154
 155 DBusMessage *      _dbus_decode_kmsg                            (DBusString  *data,
 156                                                                  uint64_t     sender_id,
 157                                                                  int         *fds,
 158                                                                  unsigned     n_fds);
 159
 160 DBusMessage *      _dbus_generate_local_error_message           (dbus_uint32_t serial,
 161                                                                  const char *error_name,
 162                                                                  const char *error_msg);
 163
 164 dbus_bool_t       _dbus_message_assure_dbus1                    (DBusMessage **message);
 165 dbus_bool_t       _dbus_message_assure_gvariant                 (DBusMessage **message);
 166
 167 void              _dbus_on_new_bus                              (int type);
 168
 169 DBUS_END_DECLS
 170
 171 #endif /* DBUS_MESSAGE_INTERNAL_H */