internal.h

Go to the documentation of this file.

#ifndef INTERNAL_H_
#define INTERNAL_H_

/**
 * @addtogroup eripc
 * @{
 * @file internal.h
 * @brief This file contains internal definitions.
 */
 
/*
 * This file is part of liberipc.
 *
 * liberipc 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.
 *
 * liberipc 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, see <http://www.gnu.org/licenses/>.
 */

/**
 * Copyright (C) 2008 iRex Technologies B.V. 
 * All rights reserved.
 *
 * Based on code found in libosso library by Kimmo Hämäläinen <kimmo.hamalainen@nokia.com>
 */

#define DBUS_API_SUBJECT_TO_CHANGE

#ifdef HAVE_CONFIG_H
# include <config.h>
#endif

#include <stdio.h>
#include <stdarg.h>
#include <string.h>
#include <malloc.h>

#include <dbus/dbus.h>
#include <dbus/dbus-glib-lowlevel.h>

#include "log.h"
#include "eripc.h"

#define OSSO_BUS_ROOT          "com.irexnet"
#define OSSO_BUS_ROOT_PATH     "/com/irexnet"

#define ERIPC_PATH_MATCH_ALL "eripc_path_match_all"
#define ERIPC_MEMBER_MATCH_ALL "eripc_member_match_all"

/* DBus interface, service, and object path maximum lengths */
#define MAX_IF_LEN 255
#define MAX_SVC_LEN 255
#define MAX_OP_LEN 255
#define MAX_MEMBER_LEN 255
#define MAX_ERROR_LEN 255
#define MAX_HASH_KEY_LEN (MAX_IF_LEN + MAX_SVC_LEN + MAX_OP_LEN)
#define MAX_OPM_HASH_KEY_LEN (MAX_OP_LEN + MAX_MEMBER_LEN)
#define MAX_MSGID_LEN (MAX_SVC_LEN + 20 + 20 + 2)

#define MAX_APP_NAME_LEN 50
#define MAX_VERSION_LEN 30

#define ERIPC_MAX_ARGS 256
#define ERIPC_MAX_MATCH_SIZE 256

/* data given by the library user */
typedef struct {
    gpointer user_cb;

    gpointer user_data;
    const char *match_rule;
    gpointer data;
    eripc_event_t event_type;
    eripc_bus_t bus_type;
    unsigned int message_id;

    char *service;    /* service name or NULL */
    char *path;       /* object path or NULL */
    char *interface;  /* interface name or NULL */
    char *name;       /* name of message/signal or NULL */

} _osso_callback_data_t;

typedef void (_osso_handler_f)(osso_context_t *osso,
                               DBusMessage *msg,
                               _osso_callback_data_t *data,
                               eripc_bus_t bus_type);

typedef struct {
    _osso_handler_f *handler;
    _osso_callback_data_t *data;
    gboolean method;
    gboolean can_free_data;
    gboolean call_once_per_handler_id;
    int handler_id;
} _osso_handler_t;

typedef struct {
    GSList *handlers;
} _osso_hash_value_t;

/**
 * This structure is used to store library specific stuff
 */

typedef struct osso_af_context_t {
    DBusConnection *conn;
    DBusConnection *sys_conn;
    DBusConnection *cur_conn;
    gchar application[MAX_APP_NAME_LEN + 1];
    gchar version[MAX_VERSION_LEN + 1];
    char object_path[MAX_OP_LEN + 1];
    char interface[MAX_IF_LEN + 1];
    char service[MAX_SVC_LEN + 1];
    gboolean systembus_service_registered;
    gboolean sessionbus_service_registered;
    GHashTable *uniq_hash;  /* handlers hashed by the triplet: service,
                               object path, and interface. */
    GHashTable *if_hash;    /* handlers hashed by interface only */
    GHashTable *id_hash;    /* handlers hashed by id */
    GHashTable *opm_hash;   /* handlers hashed by object path + member */
#ifdef LIBOSSO_DEBUG
    guint log_handler;
#endif
    guint timeout_ms;
    GHashTable *cp_plugins;
    int next_handler_id;    /* next available handler id, unique in this
                               context */
    const DBusMessage *reply_dummy, *error_dummy;
    gboolean eripc_filters_setup;
} _eripc_context_t;


typedef struct _eripc_context_t {
    DBusConnection *conn;
    DBusConnection *sys_conn;
    DBusConnection *cur_conn;
    gchar application[MAX_APP_NAME_LEN + 1];
    gchar version[MAX_VERSION_LEN + 1];
    char object_path[MAX_OP_LEN + 1];
    char interface[MAX_IF_LEN + 1];
    char service[MAX_SVC_LEN + 1];
    gboolean systembus_service_registered;
    gboolean sessionbus_service_registered;
    GHashTable *uniq_hash;  /* handlers hashed by the triplet: service,
                               object path, and interface. */
    GHashTable *if_hash;    /* handlers hashed by interface only */
    GHashTable *id_hash;    /* handlers hashed by id */
    GHashTable *opm_hash;   /* handlers hashed by object path + member */
#ifdef LIBOSSO_DEBUG
    guint log_handler;
#endif
    guint timeout_ms;
    GHashTable *cp_plugins;
    int next_handler_id;    /* next available handler id, unique in this
                               context */
    const DBusMessage *reply_dummy, *error_dummy;
    gboolean eripc_filters_setup;
} _eripc_this_type_is_not_used_t;


#ifdef LIBOSSO_DEBUG
#  define dprint(f, a...) (fprintf(stderr, "%s:%d %s(): "f"\n", __FILE__, \
                 __LINE__, __func__, ##a),fflush(stderr))
# else
#  define dprint(f, a...)
# endif 


extern int __attribute__ ((visibility("hidden")))
eripc_convert_msgtype(int t);

eripc_arg_t* _get_args(DBusMessageIter *iter);


DBusHandlerResult __attribute__ ((visibility("hidden")))
_msg_handler(DBusConnection *conn, DBusMessage *msg, void *data);

void __attribute__ ((visibility("hidden")))
make_default_interface(const char *application, char *interface);

void __attribute__ ((visibility("hidden")))
make_default_service(const char *application, char *service);

void __attribute__ ((visibility("hidden")))
make_default_object_path(const char *application, char *path);

void __attribute__ ((visibility("hidden")))
make_default_error_name(const char *service, const char *name,
                        char *ready_name);

gboolean __attribute__ ((visibility("hidden")))
_eripc_set_handler(_eripc_context_t *context,
                   _osso_handler_f *handler,
                   _osso_callback_data_t *data,
                   int handler_id,
                   gboolean call_once_per_handler_id);

gboolean __attribute__ ((visibility("hidden")))
_unset_handler(_eripc_context_t *context, int handler_id);

gboolean validate_appname(const gchar *application);

extern void __attribute__ ((visibility("hidden")))
_parse_id(const char *id, eripc_bus_t *bus, char *sender,
                int *serial);

extern void __attribute__ ((visibility("hidden")))
_make_id(eripc_bus_t bus, const char *sender, int serial, char *id);

/** @} */

#endif /* INTERNAL_H_ */