index_ipc.h

Go to the documentation of this file.
00001 #ifndef __INDEX_IPC_H__
00002 #define __INDEX_IPC_H__
00003 
00004 /**
00005  * File Name  : index_ipc.h
00006  *
00007  * Description: The dbus-based eripc functions 
00008  */
00009 
00010 /*
00011  * This file is part of ctb.
00012  *
00013  * ctb is free software: you can redistribute it and/or modify
00014  * it under the terms of the GNU General Public License as published by
00015  * the Free Software Foundation, either version 2 of the License, or
00016  * (at your option) any later version.
00017  *
00018  * ctb is distributed in the hope that it will be useful,
00019  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00021  * GNU General Public License for more details.
00022  *
00023  * You should have received a copy of the GNU General Public License
00024  * along with this program. If not, see <http://www.gnu.org/licenses/>.
00025  */
00026 
00027 /**
00028  * Copyright (C) 2009 IREX Technologies B.V.
00029  * All rights reserved.
00030  */
00031 
00032 
00033 //----------------------------------------------------------------------------
00034 // Include Files
00035 //----------------------------------------------------------------------------
00036 
00037 G_BEGIN_DECLS
00038 
00039 
00040 //----------------------------------------------------------------------------
00041 // Definitions
00042 //---------------------------------------------------------------------------- 
00043 
00044 
00045 //----------------------------------------------------------------------------
00046 // Forward Declarations
00047 //----------------------------------------------------------------------------
00048 
00049 
00050 //----------------------------------------------------------------------------
00051 // Type Declarations
00052 //----------------------------------------------------------------------------
00053 
00054 //----------------------------------------------------------------------------
00055 // Global Constants
00056 //----------------------------------------------------------------------------
00057 
00058 
00059 //============================================================================
00060 // Public Functions
00061 //============================================================================
00062 
00063 /**---------------------------------------------------------------------------
00064  *
00065  * Name :  ipc_set_services
00066  *
00067  * @brief  Setup IPC connection and register API functions
00068  *
00069  * @param  None
00070  *
00071  * @return --
00072  *
00073  *--------------------------------------------------------------------------*/
00074 void ipc_set_services ();
00075 
00076 
00077 /**---------------------------------------------------------------------------
00078  *
00079  * Name :  ipc_unset_services
00080  *
00081  * @brief  Unregister API functions
00082  *
00083  * @param  --
00084  *
00085  * @return --
00086  *
00087  *--------------------------------------------------------------------------*/
00088 void ipc_unset_services ( void );
00089 
00090 
00091 /**---------------------------------------------------------------------------
00092  *
00093  * Name :  ipc_send_store_metadata
00094  *
00095  * @brief  Send message to store metadata to UDS
00096  *
00097  * @param  [in] document            String of document to open
00098  *
00099  * @return TRUE on success, FALSE otherwise
00100  *
00101  *--------------------------------------------------------------------------*/
00102 gboolean ipc_send_store_metadata(const char *dir, const char *document);
00103 
00104 
00105 G_END_DECLS
00106 
00107 #endif /* __INDEX_IPC_H__ */
Generated by  doxygen 1.6.2-20100208