include/framework/platform-event-handler/dm_platform_event_handler.h

   1 /*
   2  * oma-dm-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 #ifndef DM_PLATFORM_EVENT_HANDLER_H_
  19 #define DM_PLATFORM_EVENT_HANDLER_H_
  20
  21 /*dm-agent*/
  22 #include "framework/platform-event-handler/dm_platform_event_handler_internal.h"
  23
  24 /**
  25  * @par Description: API to dm wap push incomming callback
  26  *
  27  *
  28  * @par Purpose:
  29  * @par Typical use case:
  30  * @par Method of function operation:
  31  * @par Important notes:
  32  * @param[in]   item id
  33  * @param[in]   user data
  34  *
  35  * @return                      DM_OK                                                   success
  36  *                                      DM_ERRORS                                       fail
  37  *
  38  * @par Errors:
  39  *
  40  * @pre None.
  41  * @post
  42  * @see
  43  * @remarks None.
  44  *
  45  * @par Sample Code:
  46  * @code
  47  * @endcode
  48  */
  49 int dm_wap_push_incomming_callback(int item_id, void *user_data);
  50
  51 /**
  52  * @par Description: API to dm wap push operation callback
  53  *
  54  *
  55  * @par Purpose:
  56  * @par Typical use case:
  57  * @par Method of function operation:
  58  * @par Important notes:
  59  * @param[in]   item id
  60  * @param[in]   user data
  61  *
  62  * @return                      DM_OK                                                   success
  63  *                                      DM_ERRORS                                       fail
  64  *
  65  * @par Errors:
  66  *
  67  * @pre None.
  68  * @post
  69  * @see
  70  * @remarks None.
  71  *
  72  * @par Sample Code:
  73  * @code
  74  * @endcode
  75  */
  76 int dm_wap_push_operation_callback(int item_id, void *user_data);
  77
  78 /**
  79  * @par Description: API to dm ip push callback
  80  *
  81  *
  82  * @par Purpose:
  83  * @par Typical use case:
  84  * @par Method of function operation:
  85  * @par Important notes:
  86  * @param[in]   item id
  87  * @param[in]   user data
  88  *
  89  * @return                      DM_OK                                                   success
  90  *                                      DM_ERRORS                                       fail
  91  *
  92  * @par Errors:
  93  *
  94  * @pre None.
  95  * @post
  96  * @see
  97  * @remarks None.
  98  *
  99  * @par Sample Code:
 100  * @code
 101  * @endcode
 102  */
 103 int dm_ip_push_callback(int item_id, void *user_data);
 104
 105 /**
 106  * @par Description: API to telephony incomming callback
 107  *
 108  *
 109  * @par Purpose:
 110  * @par Typical use case:
 111  * @par Method of function operation:
 112  * @par Important notes:
 113  * @param[in]   item id
 114  * @param[in]   user data
 115  *
 116  * @return                      DM_OK                                                   success
 117  *                                      DM_ERRORS                                       fail
 118  *
 119  * @par Errors:
 120  *
 121  * @pre None.
 122  * @post
 123  * @see
 124  * @remarks None.
 125  *
 126  * @par Sample Code:
 127  * @code
 128  * @endcode
 129  */
 130 int dm_telephony_incomming_callback(int item_id, void *user_data);
 131
 132 /**
 133  * @par Description: API to telephony end callback
 134  *
 135  *
 136  * @par Purpose:
 137  * @par Typical use case:
 138  * @par Method of function operation:
 139  * @par Important notes:
 140  * @param[in]   item id
 141  * @param[in]   user data
 142  *
 143  * @return                      DM_OK                                                   success
 144  *                                      DM_ERRORS                                       fail
 145  *
 146  * @par Errors:
 147  *
 148  * @pre None.
 149  * @post
 150  * @see
 151  * @remarks None.
 152  *
 153  * @par Sample Code:
 154  * @code
 155  * @endcode
 156  */
 157 int dm_telephony_end_callback(int item_id, void *user_data);
 158
 159 /**
 160  * @par Description: API to network on callback
 161  *
 162  *
 163  * @par Purpose:
 164  * @par Typical use case:
 165  * @par Method of function operation:
 166  * @par Important notes:
 167  *
 168  * @return                      DM_OK                                                   success
 169  *                                      DM_ERRORS                                       fail
 170  *
 171  * @par Errors:
 172  *
 173  * @pre None.
 174  * @post
 175  * @see
 176  * @remarks None.
 177  *
 178  * @par Sample Code:
 179  * @code
 180  * @endcode
 181  */
 182 int network_on_callback();
 183
 184 /**
 185  * @par Description: API to network off callback
 186  *
 187  *
 188  * @par Purpose:
 189  * @par Typical use case:
 190  * @par Method of function operation:
 191  * @par Important notes:
 192  *
 193  * @return                      1                               success
 194  *                                      0                               fail
 195  *
 196  * @par Errors:
 197  *
 198  * @pre None.
 199  * @post
 200  * @see
 201  * @remarks None.
 202  *
 203  * @par Sample Code:
 204  * @code
 205  * @endcode
 206  */
 207 int network_off_callback();
 208
 209 /**
 210  * @par Description: API to network change callback
 211  *
 212  *
 213  * @par Purpose:
 214  * @par Typical use case:
 215  * @par Method of function operation:
 216  * @par Important notes:
 217  *
 218  * @return                      1                               success
 219  *                                      0                               fail
 220  *
 221  * @par Errors:
 222  *
 223  * @pre None.
 224  * @post
 225  * @see
 226  * @remarks None.
 227  *
 228  * @par Sample Code:
 229  * @code
 230  * @endcode
 231  */
 232 int network_change_callback();
 233
 234 /**
 235  * @par Description: API to alarm_callback
 236  *
 237  *
 238  * @par Purpose:
 239  * @par Typical use case:
 240  * @par Method of function operation:
 241  * @par Important notes:
 242  *
 243  * @return                      1                               success
 244  *                                      0                               fail
 245  *
 246  * @par Errors:
 247  *
 248  * @pre None.
 249  * @post
 250  * @see
 251  * @remarks None.
 252  *
 253  * @par Sample Code:
 254  * @code
 255  * @endcode
 256  */
 257 int alarm_callback(int item_id, void *user_data);
 258
 259 /**
 260  * @par Description: API to event_data_free
 261  *
 262  *
 263  * @par Purpose:
 264  * @par Typical use case:
 265  * @par Method of function operation:
 266  * @par Important notes:
 267  *
 268  * @param[in]   event data
 269  *
 270  * @return
 271  *
 272  *
 273  * @par Errors:
 274  *
 275  * @pre None.
 276  * @post
 277  * @see
 278  * @remarks None.
 279  *
 280  * @par Sample Code:
 281  * @code
 282  * @endcode
 283  */
 284 void event_data_free(void *pEvent_data);
 285
 286 #endif                          /* DM_PLATFORM_EVENT_HANDLER_H_ */