dbus/dbus-message.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-message.h  DBusMessage object
   3  *
   4  * Copyright (C) 2002  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
  24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
  25 #endif
  26
  27 #ifndef DBUS_MESSAGE_H
  28 #define DBUS_MESSAGE_H
  29
  30 #include <dbus/dbus-macros.h>
  31
  32 DBUS_BEGIN_DECLS
  33
  34 /**
  35  * @defgroup Message
  36  * @ingroup  DBus
  37  * @brief Message handling.
  38  *
  39  * This functions deal with message structure
  40  * within DBus.
  41  *
  42  * @{
  43  */
  44
  45 typedef struct DBusMessage DBusMessage;
  46
  47 /**
  48  * Constructs a new DBus message.
  49  * @return New DBusMessage
  50  */
  51 DBusMessage* dbus_message_new   (void);
  52
  53 /**
  54  * Increments a reference count on a message.
  55  *
  56  * @arg message It's the message whose reference count we're incrementing
  57  * @see dbus_message_unref
  58  */
  59 void         dbus_message_ref   (DBusMessage *message);
  60
  61 /**
  62  * Decrements a reference count on a message.
  63  *
  64  * @arg message It's the message whose reference count we're decrementing
  65  */
  66 void         dbus_message_unref (DBusMessage *message);
  67
  68
  69 /** @} */
  70
  71 DBUS_END_DECLS
  72
  73 #endif /* DBUS_MESSAGE_H */