Main Page | Data Structures | File List | Data Fields | Globals

rpc-osso.h

Go to the documentation of this file.
00001 /**
00002  * This file is part of alarmd
00003  *
00004  * Contact Person: David Weinehall <david.weinehall@nokia.com>
00005  *
00006  * Copyright (C) 2006 Nokia Corporation
00007  * alarmd and libalarm are free software; you can redistribute them
00008  * and/or modify them under the terms of the GNU Lesser General Public
00009  * License version 2.1 as published by the Free Software Foundation.
00010  *
00011  * alarmd and libalarm are distributed in the hope that they will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014  * Lesser General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU Lesser General Public
00017  * License along with this software; if not, write to the Free
00018  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
00019  * 02110-1301 USA
00020  */
00021 
00022 #ifndef _RPC_OSSO_H_
00023 #define _RPC_OSSO_H_
00024 
00025 #include <libosso.h>
00026 #include "queue.h"
00027 
00028 /**
00029  * SECTION:rpc-osso
00030  * @short_description: Handles all libosso related things.
00031  *
00032  * These functions are the ones that do all the osso de/initialization.
00033  **/
00034 
00035 /**
00036  * init_osso:
00037  * @queue: A #AlarmdQueue that will be notified on time changes, and where
00038  * new events should be added to.
00039  *
00040  * Initializes osso connectivity.
00041  * Returns: The osso_context_t returned by osso_initialize or NULL on failure.
00042  **/
00043 osso_context_t *init_osso(void);
00044 
00045 /**
00046  * set_osso_callbacks:
00047  * @osso: A pointer to the osso_context_t struct, as returned by init_osso.
00048  * @queue: The queue that the callbacks should affect.
00049  *
00050  * Starts listening on dbus system and session buses for incoming requests.
00051  **/ 
00052 void set_osso_callbacks(osso_context_t *osso, AlarmdQueue *queue);
00053 
00054 /**
00055  * deinit_osso:
00056  * @osso: The osso_context_t structure as returned by init_osso.
00057  * @queue: The #AlarmdQueue that was passed to init_osso.
00058  *
00059  * Deinitializes osso connectivity. Stops listening on dbus buses.
00060  **/
00061 void deinit_osso(osso_context_t *osso, AlarmdQueue *queue);
00062 
00063 #endif /* _RPC_OSSO_H_ */

Generated on Thu Dec 21 18:23:30 2006 for Alarmd by  doxygen 1.4.2