include/framework/event/oma_ds_platform_event_handler.h

   1 /*
   2  * oma-ds-agent
   3  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the License);
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 /**
  19  *   @OMA_DS_Platform_Event_Handler.h
  20  *   @version                                                                   0.1
  21  *   @brief                                                                             This file is the header file of interface for event callback function(platform monitor)
  22  */
  23
  24 #ifndef OMA_DS_PLATFORM_EVENT_HANDLER_H_
  25 #define OMA_DS_PLATFORM_EVENT_HANDLER_H_
  26
  27 #include <glib.h>
  28 #include <stdio.h>
  29 #include <stdbool.h>
  30
  31 /**
  32  * @par Description: API to parse callback function for SAN
  33  *
  34  *
  35  * @par Purpose:
  36  * @par Typical use case:
  37  * @par Method of function operation:
  38  * @par Important notes:
  39  * @param[in]           string type, msg body
  40  * @param[in]           unsigned int type, size of msg
  41  * @param[in]           int type, version
  42  * @param[out]
  43  *
  44  * @return                              1 on success
  45  *                                              0 on fail
  46  *
  47  * @par Errors:
  48  *
  49  * @pre None.
  50  * @post
  51  * @see
  52  * @remarks None.
  53  *
  54  * @par Sample Code:
  55  * @code
  56  * @endcode
  57  */
  58 int san_callback_parse(int item_id, void *user_data);
  59
  60 /**
  61  * @par Description: This API is callback function for scheduler
  62  *
  63  *
  64  * @par Purpose:
  65  * @par Typical use case:
  66  * @par Method of function operation:
  67  * @par Important notes:
  68  * @param[in]           scheduler Id
  69  * @param[in]           user data
  70  * @param[out]
  71  *
  72  * @return
  73  *
  74  * @par Errors:
  75  *
  76  * @pre None.
  77  * @post
  78  * @see
  79  * @remarks None.
  80  *
  81  * @par Sample Code:
  82  * @code
  83  * @endcode
  84  */
  85 void send_periodic_sync_msg(int scheduler_id, void *data);
  86
  87 /**
  88  * @par Description: This API is for receive ip push msg from event
  89  *
  90  * Parse ip push msg and request sync
  91  *
  92  * @par Purpose:
  93  * @par Typical use case:
  94  * @par Method of function operation:
  95  * @par Important notes:
  96  * @param[in]           data(ip push message)
  97  *
  98  * @return                              1 on success
  99  *                                              0 on fail
 100  *
 101  * @par Errors:
 102  *
 103  * @pre None.
 104  * @post
 105  * @see
 106  * @remarks None.
 107  *
 108  * @par Sample Code:
 109  * @code
 110  * @endcode
 111  */
 112 int send_ip_push_sync_msg(char *data);
 113
 114 #endif                          /* OMA_DS_PLATFORM_EVENT_HANDLER_H_ */