easydbus.h

Go to the documentation of this file.

/*
 EasyDbus: DBus Binding Library
 Copyright (C) 2007  Daniele Rondina aka ge@@ru, geaaru@gmail.com 

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

  Filename:  easydbus.h
 
  Description:  
 
  Version:  0.1
  Created:  06/07/07 19:43:40 CEST
  Revision:  none
 
  Author:   Daniele Rondina aka Ge@@ru (geaaru@gmail.com) 
  License:  GPL 2.0
*/

#ifndef EASYDBUS_H
#define EASYDBUS_H

#   ifdef __cplusplus
extern "C" {
#   endif

enum el_type {
  EASYDBUS_ELTYPE_INVALID,
  EASYDBUS_ELTYPE_STRING,
  EASYDBUS_ELTYPE_ARRAY,
  EASYDBUS_ELTYPE_BYTE,
  EASYDBUS_ELTYPE_BOOLEAN,
  EASYDBUS_ELTYPE_DOUBLE,
  EASYDBUS_ELTYPE_INT16,
  EASYDBUS_ELTYPE_UINT16,
  EASYDBUS_ELTYPE_INT32,
  EASYDBUS_ELTYPE_UINT32,
  EASYDBUS_ELTYPE_INT64,
  EASYDBUS_ELTYPE_UINT64,
  EASYDBUS_ELTYPE_OBJECT_PATH,
  EASYDBUS_ELTYPE_SIGNATURE,
  EASYDBUS_ELTYPE_STRUCT,
  EASYDBUS_ELTYPE_VARIANT,
  EASYDBUS_ELTYPE_DICT_ENTRY /* dict entry are only
                                valids on arrays. */
};

enum event_type {
  EASYDBUS_ET_INVALID,
  EASYDBUS_ET_METHOD,
  EASYDBUS_ET_SIGNAL,
  EASYDBUS_ET_REPLY,
  EASYDBUS_ET_FAILURE,
};

enum easydbus_bus {
  EASYDBUS_INVALID,
  EASYDBUS_SESSION,
  EASYDBUS_SYSTEM,
  EASYDBUS_SESSION_SERVER,
  EASYDBUS_SYSTEM_SERVER,
  EASYDBUS_LOCAL
};

enum easydbus_watcher_flags {
   EASYDBUS_WATCHER_INVALID = 0,
   EASYDBUS_WATCHER_WRITABLE = 1,
   EASYDBUS_WATCHER_READABLE = 2,
   EASYDBUS_WATCHER_ERROR = 4,
   EASYDBUS_WATCHER_HANGUP = 8
};

enum easydbus_connection_flags {
  EASYDBUS_CONN_DEFAULT = 0,
  EASYDBUS_CONN_PRIVATE = 1,
  // dbus flags binding
  EASYDBUS_CONN_ALLOW_REPLACEMENT = 2,
  EASYDBUS_CONN_REPLACE_EXISTING = 4,
  EASYDBUS_CONN_DO_NOT_QUEUE = 8,
  // this flag permit to renamed service
  // to "name_service"+n--> "name_service1", "name_service2", etc.
  // if also EASYDBUS_CONN_DO_NOT_QUEUE is used.
  EASYDBUS_CONN_NAME_SERVICE_RENAMED = 16,
  // connection status
  EASYDBUS_CONN_NAME_SERVICE_EXISTS = 32,
  EASYDBUS_CONN_NAME_SERVICE_IN_QUEUE = 64,
  EASYDBUS_CONN_NAME_SERVICE_PRIMARY = 128,
  // enable setting dbus unique name (under testing, seems create a memory leak)
  EASYDBUS_CONN_NAME_UNIQUE = 256
};

enum easydbus_ret_values {
  EASYDBUS_SIGNAL_HANDLED,
  EASYDBUS_SIGNAL_NOT_HANDLED,
  EASYDBUS_SIGNAL_MSG_NULL,
  EASYDBUS_SIGNAL_SENT,
  EASYDBUS_SIGNAL_NOT_SENT,
  EASYDBUS_SIGNAL_NOT_FOUND, // for manage signal that 
  // aren't present
  EASYDBUS_METHOD_NOT_SENT,
  EASYDBUS_METHOD_SENT,
  EASYDBUS_METHOD_HANDLED,
  EASYDBUS_METHOD_NOT_HANDLED,
  EASYDBUS_METHOD_MSG_NULL,
  EASYDBUS_METHOD_NOT_FOUND, // for manage call on method
  // that aren't present
  EASYDBUS_FAILURE_HANDLED,
  EASYDBUS_METHOD_RETURN_HANDLED,
  EASYDBUS_NEED_MEMORY,
  EASYDBUS_ERROR
};

// EasyDbus struct are now opaque
typedef struct EasyDbus_conn EasyDbus_conn;
typedef struct EasyDbus_container EasyDbus_container;
typedef struct EasyDbus_elem EasyDbus_elem;
typedef struct EasyDbus_signal EasyDbus_signal;
typedef struct EasyDbus_reply EasyDbus_reply;
typedef struct EasyDbus_method EasyDbus_method;

typedef void (*easydbus_method_async_reply_cb_f) (EasyDbus_conn *, 
                                                  EasyDbus_method *, void *);

typedef void (*easydbus_reply_async_cb_f) (EasyDbus_conn *,
                                           EasyDbus_method *, void *);

typedef void (*easydbus_error_message_cb_f) (EasyDbus_conn *, 
                                             const EasyDbus_reply *, 
                                             void *);

typedef void (*easydbus_reply_message_cb_f) (EasyDbus_conn *, 
                                             const EasyDbus_method *, 
                                             void *);


#   include <easydbus/elem.h>
#   include <easydbus/variant.h>
#   include <easydbus/dict_entry.h>
#   include <easydbus/skeleton.h>
#   include <easydbus/array.h>
#   include <easydbus/struct.h>
#   include <easydbus/monitor.h>

void 
easydbus_init (void);

inline void 
easydbus_deinit (void);

/* about connections */
int
easydbus_conn_destroy (EasyDbus_conn *);

EasyDbus_conn *
easydbus_conn_create (void);

int 
easydbus_conn_get_address (EasyDbus_conn *,
                           char *, enum easydbus_bus,
                           int);

inline int
easydbus_conn_get_system_service_address (EasyDbus_conn *, 
                                          char *);

const char *
easydbus_conn_get_service_name (const EasyDbus_conn *);


inline int 
easydbus_conn_add_match_rule (EasyDbus_conn *,
                              enum event_type, char *,
                              char *, char *, 
                              char *, char *);

inline int 
easydbus_conn_remove_match_rule (EasyDbus_conn *,
                                 enum event_type, char *,
                                 char *, char *,
                                 char *, char *);

int
easydbus_conn_reconnect (EasyDbus_conn *, int);

int
easydbus_conn_set_reply_async_cb (EasyDbus_conn *,
                                  easydbus_reply_async_cb_f,
                                  void *);

int
easydbus_conn_set_error_message_cb (EasyDbus_conn *,
                                    easydbus_error_message_cb_f,
                                    void *);

int
easydbus_conn_set_reply_message_cb (EasyDbus_conn *,
                                    easydbus_reply_message_cb_f);

int
easydbus_conn_get_fd (EasyDbus_conn *);

int 
easydbus_conn_enable_filters (EasyDbus_conn *);

int 
easydbus_conn_disable_filters (EasyDbus_conn *);

void 
easydbus_conn_set_closure (EasyDbus_conn *, void *);

void *
easydbus_conn_get_closure (EasyDbus_conn *);

int 
easydbus_start_service (EasyDbus_conn *, char *);

#   ifdef TOFILE_DEBUG
   int 
   easydbus_init_logger (char *);

   void 
   easydbus_deinit_logger (void);
#   endif

#   ifdef __cplusplus
   extern "C" {
#   endif

#endif
// vim: ts=3 shiftwidth=3 expandtab

---