include/framework/task/oma_ds_engine_controller_task.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_Engine_Controller_Task.h
  20  *   @version                                                                   0.1
  21  *   @brief                                                                             This file is the header file of registration function for using Engine Controller
  22  */
  23
  24 #ifndef ENGINE_CONTROLLER_TASK_H_
  25 #define ENGINE_CONTROLLER_TASK_H_
  26
  27 #include <stdio.h>
  28 #include <sync_agent.h>
  29
  30 #define SYNC_MODE_MANUAL                0
  31 #define SYNC_MODE_PERIODIC              1
  32 #define SYNC_MODE_SAN                           2
  33 #define SYNC_MODE_AUTOCONFIG    3
  34
  35 typedef struct request_msg_info_s request_msg_info_t;
  36 struct request_msg_info_s {
  37         int sync_type;
  38         unsigned int request_id;
  39         int profile_id;
  40 };
  41
  42 #define EC_MSG_TYPE_SYNC_TASK_REQUEST           1
  43 #define EC_MSG_TYPE_NAME_SYNC_TASK_REQUEST      "sync_request"
  44 #define EC_MSG_TYPE_SYNC_TASK_ADD_PROFILE       2
  45 #define EC_MSG_TYPE_NAME_SYNC_TASK_ADD_PROFILE                  "add_profile"
  46 #define EC_MSG_TYPE_SYNC_TASK_EDIT_PROFILE      3
  47 #define EC_MSG_TYPE_NAME_SYNC_TASK_EDIT_PROFILE         "edit_profile"
  48 #define EC_MSG_TYPE_SYNC_TASK_DELETE_PROFILE    4
  49 #define EC_MSG_TYPE_NAME_SYNC_TASK_DELETE_PROFILE       "delete_profile"
  50 #define EC_MSG_TYPE_SAN_TASK_REQUEST                                    5
  51 #define EC_MSG_TYPE_NAME_SAN_TASK_REQUEST               "SAN_request"
  52 #define EC_MSG_TYPE_SYNC_TASK_GET_PROFILE_DATA                  6
  53 #define EC_MSG_TYPE_NAME_SYNC_TASK_GET_PROFILE_DATA             "get_profile_data"
  54 #define EC_MSG_TYPE_SYNC_TASK_GET_PROFILE_SYNC_CATEGORY         7
  55 #define EC_MSG_TYPE_NAME_SYNC_TASK_GET_PROFILE_SYNC_CATEGORY    "get_profile_sync_category"
  56 #define EC_MSG_TYPE_SYNC_TASK_GET_PROFILE_STATISTICS                    8
  57 #define EC_MSG_TYPE_NAME_SYNC_TASK_GET_PROFILE_STATISTICS                               "get_profile_statistics"
  58 #define EC_MSG_TYPE_SYNC_TASK_RESET_SYNCHRONIZING_PROFILES                      9
  59 #define EC_MSG_TYPE_NAME_SYNC_TASK_RESET_SYNCHRONIZING_PROFILES         "reset_synchronizing_profiles"
  60 #define EC_MSG_TYPE_SYNC_TASK_CANCEL_SYNC_REQUEST               10
  61 #define EC_MSG_TYPE_NAME_SYNC_TASK_CANCEL_SYNC_REQUEST          "cancel_sync_request"
  62 #define EC_MSG_TYPE_SYNC_TASK_ADD_PROFILE_CP                    11
  63 #define EC_MSG_TYPE_NAME_SYNC_TASK_ADD_PROFILE_CP               "add_profile_cp"
  64 #define EC_MSG_TYPE_SYNC_TASK_REFRESH_FROM_SERVICE                      12
  65 #define EC_MSG_TYPE_NAME_SYNC_TASK_REFRESH_FROM_SERVICE "refresh_from_service"
  66 #define EC_MSG_TYPE_SYNC_TASK_RESET_ALL_DATA                    13
  67 #define EC_MSG_TYPE_NAME_SYNC_TASK_RESET_ALL_DATA       "reset_all_data"
  68 #define EC_MSG_TYPE_SYNC_TASK_GET_ALL_PROFILES_DATA                     14
  69 #define EC_MSG_TYPE_NAME_SYNC_TASK_GET_ALL_PROFILES_DATA        "get_all_profiles_data"
  70
  71 /**
  72  * @par Description: API to create synchronize task
  73  *
  74  *
  75  * @par Purpose:
  76  * @par Typical use case:
  77  * @par Method of function operation:
  78  * @par Important notes:
  79  * @param[in]
  80  * @param[out]
  81  *
  82  * @return                              sync_agent_ec_task_spec_s structure      on success
  83  *                                                      NYLL on error
  84  * @par Errors:
  85  *
  86  * @pre None.
  87  * @post
  88  * @see
  89  * @remarks None.
  90  *
  91  * @par Sample Code:
  92  * @code
  93  * @endcode
  94  */
  95 sync_agent_ec_task_spec_s *make_synchronize_task();
  96
  97 /**
  98  * @par Description: API to create synchronize task
  99  *
 100  *
 101  * @par Purpose:
 102  * @par Typical use case:
 103  * @par Method of function operation:
 104  * @par Important notes:
 105  * @param[in]
 106  * @param[out]
 107  *
 108  * @return                              sync_agent_ec_task_spec_s structure      on success
 109  *                                                      NYLL on error
 110  * @par Errors:
 111  *
 112  * @pre None.
 113  * @post
 114  * @see
 115  * @remarks None.
 116  *
 117  * @par Sample Code:
 118  * @code
 119  * @endcode
 120  */
 121 sync_agent_ec_task_spec_s *make_add_profile_task();
 122
 123 /**
 124  * @par Description: API to create edit profile task
 125  *
 126  *
 127  * @par Purpose:
 128  * @par Typical use case:
 129  * @par Method of function operation:
 130  * @par Important notes:
 131  * @param[in]
 132  * @param[out]
 133  *
 134  * @return                              sync_agent_ec_task_spec_s structure      on success
 135  *                                                      NYLL on error
 136  * @par Errors:
 137  *
 138  * @pre None.
 139  * @post
 140  * @see
 141  * @remarks None.
 142  *
 143  * @par Sample Code:
 144  * @code
 145  * @endcode
 146  */
 147 sync_agent_ec_task_spec_s *make_edit_profile_task();
 148
 149 /**
 150  * @par Description: API to create delete profiles task
 151  *
 152  *
 153  * @par Purpose:
 154  * @par Typical use case:
 155  * @par Method of function operation:
 156  * @par Important notes:
 157  * @param[in]
 158  * @param[out]
 159  *
 160  * @return                              sync_agent_ec_task_spec_s structure      on success
 161  *                                                      NYLL on error
 162  * @par Errors:
 163  *
 164  * @pre None.
 165  * @post
 166  * @see
 167  * @remarks None.
 168  *
 169  * @par Sample Code:
 170  * @code
 171  * @endcode
 172  */
 173 sync_agent_ec_task_spec_s *make_delete_profile_task();
 174
 175 /**
 176  * @par Description: API to create get profile data task
 177  *
 178  *
 179  * @par Purpose:
 180  * @par Typical use case:
 181  * @par Method of function operation:
 182  * @par Important notes:
 183  * @param[in]
 184  * @param[out]
 185  *
 186  * @return                              sync_agent_ec_task_spec_s structure      on success
 187  *                                                      NYLL on error
 188  * @par Errors:
 189  *
 190  * @pre None.
 191  * @post
 192  * @see
 193  * @remarks None.
 194  *
 195  * @par Sample Code:
 196  * @code
 197  * @endcode
 198  */
 199 sync_agent_ec_task_spec_s *make_get_profile_data_task();
 200
 201 /**
 202  * @par Description: API to create get profile sync category task
 203  *
 204  *
 205  * @par Purpose:
 206  * @par Typical use case:
 207  * @par Method of function operation:
 208  * @par Important notes:
 209  * @param[in]
 210  * @param[out]
 211  *
 212  * @return                              sync_agent_ec_task_spec_s structure      on success
 213  *                                                      NYLL on error
 214  * @par Errors:
 215  *
 216  * @pre None.
 217  * @post
 218  * @see
 219  * @remarks None.
 220  *
 221  * @par Sample Code:
 222  * @code
 223  * @endcode
 224  */
 225 sync_agent_ec_task_spec_s *make_get_profile_sync_category_task();
 226
 227 /**
 228  * @par Description: API to create get profile last statistics task
 229  *
 230  *
 231  * @par Purpose:
 232  * @par Typical use case:
 233  * @par Method of function operation:
 234  * @par Important notes:
 235  * @param[in]
 236  * @param[out]
 237  *
 238  * @return                              sync_agent_ec_task_spec_s structure      on success
 239  *                                                      NYLL on error
 240  * @par Errors:
 241  *
 242  * @pre None.
 243  * @post
 244  * @see
 245  * @remarks None.
 246  *
 247  * @par Sample Code:
 248  * @code
 249  * @endcode
 250  */
 251 sync_agent_ec_task_spec_s *make_get_profile_statistics_task();
 252
 253 /**
 254  * @par Description: API to create reset synchronizing profiles task
 255  *
 256  *
 257  * @par Purpose:
 258  * @par Typical use case:
 259  * @par Method of function operation:
 260  * @par Important notes:
 261  * @param[in]
 262  * @param[out]
 263  *
 264  * @return                              sync_agent_ec_task_spec_s structure      on success
 265  *                                                      NYLL on error
 266  * @par Errors:
 267  *
 268  * @pre None.
 269  * @post
 270  * @see
 271  * @remarks None.
 272  *
 273  * @par Sample Code:
 274  * @code
 275  * @endcode
 276  */
 277 sync_agent_ec_task_spec_s *make_reset_synchronizing_profiles_task();
 278
 279 /**
 280  * @par Description: API to create reset synchronizing profiles task
 281  *
 282  *
 283  * @par Purpose:
 284  * @par Typical use case:
 285  * @par Method of function operation:
 286  * @par Important notes:
 287  * @param[in]
 288  * @param[out]
 289  *
 290  * @return                              sync_agent_ec_task_spec_s structure      on success
 291  *                                                      NYLL on error
 292  * @par Errors:
 293  *
 294  * @pre None.
 295  * @post
 296  * @see
 297  * @remarks None.
 298  *
 299  * @par Sample Code:
 300  * @code
 301  * @endcode
 302  */
 303 sync_agent_ec_task_spec_s *make_add_profile_cp_task();
 304
 305 /**
 306  * @par Description: API to create reset refresh_from_service task
 307  *
 308  *
 309  * @par Purpose:
 310  * @par Typical use case:
 311  * @par Method of function operation:
 312  * @par Important notes:
 313  * @param[in]
 314  * @param[out]
 315  *
 316  * @return                              sync_agent_ec_task_spec_s structure      on success
 317  *                                                      NYLL on error
 318  * @par Errors:
 319  *
 320  * @pre None.
 321  * @post
 322  * @see
 323  * @remarks None.
 324  *
 325  * @par Sample Code:
 326  * @code
 327  * @endcode
 328  */
 329 sync_agent_ec_task_spec_s *make_refresh_from_service_task();
 330
 331 /**
 332  * @par Description: API to create cancel network session task
 333  *
 334  *
 335  * @par Purpose:
 336  * @par Typical use case:
 337  * @par Method of function operation:
 338  * @par Important notes:
 339  * @param[in]
 340  * @param[out]
 341  *
 342  * @return                              sync_agent_ec_task_spec_s structure      on success
 343  *                                                      NYLL on error
 344  * @par Errors:
 345  *
 346  * @pre None.
 347  * @post
 348  * @see
 349  * @remarks None.
 350  *
 351  * @par Sample Code:
 352  * @code
 353  * @endcode
 354  */
 355 sync_agent_ec_task_spec_s *make_cancel_request_task();
 356
 357 /**
 358  * @par Description: API to reset all data
 359  *
 360  *
 361  * @par Purpose:
 362  * @par Typical use case:
 363  * @par Method of function operation:
 364  * @par Important notes:
 365  * @param[in]
 366  * @param[out]
 367  *
 368  * @return                              sync_agent_ec_task_spec_s structure      on success
 369  *                                                      NYLL on error
 370  * @par Errors:
 371  *
 372  * @pre None.
 373  * @post
 374  * @see
 375  * @remarks None.
 376  *
 377  * @par Sample Code:
 378  * @code
 379  * @endcode
 380  */
 381 sync_agent_ec_task_spec_s *make_reset_all_data_task();
 382
 383 /**
 384  * @par Description: API to get all profiles data
 385  *
 386  *
 387  * @par Purpose:
 388  * @par Typical use case:
 389  * @par Method of function operation:
 390  * @par Important notes:
 391  * @param[in]
 392  * @param[out]
 393  *
 394  * @return                              sync_agent_ec_task_spec_s structure      on success
 395  *                                                      NYLL on error
 396  * @par Errors:
 397  *
 398  * @pre None.
 399  * @post
 400  * @see
 401  * @remarks None.
 402  *
 403  * @par Sample Code:
 404  * @code
 405  * @endcode
 406  */
 407 sync_agent_ec_task_spec_s *make_get_all_profiles_data_task();
 408 /**
 409  * @par Description: This API is callback function which runs when synchronize task is requested
 410  *
 411  *
 412  * @par Purpose:
 413  * @par Typical use case:
 414  * @par Method of function operation:
 415  * @par Important notes:
 416  * @param[in]           unsigned int type, parameter count
 417  * @param[in]           array of parameters
 418  * @param[out]
 419  *
 420  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 421  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 422  * @par Errors:
 423  *
 424  * @pre None.
 425  * @post
 426  * @see
 427  * @remarks None.
 428  *
 429  * @par Sample Code:
 430  * @code
 431  * @endcode
 432  */
 433 sync_agent_ec_task_error_e synchronize_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 434
 435 /**
 436  * @par Description: This API is callback function which runs when add profile task is requested
 437  *
 438  *
 439  * @par Purpose:
 440  * @par Typical use case:
 441  * @par Method of function operation:
 442  * @par Important notes:
 443  * @param[in]           unsigned int type, parameter count
 444  * @param[in]           array of parameters
 445  * @param[out]
 446  *
 447  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 448  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 449  * @par Errors:
 450  *
 451  * @pre None.
 452  * @post
 453  * @see
 454  * @remarks None.
 455  *
 456  * @par Sample Code:
 457  * @code
 458  * @endcode
 459  */
 460 sync_agent_ec_task_error_e add_profile_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 461
 462 /**
 463  * @par Description: This API is callback function which runs when edit profile task is requested
 464  *
 465  *
 466  * @par Purpose:
 467  * @par Typical use case:
 468  * @par Method of function operation:
 469  * @par Important notes:
 470  * @param[in]           unsigned int type, parameter count
 471  * @param[in]           array of parameters
 472  * @param[out]
 473  *
 474  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 475  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 476  * @par Errors:
 477  *
 478  * @pre None.
 479  * @post
 480  * @see
 481  * @remarks None.
 482  *
 483  * @par Sample Code:
 484  * @code
 485  * @endcode
 486  */
 487 sync_agent_ec_task_error_e edit_profile_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 488
 489 /**
 490  * @par Description: This API is callback function which runs when delete profiles task is requested
 491  *
 492  *
 493  * @par Purpose:
 494  * @par Typical use case:
 495  * @par Method of function operation:
 496  * @par Important notes:
 497  * @param[in]           unsigned int type, parameter count
 498  * @param[in]           array of parameters
 499  * @param[out]
 500  *
 501  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 502  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 503  * @par Errors:
 504  *
 505  * @pre None.
 506  * @post
 507  * @see
 508  * @remarks None.
 509  *
 510  * @par Sample Code:
 511  * @code
 512  * @endcode
 513  */
 514 sync_agent_ec_task_error_e delete_profile_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 515
 516 /**
 517  * @par Description: This API is callback function which runs when get profile name task is requested
 518  *
 519  *
 520  * @par Purpose:
 521  * @par Typical use case:
 522  * @par Method of function operation:
 523  * @par Important notes:
 524  * @param[in]           unsigned int type, parameter count
 525  * @param[in]           array of parameters
 526  * @param[out]
 527  *
 528  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 529  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 530  * @par Errors:
 531  *
 532  * @pre None.
 533  * @post
 534  * @see
 535  * @remarks None.
 536  *
 537  * @par Sample Code:
 538  * @code
 539  * @endcode
 540  */
 541 sync_agent_ec_task_error_e get_profile_data_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 542
 543 /**
 544  * @par Description: This API is callback function which runs when get profile sync category task is requested
 545  *
 546  *
 547  * @par Purpose:
 548  * @par Typical use case:
 549  * @par Method of function operation:
 550  * @par Important notes:
 551  * @param[in]           unsigned int type, parameter count
 552  * @param[in]           array of parameters
 553  * @param[out]
 554  *
 555  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 556  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 557  * @par Errors:
 558  *
 559  * @pre None.
 560  * @post
 561  * @see
 562  * @remarks None.
 563  *
 564  * @par Sample Code:
 565  * @code
 566  * @endcode
 567  */
 568 sync_agent_ec_task_error_e get_profile_sync_category_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 569
 570 /**
 571  * @par Description: This API is callback function which runs when get profile last statistics task is requested
 572  *
 573  *
 574  * @par Purpose:
 575  * @par Typical use case:
 576  * @par Method of function operation:
 577  * @par Important notes:
 578  * @param[in]           unsigned int type, parameter count
 579  * @param[in]           array of parameters
 580  * @param[out]
 581  *
 582  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 583  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 584  * @par Errors:
 585  *
 586  * @pre None.
 587  * @post
 588  * @see
 589  * @remarks None.
 590  *
 591  * @par Sample Code:
 592  * @code
 593  * @endcode
 594  */
 595 sync_agent_ec_task_error_e get_profile_statistics_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 596
 597 /**
 598  * @par Description: This API is callback function which runs when reset synchronizing profiles task is requested
 599  *
 600  *
 601  * @par Purpose:
 602  * @par Typical use case:
 603  * @par Method of function operation:
 604  * @par Important notes:
 605  * @param[in]           unsigned int type, parameter count
 606  * @param[in]           array of parameters
 607  * @param[out]
 608  *
 609  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 610  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 611  * @par Errors:
 612  *
 613  * @pre None.
 614  * @post
 615  * @see
 616  * @remarks None.
 617  *
 618  * @par Sample Code:
 619  * @code
 620  * @endcode
 621  */
 622 sync_agent_ec_task_error_e reset_synchronizing_profiles_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 623
 624 /**
 625  * @par Description: This API is callback function which runs when cancel is requested
 626  *
 627  *
 628  * @par Purpose:
 629  * @par Typical use case:
 630  * @par Method of function operation:
 631  * @par Important notes:
 632  * @param[in]           unsigned int type, parameter count
 633  * @param[in]           array of parameters
 634  * @param[out]
 635  *
 636  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 637  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 638  * @par Errors:
 639  *
 640  * @pre None.
 641  * @post
 642  * @see
 643  * @remarks None.
 644  *
 645  * @par Sample Code:
 646  * @code
 647  * @endcode
 648  */
 649 sync_agent_ec_task_error_e cancel_sync_request_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 650
 651 /**
 652  * @par Description: This API is callback function which runs when reset function is requested
 653  *
 654  *
 655  * @par Purpose:
 656  * @par Typical use case:
 657  * @par Method of function operation:
 658  * @par Important notes:
 659  * @param[in]           unsigned int type, parameter count
 660  * @param[in]           array of parameters
 661  * @param[out]
 662  *
 663  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 664  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 665  * @par Errors:
 666  *
 667  * @pre None.
 668  * @post
 669  * @see
 670  * @remarks None.
 671  *
 672  * @par Sample Code:
 673  * @code
 674  * @endcode
 675  */
 676 sync_agent_ec_task_error_e reset_all_data_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 677
 678 /**
 679  * @par Description: This API is callback function which runs when all profiles data gets.
 680  *
 681  *
 682  * @par Purpose:
 683  * @par Typical use case:
 684  * @par Method of function operation:
 685  * @par Important notes:
 686  * @param[in]           unsigned int type, parameter count
 687  * @param[in]           array of parameters
 688  * @param[out]
 689  *
 690  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 691  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 692  * @par Errors:
 693  *
 694  * @pre None.
 695  * @post
 696  * @see
 697  * @remarks None.
 698  *
 699  * @par Sample Code:
 700  * @code
 701  * @endcode
 702  */
 703 sync_agent_ec_task_error_e get_all_profiles_data_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 704
 705 /**
 706  * @par Description: This API is callback function which runs when add profile for cp task is requested
 707  *
 708  *
 709  * @par Purpose:
 710  * @par Typical use case:
 711  * @par Method of function operation:
 712  * @par Important notes:
 713  * @param[in]           unsigned int type, parameter count
 714  * @param[in]           array of parameters
 715  * @param[out]
 716  *
 717  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 718  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 719  * @par Errors:
 720  *
 721  * @pre None.
 722  * @post
 723  * @see
 724  * @remarks None.
 725  *
 726  * @par Sample Code:
 727  * @code
 728  * @endcode
 729  */
 730 sync_agent_ec_task_error_e add_profile_cp_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 731
 732 /**
 733  * @par Description: This API is callback function which runs when refresh_from_service task is requested
 734  *
 735  *
 736  * @par Purpose:
 737  * @par Typical use case:
 738  * @par Method of function operation:
 739  * @par Important notes:
 740  * @param[in]           unsigned int type, parameter count
 741  * @param[in]           array of parameters
 742  * @param[out]
 743  *
 744  * @return                              SYNC_AGENT_EC_TASK_ERROR_RUN_SUCCESS on success
 745  *                                                      SYNC_AGENT_EC_TASK_ERROR_RUN_FAILED on error
 746  * @par Errors:
 747  *
 748  * @pre None.
 749  * @post
 750  * @see
 751  * @remarks None.
 752  *
 753  * @par Sample Code:
 754  * @code
 755  * @endcode
 756  */
 757 sync_agent_ec_task_error_e refresh_from_service_task_process(unsigned int param_cnt, sync_agent_ec_param_param_s ** param_array);
 758
 759 /**
 760  * @par Description: API to insert request_msg_info_t structure into list
 761  *
 762  *
 763  * @par Purpose:
 764  * @par Typical use case:
 765  * @par Method of function operation:
 766  * @par Important notes:
 767  * @param[in]           sync_type(SYNC_MODE_MANUAL, SYNC_MODE_PERIODIC, SYNC_MODE_SAN, SYNC_MODE_AUTOCONFIG)
 768  * @param[in]           request id
 769  * @param[in]           profile_id
 770  * @param[out]
 771  *
 772  * @return
 773  *
 774  * @par Errors:
 775  *
 776  * @pre None.
 777  * @post
 778  * @see
 779  * @remarks None.
 780  *
 781  * @par Sample Code:
 782  * @code
 783  * @endcode
 784  */
 785 void insert_request_msg_info(int sync_type, unsigned int request_id, int profile_id);
 786
 787 /**
 788  * @par Description: API to delete request_msg_info_t structure from list
 789  *
 790  *
 791  * @par Purpose:
 792  * @par Typical use case:
 793  * @par Method of function operation:
 794  * @par Important notes:
 795  * @param[in]           request id
 796  * @param[out]
 797  *
 798  * @return
 799  *
 800  * @par Errors:
 801  *
 802  * @pre None.
 803  * @post
 804  * @see
 805  * @remarks None.
 806  *
 807  * @par Sample Code:
 808  * @code
 809  * @endcode
 810  */
 811 void delete_request_msg_info(unsigned int request_id);
 812
 813 /**
 814  * @par Description: API to get synchronizing request id and delete request_msg_info_t structure from list
 815  *
 816  *
 817  * @par Purpose:
 818  * @par Typical use case:
 819  * @par Method of function operation:
 820  * @par Important notes:
 821  * @param[in]
 822  * @param[out]          request id
 823  *
 824  * @return                              true on success
 825  *                                                      false on error
 826  *
 827  * @par Errors:
 828  *
 829  * @pre None.
 830  * @post
 831  * @see
 832  * @remarks None.
 833  *
 834  * @par Sample Code:
 835  * @code
 836  * @endcode
 837  */
 838 bool get_synchronizing_request_id(unsigned int *request_id);
 839
 840 /**
 841  * @par Description: API to get synchronizing profile id
 842  *
 843  *
 844  * @par Purpose:
 845  * @par Typical use case:
 846  * @par Method of function operation:
 847  * @par Important notes:
 848  * @param[in]
 849  * @param[out]          pProfile_id
 850  *
 851  * @return                              true on success
 852  *                                                      false on error
 853  *
 854  * @par Errors:
 855  *
 856  * @pre None.
 857  * @post
 858  * @see
 859  * @remarks None.
 860  *
 861  * @par Sample Code:
 862  * @code
 863  * @endcode
 864  */
 865 bool get_synchronizing_profile_id(int *pProfile_id);
 866
 867 /**
 868  * @par Description: API to get manual sync request id and delete request_msg_info_t structure from list
 869  *
 870  *
 871  * @par Purpose:
 872  * @par Typical use case:
 873  * @par Method of function operation:
 874  * @par Important notes:
 875  * @param[in]
 876  * @param[out]          request id
 877  *
 878  * @return                              true on success
 879  *                                                      false on error
 880  *
 881  * @par Errors:
 882  *
 883  * @pre None.
 884  * @post
 885  * @see
 886  * @remarks None.
 887  *
 888  * @par Sample Code:
 889  * @code
 890  * @endcode
 891  */
 892 bool get_manual_sync_request_id(unsigned int *request_id);
 893
 894 /**
 895  * @par Description: API to get periodic sync request id and delete request_msg_info_t structure from list
 896  *
 897  *
 898  * @par Purpose:
 899  * @par Typical use case:
 900  * @par Method of function operation:
 901  * @par Important notes:
 902  * @param[in]
 903  * @param[out]          request id
 904  *
 905  * @return                              true on success
 906  *                                                      false on error
 907  *
 908  * @par Errors:
 909  *
 910  * @pre None.
 911  * @post
 912  * @see
 913  * @remarks None.
 914  *
 915  * @par Sample Code:
 916  * @code
 917  * @endcode
 918  */
 919 bool get_periodic_sync_request_id(unsigned int *request_id);
 920
 921 /**
 922  * @par Description: API to get SAN sync request id and delete request_msg_info_t structure from list
 923  *
 924  *
 925  * @par Purpose:
 926  * @par Typical use case:
 927  * @par Method of function operation:
 928  * @par Important notes:
 929  * @param[in]
 930  * @param[out]          request id
 931  *
 932  * @return                              true on success
 933  *                                                      false on error
 934  *
 935  * @par Errors:
 936  *
 937  * @pre None.
 938  * @post
 939  * @see
 940  * @remarks None.
 941  *
 942  * @par Sample Code:
 943  * @code
 944  * @endcode
 945  */
 946 bool get_san_sync_request_id(unsigned int *request_id);
 947
 948 /**
 949  * @par Description: API to get auto configure sync request id and delete request_msg_info_t structure from list
 950  *
 951  *
 952  * @par Purpose:
 953  * @par Typical use case:
 954  * @par Method of function operation:
 955  * @par Important notes:
 956  * @param[in]
 957  * @param[out]          request id
 958  *
 959  * @return                              true on success
 960  *                                                      false on error
 961  *
 962  * @par Errors:
 963  *
 964  * @pre None.
 965  * @post
 966  * @see
 967  * @remarks None.
 968  *
 969  * @par Sample Code:
 970  * @code
 971  * @endcode
 972  */
 973 bool get_auto_configure_request_id(unsigned int *request_id);
 974
 975 /**
 976  * @par Description: cancel current sync task(auto configure task or sync task)
 977  *
 978  *      if auto configure task is processing, cancel auto configure task
 979  *      if sync task is processing, cancel sync task
 980  *
 981  * @par Purpose:
 982  * @par Typical use case:
 983  * @par Method of function operation:
 984  * @par Important notes:
 985  * @param[in]
 986  * @param[out]
 987  *
 988  * @return                              true on success
 989  *                                                      false on error
 990  *
 991  * @par Errors:
 992  *
 993  * @pre None.
 994  * @post
 995  * @see
 996  * @remarks None.
 997  *
 998  * @par Sample Code:
 999  * @code
1000  * @endcode
1001  */
1002 bool cancel_current_sync_task();
1003
1004 #endif                          /* ENGINE_CONTROLLER_TASK_H_ */