isolationserver/isoserver/inc/isosearch.h
changeset 10 59927b2d3b75
parent 0 d0f3a028347a
equal deleted inserted replaced
0:d0f3a028347a 10:59927b2d3b75
     1 /*
       
     2 * ============================================================================
       
     3 *  Name        : isosearch.h
       
     4 *  Part of     : isolation server.
       
     5 *  Version     : %version: 8 %
       
     6 *
       
     7 *  Copyright © 2007-2008 Nokia.  All rights reserved.
       
     8 *  All rights reserved.
       
     9 *  Redistribution and use in source and binary forms, with or without modification, 
       
    10 *  are permitted provided that the following conditions are met:
       
    11 *  Redistributions of source code must retain the above copyright notice, this list 
       
    12 *  of conditions and the following disclaimer.Redistributions in binary form must 
       
    13 *  reproduce the above copyright notice, this list of conditions and the following 
       
    14 *  disclaimer in the documentation and/or other materials provided with the distribution.
       
    15 *  Neither the name of the Nokia Corporation nor the names of its contributors may be used 
       
    16 *  to endorse or promote products derived from this software without specific prior written 
       
    17 *  permission.
       
    18 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
       
    19 *  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
       
    20 *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
       
    21 *  SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
       
    22 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
       
    23 *  OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
       
    24 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
       
    25 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
       
    26 *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
       
    27 * ============================================================================
       
    28 * Template version: 1.0
       
    29 */
       
    30 
       
    31 /*!
       
    32 * /def To avoid multiple inclusion of header
       
    33 */
       
    34 #ifndef __ISOSEARCH_H__
       
    35 #define __ISOSEARCH_H__
       
    36 
       
    37 /*! /file
       
    38 *	Header file for search feature implimentation. The interfaces mentioned are 
       
    39 *	the only those which are used(extern) by functions in other files. Functions which 
       
    40 *	are locally used in isosearch.c are not added here. And those functions are forward 
       
    41 *	declared.
       
    42 *	client anywhere in the documentation refers to anyone
       
    43 *	using the isoserver
       
    44 */
       
    45 
       
    46 /*
       
    47 ! /This header has definitions for glib types
       
    48 */
       
    49 #include <gtypes.h>
       
    50 
       
    51 /*
       
    52 ! /This header has definitions for DBusGProxy
       
    53 */
       
    54 #include <dbus/dbus-glib.h>
       
    55 
       
    56 
       
    57 /*
       
    58 ! /brief This function is called by message_send_recv function in isoservermain.c if message type
       
    59 *	is ESearch. This function parses the rmsg, validates the parameter passed, if parameters are 
       
    60 *	correct a search performed for them. else INVALID_PARAMETERES error is returned
       
    61 *
       
    62 * 	/param rmsg message buffer to be parsed
       
    63 *	/param rmsg_len the length of the rmsg
       
    64 *	/remark rmsg_len is not strlen(rmsg)
       
    65 *	/return returns error code or 0 on success
       
    66 */
       
    67 gint action_parse_search( gchar* rmsg, gint rmsg_len );
       
    68 
       
    69 
       
    70 
       
    71 /*
       
    72 !	/brief This function is called as a callback when a search channel is closed
       
    73 *	/remark This function should have been a static function in isosearch.c
       
    74 *	A work around has been done to make multiple search requests.
       
    75 *
       
    76 * 	/param proxy unused variable
       
    77 *	/param error Error if any
       
    78 *	/param user_data callback data
       
    79 *	/return void
       
    80 */
       
    81 void search_chan_closed_cb ( DBusGProxy	*proxy,
       
    82 									GError *error,
       
    83 									gpointer	user_data
       
    84 								  );
       
    85 
       
    86 #endif //__ISOSEARCH_H__