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