os/ossrv/ossrv_pub/dbus/inc/dbus-message.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/* -*- mode: C; c-file-style: "gnu" -*- */
sl@0
     2
/* dbus-message.h DBusMessage object
sl@0
     3
 *
sl@0
     4
 * Copyright (C) 2002, 2003, 2005 Red Hat Inc.
sl@0
     5
 * Portion Copyright © 2008 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
sl@0
     6
 * Licensed under the Academic Free License version 2.1
sl@0
     7
 * 
sl@0
     8
 * This program is free software; you can redistribute it and/or modify
sl@0
     9
 * it under the terms of the GNU General Public License as published by
sl@0
    10
 * the Free Software Foundation; either version 2 of the License, or
sl@0
    11
 * (at your option) any later version.
sl@0
    12
 *
sl@0
    13
 * This program is distributed in the hope that it will be useful,
sl@0
    14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
sl@0
    15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
sl@0
    16
 * GNU General Public License for more details.
sl@0
    17
 * 
sl@0
    18
 * You should have received a copy of the GNU General Public License
sl@0
    19
 * along with this program; if not, write to the Free Software
sl@0
    20
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
sl@0
    21
 *
sl@0
    22
 */
sl@0
    23
#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
sl@0
    24
#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
sl@0
    25
#endif
sl@0
    26
sl@0
    27
#ifndef DBUS_MESSAGE_H
sl@0
    28
#define DBUS_MESSAGE_H
sl@0
    29
sl@0
    30
#include <dbus/dbus-macros.h>
sl@0
    31
#include <dbus/dbus-types.h>
sl@0
    32
#include "dbus/dbus-arch-deps.h"
sl@0
    33
#include <dbus/dbus-memory.h>
sl@0
    34
#include <dbus/dbus-errors.h>
sl@0
    35
#include <stdarg.h>
sl@0
    36
sl@0
    37
DBUS_BEGIN_DECLS
sl@0
    38
sl@0
    39
/**
sl@0
    40
 * @addtogroup DBusMessage
sl@0
    41
 * @{
sl@0
    42
 */
sl@0
    43
sl@0
    44
typedef struct DBusMessage DBusMessage;
sl@0
    45
/** Opaque type representing a message iterator. Can be copied by value, and contains no allocated memory so never needs to be freed and can be allocated on the stack. */
sl@0
    46
typedef struct DBusMessageIter DBusMessageIter;
sl@0
    47
sl@0
    48
/**
sl@0
    49
 * DBusMessageIter struct; contains no public fields. 
sl@0
    50
 */
sl@0
    51
struct DBusMessageIter
sl@0
    52
{ 
sl@0
    53
  void *dummy1;         /**< Don't use this */
sl@0
    54
  void *dummy2;         /**< Don't use this */
sl@0
    55
  dbus_uint32_t dummy3; /**< Don't use this */
sl@0
    56
  int dummy4;           /**< Don't use this */
sl@0
    57
  int dummy5;           /**< Don't use this */
sl@0
    58
  int dummy6;           /**< Don't use this */
sl@0
    59
  int dummy7;           /**< Don't use this */
sl@0
    60
  int dummy8;           /**< Don't use this */
sl@0
    61
  int dummy9;           /**< Don't use this */
sl@0
    62
  int dummy10;          /**< Don't use this */
sl@0
    63
  int dummy11;          /**< Don't use this */
sl@0
    64
  int pad1;             /**< Don't use this */
sl@0
    65
  int pad2;             /**< Don't use this */
sl@0
    66
  void *pad3;           /**< Don't use this */
sl@0
    67
};
sl@0
    68
sl@0
    69
#ifdef __SYMBIAN32__
sl@0
    70
IMPORT_C
sl@0
    71
#endif
sl@0
    72
DBusMessage* dbus_message_new               (int          message_type);
sl@0
    73
sl@0
    74
#ifdef __SYMBIAN32__
sl@0
    75
IMPORT_C
sl@0
    76
#endif
sl@0
    77
DBusMessage* dbus_message_new_method_call   (const char  *bus_name,
sl@0
    78
                                             const char  *path,
sl@0
    79
                                             const char  *interface,
sl@0
    80
                                             const char  *method);
sl@0
    81
sl@0
    82
#ifdef __SYMBIAN32__
sl@0
    83
IMPORT_C
sl@0
    84
#endif
sl@0
    85
DBusMessage* dbus_message_new_method_return (DBusMessage *method_call);
sl@0
    86
sl@0
    87
#ifdef __SYMBIAN32__
sl@0
    88
IMPORT_C
sl@0
    89
#endif
sl@0
    90
DBusMessage* dbus_message_new_signal        (const char  *path,
sl@0
    91
                                             const char  *interface,
sl@0
    92
                                             const char  *name);
sl@0
    93
#ifdef __SYMBIAN32__
sl@0
    94
IMPORT_C
sl@0
    95
#endif
sl@0
    96
DBusMessage* dbus_message_new_error         (DBusMessage *reply_to,
sl@0
    97
                                             const char  *error_name,
sl@0
    98
                                             const char  *error_message);
sl@0
    99
                                             
sl@0
   100
#ifdef __SYMBIAN32__
sl@0
   101
IMPORT_C
sl@0
   102
#endif
sl@0
   103
DBusMessage* dbus_message_new_error_printf  (DBusMessage *reply_to,
sl@0
   104
                                             const char  *error_name,
sl@0
   105
                                             const char  *error_format,
sl@0
   106
					     ...);
sl@0
   107
sl@0
   108
#ifdef __SYMBIAN32__
sl@0
   109
IMPORT_C
sl@0
   110
#endif
sl@0
   111
DBusMessage* dbus_message_copy              (const DBusMessage *message);
sl@0
   112
sl@0
   113
#ifdef __SYMBIAN32__
sl@0
   114
IMPORT_C
sl@0
   115
#endif
sl@0
   116
DBusMessage*  dbus_message_ref              (DBusMessage   *message);
sl@0
   117
sl@0
   118
#ifdef __SYMBIAN32__
sl@0
   119
IMPORT_C
sl@0
   120
#endif
sl@0
   121
void          dbus_message_unref            (DBusMessage   *message);
sl@0
   122
sl@0
   123
#ifdef __SYMBIAN32__
sl@0
   124
IMPORT_C
sl@0
   125
#endif
sl@0
   126
int           dbus_message_get_type         (DBusMessage   *message);
sl@0
   127
sl@0
   128
#ifdef __SYMBIAN32__
sl@0
   129
IMPORT_C
sl@0
   130
#endif
sl@0
   131
dbus_bool_t   dbus_message_set_path         (DBusMessage   *message,
sl@0
   132
                                             const char    *object_path);
sl@0
   133
#ifdef __SYMBIAN32__
sl@0
   134
IMPORT_C
sl@0
   135
#endif
sl@0
   136
const char*   dbus_message_get_path         (DBusMessage   *message);
sl@0
   137
sl@0
   138
#ifdef __SYMBIAN32__
sl@0
   139
IMPORT_C
sl@0
   140
#endif
sl@0
   141
dbus_bool_t   dbus_message_has_path         (DBusMessage   *message, 
sl@0
   142
                                             const char    *object_path);  
sl@0
   143
#ifdef __SYMBIAN32__
sl@0
   144
IMPORT_C
sl@0
   145
#endif
sl@0
   146
dbus_bool_t   dbus_message_set_interface    (DBusMessage   *message,
sl@0
   147
                                             const char    *interface);       
sl@0
   148
sl@0
   149
#ifdef __SYMBIAN32__
sl@0
   150
IMPORT_C
sl@0
   151
#endif
sl@0
   152
const char*   dbus_message_get_interface    (DBusMessage   *message);
sl@0
   153
sl@0
   154
#ifdef __SYMBIAN32__
sl@0
   155
IMPORT_C
sl@0
   156
#endif
sl@0
   157
dbus_bool_t   dbus_message_has_interface    (DBusMessage   *message, 
sl@0
   158
                                             const char    *interface);
sl@0
   159
#ifdef __SYMBIAN32__
sl@0
   160
IMPORT_C
sl@0
   161
#endif
sl@0
   162
dbus_bool_t   dbus_message_set_member       (DBusMessage   *message,
sl@0
   163
                                             const char    *member);
sl@0
   164
sl@0
   165
#ifdef __SYMBIAN32__
sl@0
   166
IMPORT_C
sl@0
   167
#endif
sl@0
   168
const char*   dbus_message_get_member       (DBusMessage   *message);
sl@0
   169
sl@0
   170
#ifdef __SYMBIAN32__
sl@0
   171
IMPORT_C
sl@0
   172
#endif
sl@0
   173
dbus_bool_t   dbus_message_has_member       (DBusMessage   *message, 
sl@0
   174
                                             const char    *member);
sl@0
   175
#ifdef __SYMBIAN32__
sl@0
   176
IMPORT_C
sl@0
   177
#endif
sl@0
   178
dbus_bool_t   dbus_message_set_error_name   (DBusMessage   *message,
sl@0
   179
                                             const char    *name);
sl@0
   180
#ifdef __SYMBIAN32__
sl@0
   181
IMPORT_C
sl@0
   182
#endif
sl@0
   183
const char*   dbus_message_get_error_name   (DBusMessage   *message);
sl@0
   184
#ifdef __SYMBIAN32__
sl@0
   185
IMPORT_C
sl@0
   186
#endif
sl@0
   187
dbus_bool_t   dbus_message_set_destination  (DBusMessage   *message,
sl@0
   188
                                             const char    *destination);
sl@0
   189
#ifdef __SYMBIAN32__
sl@0
   190
IMPORT_C
sl@0
   191
#endif
sl@0
   192
const char*   dbus_message_get_destination  (DBusMessage   *message);
sl@0
   193
sl@0
   194
#ifdef __SYMBIAN32__
sl@0
   195
IMPORT_C
sl@0
   196
#endif
sl@0
   197
dbus_bool_t   dbus_message_set_sender       (DBusMessage   *message,
sl@0
   198
                                             const char    *sender);
sl@0
   199
#ifdef __SYMBIAN32__
sl@0
   200
IMPORT_C
sl@0
   201
#endif
sl@0
   202
const char*   dbus_message_get_sender       (DBusMessage   *message);
sl@0
   203
sl@0
   204
#ifdef __SYMBIAN32__
sl@0
   205
IMPORT_C
sl@0
   206
#endif
sl@0
   207
const char*   dbus_message_get_signature    (DBusMessage   *message);
sl@0
   208
sl@0
   209
#ifdef __SYMBIAN32__
sl@0
   210
IMPORT_C
sl@0
   211
#endif
sl@0
   212
void          dbus_message_set_no_reply     (DBusMessage   *message,
sl@0
   213
                                             dbus_bool_t    no_reply);
sl@0
   214
#ifdef __SYMBIAN32__
sl@0
   215
IMPORT_C
sl@0
   216
#endif
sl@0
   217
dbus_bool_t   dbus_message_get_no_reply     (DBusMessage   *message);
sl@0
   218
sl@0
   219
#ifdef __SYMBIAN32__
sl@0
   220
IMPORT_C
sl@0
   221
#endif
sl@0
   222
dbus_bool_t   dbus_message_is_method_call   (DBusMessage   *message,
sl@0
   223
                                             const char    *interface,
sl@0
   224
                                             const char    *method);
sl@0
   225
#ifdef __SYMBIAN32__
sl@0
   226
IMPORT_C
sl@0
   227
#endif
sl@0
   228
dbus_bool_t   dbus_message_is_signal        (DBusMessage   *message,
sl@0
   229
                                             const char    *interface,
sl@0
   230
                                             const char    *signal_name);
sl@0
   231
                                             
sl@0
   232
#ifdef __SYMBIAN32__
sl@0
   233
IMPORT_C
sl@0
   234
#endif
sl@0
   235
dbus_bool_t   dbus_message_is_error         (DBusMessage   *message,
sl@0
   236
                                             const char    *error_name);
sl@0
   237
#ifdef __SYMBIAN32__
sl@0
   238
IMPORT_C
sl@0
   239
#endif
sl@0
   240
dbus_bool_t   dbus_message_has_destination  (DBusMessage   *message,
sl@0
   241
                                             const char    *bus_name);
sl@0
   242
#ifdef __SYMBIAN32__
sl@0
   243
IMPORT_C
sl@0
   244
#endif
sl@0
   245
dbus_bool_t   dbus_message_has_sender       (DBusMessage   *message,
sl@0
   246
                                             const char    *unique_bus_name);
sl@0
   247
#ifdef __SYMBIAN32__
sl@0
   248
IMPORT_C
sl@0
   249
#endif
sl@0
   250
dbus_bool_t   dbus_message_has_signature    (DBusMessage   *message,
sl@0
   251
                                             const char    *signature);
sl@0
   252
#ifdef __SYMBIAN32__
sl@0
   253
IMPORT_C 
sl@0
   254
#endif
sl@0
   255
dbus_uint32_t dbus_message_get_serial       (DBusMessage   *message);
sl@0
   256
#ifdef __SYMBIAN32__
sl@0
   257
IMPORT_C
sl@0
   258
#endif
sl@0
   259
dbus_bool_t   dbus_message_set_reply_serial (DBusMessage   *message,
sl@0
   260
                                             dbus_uint32_t  reply_serial);
sl@0
   261
sl@0
   262
#ifdef __SYMBIAN32__
sl@0
   263
IMPORT_C
sl@0
   264
#endif
sl@0
   265
dbus_uint32_t dbus_message_get_reply_serial (DBusMessage   *message);
sl@0
   266
sl@0
   267
#ifdef __SYMBIAN32__
sl@0
   268
IMPORT_C
sl@0
   269
#endif
sl@0
   270
void          dbus_message_set_auto_start   (DBusMessage   *message,
sl@0
   271
                                             dbus_bool_t    auto_start);
sl@0
   272
#ifdef __SYMBIAN32__
sl@0
   273
IMPORT_C
sl@0
   274
#endif
sl@0
   275
dbus_bool_t   dbus_message_get_auto_start   (DBusMessage   *message);
sl@0
   276
sl@0
   277
#ifdef __SYMBIAN32__
sl@0
   278
IMPORT_C
sl@0
   279
#endif
sl@0
   280
dbus_bool_t   dbus_message_get_path_decomposed (DBusMessage   *message,
sl@0
   281
                                                char        ***path);
sl@0
   282
sl@0
   283
#ifdef __SYMBIAN32__
sl@0
   284
IMPORT_C
sl@0
   285
#endif
sl@0
   286
dbus_bool_t dbus_message_append_args          (DBusMessage     *message,
sl@0
   287
					       int              first_arg_type,
sl@0
   288
					       ...);
sl@0
   289
#ifdef __SYMBIAN32__
sl@0
   290
IMPORT_C
sl@0
   291
#endif
sl@0
   292
dbus_bool_t dbus_message_append_args_valist   (DBusMessage     *message,
sl@0
   293
					       int              first_arg_type,
sl@0
   294
					       va_list          var_args);
sl@0
   295
sl@0
   296
#ifdef __SYMBIAN32__
sl@0
   297
IMPORT_C
sl@0
   298
#endif
sl@0
   299
dbus_bool_t dbus_message_get_args             (DBusMessage     *message,
sl@0
   300
					       DBusError       *error,
sl@0
   301
					       int              first_arg_type,
sl@0
   302
					       ...);
sl@0
   303
#ifdef __SYMBIAN32__
sl@0
   304
IMPORT_C
sl@0
   305
#endif
sl@0
   306
dbus_bool_t dbus_message_get_args_valist      (DBusMessage     *message,
sl@0
   307
					       DBusError       *error,
sl@0
   308
					       int              first_arg_type,
sl@0
   309
					       va_list          var_args);
sl@0
   310
sl@0
   311
sl@0
   312
#ifdef __SYMBIAN32__
sl@0
   313
IMPORT_C
sl@0
   314
#endif
sl@0
   315
dbus_bool_t dbus_message_iter_init             (DBusMessage     *message,
sl@0
   316
                                                DBusMessageIter *iter);
sl@0
   317
                                                
sl@0
   318
#ifdef __SYMBIAN32__
sl@0
   319
IMPORT_C
sl@0
   320
#endif
sl@0
   321
dbus_bool_t dbus_message_iter_has_next         (DBusMessageIter *iter);
sl@0
   322
sl@0
   323
#ifdef __SYMBIAN32__
sl@0
   324
IMPORT_C
sl@0
   325
#endif
sl@0
   326
dbus_bool_t dbus_message_iter_next             (DBusMessageIter *iter);
sl@0
   327
sl@0
   328
#ifdef __SYMBIAN32__
sl@0
   329
IMPORT_C
sl@0
   330
#endif
sl@0
   331
char*       dbus_message_iter_get_signature    (DBusMessageIter *iter);
sl@0
   332
sl@0
   333
#ifdef __SYMBIAN32__
sl@0
   334
IMPORT_C
sl@0
   335
#endif
sl@0
   336
int         dbus_message_iter_get_arg_type     (DBusMessageIter *iter);
sl@0
   337
sl@0
   338
#ifdef __SYMBIAN32__
sl@0
   339
IMPORT_C
sl@0
   340
#endif
sl@0
   341
int         dbus_message_iter_get_element_type (DBusMessageIter *iter);
sl@0
   342
sl@0
   343
#ifdef __SYMBIAN32__
sl@0
   344
IMPORT_C
sl@0
   345
#endif
sl@0
   346
void        dbus_message_iter_recurse          (DBusMessageIter *iter,
sl@0
   347
                                                DBusMessageIter *sub);
sl@0
   348
#ifdef __SYMBIAN32__
sl@0
   349
IMPORT_C
sl@0
   350
#endif
sl@0
   351
void        dbus_message_iter_get_basic        (DBusMessageIter *iter,
sl@0
   352
                                                void            *value);
sl@0
   353
                                                
sl@0
   354
#ifndef DBUS_DISABLE_DEPRECATED
sl@0
   355
/* This function returns the wire protocol size of the array in bytes,
sl@0
   356
 * you do not want to know that probably
sl@0
   357
 */
sl@0
   358
sl@0
   359
#ifdef __SYMBIAN32__
sl@0
   360
IMPORT_C
sl@0
   361
#endif
sl@0
   362
int         dbus_message_iter_get_array_len    (DBusMessageIter *iter) DBUS_GNUC_DEPRECATED;
sl@0
   363
#endif
sl@0
   364
sl@0
   365
#ifdef __SYMBIAN32__
sl@0
   366
IMPORT_C
sl@0
   367
#endif
sl@0
   368
void        dbus_message_iter_get_fixed_array  (DBusMessageIter *iter,
sl@0
   369
                                                void            *value,
sl@0
   370
                                                int             *n_elements);
sl@0
   371
sl@0
   372
#ifdef __SYMBIAN32__
sl@0
   373
IMPORT_C
sl@0
   374
#endif
sl@0
   375
void        dbus_message_iter_init_append        (DBusMessage     *message,
sl@0
   376
                                                  DBusMessageIter *iter);
sl@0
   377
#ifdef __SYMBIAN32__
sl@0
   378
IMPORT_C
sl@0
   379
#endif
sl@0
   380
dbus_bool_t dbus_message_iter_append_basic       (DBusMessageIter *iter,
sl@0
   381
                                                  int              type,
sl@0
   382
                                                  const void      *value);
sl@0
   383
#ifdef __SYMBIAN32__
sl@0
   384
IMPORT_C
sl@0
   385
#endif
sl@0
   386
dbus_bool_t dbus_message_iter_append_fixed_array (DBusMessageIter *iter,
sl@0
   387
                                                  int              element_type,
sl@0
   388
                                                  const void      *value,
sl@0
   389
                                                  int              n_elements);
sl@0
   390
#ifdef __SYMBIAN32__
sl@0
   391
IMPORT_C
sl@0
   392
#endif
sl@0
   393
dbus_bool_t dbus_message_iter_open_container     (DBusMessageIter *iter,
sl@0
   394
                                                  int              type,
sl@0
   395
                                                  const char      *contained_signature,
sl@0
   396
                                                  DBusMessageIter *sub);
sl@0
   397
#ifdef __SYMBIAN32__
sl@0
   398
IMPORT_C
sl@0
   399
#endif
sl@0
   400
dbus_bool_t dbus_message_iter_close_container    (DBusMessageIter *iter,
sl@0
   401
                                                  DBusMessageIter *sub);
sl@0
   402
sl@0
   403
sl@0
   404
#ifdef __SYMBIAN32__
sl@0
   405
IMPORT_C
sl@0
   406
#endif
sl@0
   407
dbus_bool_t  dbus_set_error_from_message  (DBusError    *error,
sl@0
   408
                                           DBusMessage  *message);
sl@0
   409
sl@0
   410
sl@0
   411
#ifdef __SYMBIAN32__
sl@0
   412
IMPORT_C
sl@0
   413
#endif
sl@0
   414
dbus_bool_t dbus_message_allocate_data_slot (dbus_int32_t     *slot_p);
sl@0
   415
#ifdef __SYMBIAN32__
sl@0
   416
IMPORT_C
sl@0
   417
#endif
sl@0
   418
void        dbus_message_free_data_slot     (dbus_int32_t     *slot_p);
sl@0
   419
#ifdef __SYMBIAN32__
sl@0
   420
IMPORT_C
sl@0
   421
#endif
sl@0
   422
dbus_bool_t dbus_message_set_data           (DBusMessage      *message,
sl@0
   423
                                             dbus_int32_t      slot,
sl@0
   424
                                             void             *data,
sl@0
   425
                                             DBusFreeFunction  free_data_func);
sl@0
   426
#ifdef __SYMBIAN32__
sl@0
   427
IMPORT_C
sl@0
   428
#endif
sl@0
   429
void*       dbus_message_get_data           (DBusMessage      *message,
sl@0
   430
                                             dbus_int32_t      slot);
sl@0
   431
sl@0
   432
#ifdef __SYMBIAN32__
sl@0
   433
IMPORT_C
sl@0
   434
#endif
sl@0
   435
int dbus_message_type_from_string (const char *type_str);
sl@0
   436
#ifdef __SYMBIAN32__
sl@0
   437
IMPORT_C
sl@0
   438
#endif
sl@0
   439
const char * dbus_message_type_to_string (int type);
sl@0
   440
sl@0
   441
/** @} */
sl@0
   442
sl@0
   443
DBUS_END_DECLS
sl@0
   444
sl@0
   445
#endif /* DBUS_MESSAGE_H */