wearable/include/ITapiNetwork.h

   1 /*
   2  * libslp-tapi
   3  *
   4  * Copyright (c) 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Ja-young Gu <jygu@samsung.com>
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  */
  20
  21 /**
  22  * @open
  23  * @ingroup             TelephonyAPI
  24  * @addtogroup  Network_TAPI    NETWORK
  25  * @{
  26  *
  27  * @file ITapiNetwork.h
  28
  29  @brief This file serves as a "C" header file defines functions for Tapi Network\n
  30  It contains a sample set of function prototypes that would be required by applications.
  31  */
  32
  33 #ifndef _ITAPI_NETWORK_H_
  34 #define _ITAPI_NETWORK_H_
  35
  36 #include <tapi_common.h>
  37 #include <TelErr.h>
  38 #include <TelDefines.h>
  39 #include <TelNetwork.h>
  40
  41 #ifdef __cplusplus
  42 extern "C"
  43 {
  44 #endif
  45
  46 /**
  47  * @brief  This function requests the lower layers to select the network automatically
  48  *
  49  * @par Sync (or) Async:
  50  * This is an Asynchronous API.
  51  *
  52  * This function makes Dbus method call to Telephony Sever and returns immediate value.
  53  * However it just means that the API request has been transfered to the CP successfully.
  54  * The actual operation result is being delivered in the corresponding event asynchronously.
  55  *
  56  * @par Important Notes:
  57  * - None.
  58  *
  59  * @warning
  60  * - None.
  61  *
  62  * @param [in] handle
  63  * - handle from tel_init().
  64  *
  65  * @param [in] callback
  66  * - To register callback function for result.
  67  *
  68  * @param [in] user_data
  69  * - user_data for user specification.
  70  *
  71  * @par Async Response Message:
  72  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
  73  * There is no data associated with the response.
  74  *
  75  * @pre
  76  *  - A dbus connection is established with #tel_init
  77  *  - The application name is registered with #tel_register_app_name
  78  *  - The application is registered events to listen asynchronous response with #tel_register_event
  79  *  - A event loop is running to listen events
  80  *
  81  * @post
  82  *  - None.
  83  *
  84  * @return Return Type (int) \n
  85  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
  86  * - Refer #TapiResult_t for failure and error code
  87  *
  88  * @par Prospective Clients:
  89  * External Apps.
  90  *
  91  * @code
  92  * #include <ITapiNetwork.h>
  93  *
  94  * int ret_status;
  95  * TapiHandle *handle;
  96  * tapi_response_cb callback;
  97  * void *user_data;
  98  *
  99  * //SET NETWORK SELECTION AUTOMATIC MODE
 100  * ret_status = tel_select_network_automatic(handle, callback, user_data);
 101  * @endcode
 102  *
 103  * @see
 104  *  - None.
 105  *
 106  * @remarks
 107  *  - None.
 108  *
 109  *
 110  */
 111 /*================================================================================================*/
 112 int tel_select_network_automatic(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 113
 114 /**
 115  * @brief  This function requests the lower layers to select the network (PLMN) which has been selected by the user from the Network List
 116  *           displayed to the User.
 117  *
 118  * @par Sync (or) Async:
 119  * This is an Asynchronous API.
 120  *
 121  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 122  * However it just means that the API request has been transfered to the CP successfully.
 123  * The actual operation result is being delivered in the corresponding event asynchronously.
 124  *
 125  * @par Important Notes:
 126  * - None.
 127  *
 128  * @warning
 129  * - None.
 130  *
 131  * @param [in] handle
 132  * - handle from tel_init().
 133  *
 134  * @param[in] plmn
 135  * - User selected PLMN.
 136
 137  * @param [in] act
 138  * - User selected Access Technology.
 139
 140  * @param [in] callback
 141  * - To register callback function for result.
 142  *
 143  * @param [in] user_data
 144  * - user_data for user specification.
 145  *
 146  * @par Async Response Message:
 147  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 148  * There is no data associated with the response.
 149  *
 150  * @pre
 151  *  - A dbus connection is established with #tel_init
 152  *  - The application name is registered with #tel_register_app_name
 153  *  - The application is registered events to listen asynchronous response with #tel_register_event
 154  *  - A event loop is running to listen events
 155  *
 156  * @post
 157  *  - None.
 158  *
 159  * @return Return Type (int) \n
 160  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 161  * - Refer #TapiResult_t for failure and error code
 162  * @par Prospective Clients:
 163  * External Apps.
 164  *
 165  * @code
 166  * #include <ITapiNetwork.h>
 167  *
 168  * int ret_status;
 169  * unsigned int plmn = 0;
 170  * TapiHandle *handle;
 171  * const char *plmn;
 172  * int act;
 173  * tapi_response_cb callback;
 174  * void *user_data;
 175  *
 176  * //SET NETWORK SELECTION MANUAL MODE
 177  * plmn = 45454;
 178  * act = 0x1; //For GSM.
 179  * ret_status = tel_select_network_manual(handle, plmn, act, callback, user_data);
 180  * @endcode
 181  *
 182  * @see
 183  *  - None.
 184  *
 185  * @remarks
 186  *  - None.
 187  *
 188  *
 189  */
 190 /*================================================================================================*/
 191 int tel_select_network_manual(TapiHandle *handle, const char *plmn, int act, tapi_response_cb callback, void *user_data);
 192
 193 /**
 194  * @brief  This function sends a request to do manual network search for the available networks and provide the
 195  *           Network List to the User/Application.
 196  *
 197  * @par Sync (or) Async:
 198  * This is an Asynchronous API.
 199  *
 200  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 201  * However it just means that the API request has been transfered to the CP successfully.
 202  * The actual operation result is being delivered in the corresponding event asynchronously.
 203  *
 204  * @par Important Notes:
 205  * - None.
 206  *
 207  * @warning
 208  * - None.
 209  *
 210  * @param [in] handle
 211  * - handle from tel_init().
 212  *
 213  * @param [in] callback
 214  * - To register callback function for result.
 215  *
 216  * @param [in] user_data
 217  * - user_data for user specification.
 218  *
 219  * @par Async Response Message:
 220  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 221  * Data associated with the response is #TelNetworkPlmnList_t.
 222  *
 223  * @pre
 224  *  - A dbus connection is established with #tel_init
 225  *  - The application name is registered with #tel_register_app_name
 226  *  - The application is registered events to listen asynchronous response with #tel_register_event
 227  *  - A event loop is running to listen events
 228  *
 229  * @post
 230  *  - In the available network list, user can select one of the networks successfully.
 231  *
 232  * @return Return Type (int) \n
 233  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 234  * - Refer #TapiResult_t for failure and error code
 235  * @par Prospective Clients:
 236  * External Apps.
 237  *
 238  * @code
 239  * #include <ITapiNetwork.h>
 240  *
 241  * int ret_status;
 242  * TapiHandle *handle;
 243  * tapi_response_cb callback;
 244  * void *user_data;
 245  *
 246  * // NETWORK SEARCH
 247  * ret_status = tel_search_network(handle, callback, user_data);
 248  * @endcode
 249  *
 250  * @see
 251  *  - None.
 252  *
 253  * @remarks
 254  *  - None.
 255  *
 256  *
 257  */
 258 /*================================================================================================*/
 259 int tel_search_network(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 260
 261 /**
 262  * @brief  This function requests for the present network selection mode i.e. automatic or manual.
 263  *
 264  * @par Sync (or) Async:
 265  * This is an Asynchronous API.
 266  *
 267  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 268  * However it just means that the API request has been transfered to the CP successfully.
 269  * The actual operation result is being delivered in the corresponding event asynchronously.
 270  *
 271  * @par Important Notes:
 272  * - None.
 273  *
 274  * @warning
 275  * - None.
 276  *
 277  * @param [in] handle
 278  * - handle from tel_init().
 279  *
 280  * @param [in] callback
 281  * - To register callback function for result.
 282  *
 283  * @param [in] user_data
 284  * - user_data for user specification.
 285  *
 286  * @par Async Response Message:
 287  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 288  * Data associated with the response is #TelNetworkSelectionMode_t.
 289  *
 290  * @pre
 291  *  - A dbus connection is established with #tel_init
 292  *  - The application name is registered with #tel_register_app_name
 293  *  - The application is registered events to listen asynchronous response with #tel_register_event
 294  *  - A event loop is running to listen events
 295  *
 296  * @post
 297  *  - None.
 298  *
 299  * @return Return Type (int) \n
 300  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 301  * - Refer #TapiResult_t for failure and error code
 302  * @par Prospective Clients:
 303  * External Apps.
 304  *
 305  * @code
 306  * #include <ITapiNetwork.h>
 307  *
 308  * int ret_status;
 309  * TapiHandle *handle;
 310  * tapi_response_cb callback;
 311  * void *user_data;
 312  *
 313  * // GET NETWORK SELECTION MODE
 314  * ret_status = tel_get_network_selection_mode (handle, callback, user_data);
 315  * @endcode
 316  *
 317  * @see
 318  *  - None.
 319  *
 320  * @remarks
 321  *  - None.
 322  *
 323  *
 324  *
 325  */
 326 /*================================================================================================*/
 327 int tel_get_network_selection_mode(struct tapi_handle *handle, tapi_response_cb callback, void *user_data);
 328
 329 /**
 330  * @brief  This function is called when User/application wants to configure the service domain to only CS or only PS or Both.
 331  * This API triggers the underlying protocol stack to do register with Network for only CS services or only PS services
 332  * or both based on the option set using this API.
 333  *
 334  * @par Sync (or) Async:
 335  * This is an Asynchronous API.
 336  *
 337  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 338  * However it just means that the API request has been transfered to the CP successfully.
 339  * The actual operation result is being delivered in the corresponding event asynchronously.
 340  *
 341  * @par Important Notes:
 342  * - None.
 343  *
 344  * @warning
 345  * - None.
 346  *
 347  *
 348  * @param [in] handle
 349  * - handle from tel_init().
 350  *
 351  * @param[in] ServiceDomain
 352  * - Specifies the type of Service domain (Packet switch, Circuit switch or both)
 353  *
 354  * @param [in] callback
 355  * - To register callback function for result.
 356  *
 357  * @param [in] user_data
 358  * - user_data for user specification.
 359  *
 360  * @par Async Response Message:
 361  * The event associated is TAPI_EVENT_NETWORK_SET_SVC_DOMAIN_CNF and there is no event data associated with this event
 362  * and asynchronous return status is indicated by #TelNetworkOperationCause_t.
 363  *
 364  * @pre
 365  *  - A dbus connection is established with #tel_init
 366  *  - The application name is registered with #tel_register_app_name
 367  *  - The application is registered events to listen asynchronous response with #tel_register_event
 368  *  - A event loop is running to listen events
 369  *
 370  * @post
 371  *  - None.
 372  *
 373  * @return Return Type (int) \n
 374  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 375  * - Refer #TapiResult_t for failure and error code
 376  *
 377  * @par Prospective Clients:
 378  * External Apps.
 379  *
 380  * @code
 381  * #include <ITapiNetwork.h>
 382  *
 383  * int ret_status;
 384  * TapiHandle *handle;
 385  * TelNetworkServiceDomain_t domain;
 386  * tapi_response_cb callback;
 387  * void *user_data;
 388  *
 389  * // SET NETWORK SERVICE DOMAIN
 390  * domain = TAPI_NETWORK_SERVICE_DOMAIN_AUTOMATIC;
 391  *
 392  * ret_status = tel_set_network_service_domain (handle, domain, callback, user_data);
 393  * @endcode
 394  *
 395  * @see
 396  *  - None.
 397  *
 398  * @remarks
 399  *  - None.
 400  *
 401  *
 402  */
 403 /*================================================================================================*/
 404 int tel_set_network_service_domain(TapiHandle *handle, TelNetworkServiceDomain_t domain,
 405                 tapi_response_cb callback, void *user_data);
 406
 407 /**
 408  * @brief  This function requests for the present network service domain i.e. CS or PS or both or automatic.
 409  *
 410  * @par Sync (or) Async:
 411  * This is an Asynchronous API.
 412  *
 413  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 414  * However it just means that the API request has been transfered to the CP successfully.
 415  * The actual operation result is being delivered in the corresponding event asynchronously.
 416  *
 417  * @par Important Notes:
 418  * - None.
 419  *
 420  * @warning
 421  * - None.
 422  *
 423  * @param [in] handle
 424  * - handle from tel_init().
 425  *
 426  * @param [in] callback
 427  * - To register callback function for result.
 428  *
 429  * @param [in] user_data
 430  * - user_data for user specification.
 431  *
 432  * @par Async Response Message:
 433  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 434  * Data associated with the response is #TelNetworkServiceDomain_t.
 435  *
 436  * @pre
 437  *  - A dbus connection is established with #tel_init
 438  *  - The application name is registered with #tel_register_app_name
 439  *  - The application is registered events to listen asynchronous response with #tel_register_event
 440  *  - A event loop is running to listen events
 441  *
 442  * @post
 443  *  - None.
 444  *
 445  * @return Return Type (int) \n
 446  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 447  * - Refer #TapiResult_t for failure and error code
 448  * @par Prospective Clients:
 449  * External Apps.
 450  *
 451  * @code
 452  * #include <ITapiNetwork.h>
 453  *
 454  * int ret_status;
 455  * TapiHandle *handle;
 456  * tapi_response_cb callback;
 457  * void *user_data;
 458  *
 459  * // GET NETWORK SERVICE DOMAIN
 460  * ret_status = tel_get_network_service_domain (handle, callback, user_data);
 461  *
 462  * @endcode
 463  *
 464  * @see
 465  *  - None.
 466  *
 467  * @remarks
 468  *  - None.
 469  *
 470  *
 471  */
 472 /*================================================================================================*/
 473 int tel_get_network_service_domain(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 474
 475
 476 /**
 477  * @brief  This function is invoked to set the network band and allows the underlying OEM provider to scan the set band.
 478  *
 479  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 480  * However it just means that the API request has been transfered to the CP successfully.
 481  * The actual operation result is being delivered in the corresponding event asynchronously.
 482  *
 483  * @par Sync (or) Async:
 484  * This is an Asynchronous API.
 485  *
 486  * @par Important Notes:
 487  * - None.
 488  *
 489  * @warning
 490  * - None.
 491  *
 492  *
 493  * @param [in] handle
 494  * - handle from tel_init().
 495  *
 496  * @param[in]  mode
 497  * - Band preference indicates the band provided to be preferred or selected band.
 498  *
 499  * @param[in]  band
 500  * - This enumeration defines different network bands that user can choose.
 501  *
 502  * @param [in] callback
 503  * - To register callback function for result.
 504  *
 505  * @param [in] user_data
 506  * - user_data for user specification.
 507  *
 508  * @par Async Response Message:
 509  * The event associated is TAPI_EVENT_NETWORK_SETNWBAND_CNF and there is no event data associated with this event and asynchronous
 510  * return status is indicated by #TelNetworkOperationCause_t.
 511  *
 512  * @pre
 513  *  - A dbus connection is established with #tel_init
 514  *  - The application name is registered with #tel_register_app_name
 515  *  - The application is registered events to listen asynchronous response with #tel_register_event
 516  *  - A event loop is running to listen events
 517  *
 518  * @post
 519  *  - None.
 520  *
 521  * @return Return Type (int) \n
 522  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 523  * - Refer #TapiResult_t for failure and error code
 524  * @par Prospective Clients:
 525  * External Apps.
 526  *
 527  * @code
 528  * #include <ITapiNetwork.h>
 529  *
 530  * int ret_status;
 531  * TapiHandle *handle;
 532  * TelNetworkBandPreferred_t mode;
 533  * TelNetworkBand_t band;
 534  * tapi_response_cb callback;
 535  * void *user_data;
 536  *
 537  * mode = TAPI_NETWORK_BAND_MODE_PREFERRED;
 538  * band = TAPI_NETWORK_BAND_TYPE_GSM_900_1800;
 539  *
 540  * // SET NETWORK BAND
 541  * ret_status = tel_set_network_band (handle, mode, band, callback, user_data);
 542  *
 543  * @endcode
 544  *
 545  * @see
 546  *  - None.
 547  *
 548  * @remarks
 549  *  - None.
 550  *
 551  *
 552  *
 553  */
 554 /*================================================================================================*/
 555 int tel_set_network_band(TapiHandle *handle, TelNetworkBandPreferred_t mode,
 556                 TelNetworkBand_t band, tapi_response_cb callback, void *user_data);
 557
 558 /**
 559  * @brief  This function requests for the present network band.
 560  *
 561  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 562  * However it just means that the API request has been transfered to the CP successfully.
 563  * The actual operation result is being delivered in the corresponding event asynchronously.
 564  *
 565  * @par Sync (or) Async:
 566  * This is an Asynchronous API.
 567  *
 568  * @par Important Notes:
 569  * - None.
 570  *
 571  * @warning
 572  * - None.
 573  *
 574  *
 575  * @param [in] handle
 576  * - handle from tel_init().
 577  *
 578  * @param [in] callback
 579  * - To register callback function for result.
 580  *
 581  * @param [in] user_data
 582  * - user_data for user specification.
 583  *
 584  * @par Async Response Message:
 585  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 586  * Data associated with the response is #TelNetworkBand_t.
 587  *
 588  * @pre
 589  *  - A dbus connection is established with #tel_init
 590  *  - The application name is registered with #tel_register_app_name
 591  *  - The application is registered events to listen asynchronous response with #tel_register_event
 592  *  - A event loop is running to listen events
 593  *
 594  * @post
 595  *  - None.
 596  *
 597  * @return Return Type (int) \n
 598  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 599  * - Refer #TapiResult_t for failure and error code
 600  * @par Prospective Clients:
 601  * External Apps.
 602  *
 603  * @code
 604  * #include <ITapiNetwork.h>
 605  *
 606  * int ret_status;
 607  * TapiHandle *handle;
 608  * tapi_response_cb callback;
 609  * void *user_data;
 610  *
 611  * // GET NETWORK BAND
 612  * ret_status = tel_get_network_band(handle, callback, user_data);
 613  *
 614  * @endcode
 615  *
 616  * @see
 617  *  - None.
 618  *
 619  * @remarks
 620  *  - None.
 621  *
 622  *
 623  *
 624  */
 625 /*================================================================================================*/
 626 int tel_get_network_band(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 627
 628 /**
 629  * @brief  This function is invoked to set the network preferred plmn
 630  *
 631  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 632  * However it just means that the API request has been transfered to the CP successfully.
 633  * The actual operation result is being delivered in the corresponding event asynchronously.
 634  *
 635  * @par Sync (or) Async:
 636  * This is an Asynchronous API.
 637  *
 638  * @par Important Notes:
 639  * - None.
 640  *
 641  * @warning
 642  * - None.
 643  *
 644  *
 645  * @param [in] handle
 646  * - handle from tel_init().
 647  *
 648  * @param[in]  operation
 649  * - Operation indicates the operation to be done on preferred plmn .
 650  *
 651  * @param[in]  info
 652  * - This gives the plmn Info.
 653  *
 654  * @param [in] callback
 655  * - To register callback function for result.
 656  *
 657  * @param [in] user_data
 658  * - user_data for user specification.
 659  *
 660  * @par Async Response Message:
 661  * The event associated is TAPI_EVENT_NETWORK_SETPREFFPLMN_CNF and there is no event data associated with this event and asynchronous
 662  * return status is indicated by #TelNetworkOperationCause_t.
 663  *
 664  * @pre
 665  *  - A dbus connection is established with #tel_init
 666  *  - The application name is registered with #tel_register_app_name
 667  *  - The application is registered events to listen asynchronous response with #tel_register_event
 668  *  - A event loop is running to listen events
 669  *
 670  * @post
 671  *  - None.
 672  *
 673  * @return Return Type (int) \n
 674  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 675  * - Refer #TapiResult_t for failure and error code
 676  * @par Prospective Clients:
 677  * External Apps.
 678  *
 679  * @code
 680  * #include <ITapiNetwork.h>
 681  *
 682  * int ret_status;
 683  * TapiHandle *handle;
 684  * TelNetworkPreferredPlmnOp_t operation;
 685  * TelNetworkPreferredPlmnInfo_t info;
 686  * tapi_response_cb callback;
 687  * void *user_data;
 688  *
 689  * unsigned char *plmn = "45454";
 690  *
 691  * operation = TAPI_NETWORK_PREF_PLMN_ADD;
 692  * memset(&info, 0, sizeof(TelNetworkPreferredPlmnInfo_t));
 693  * info.Index = 0;
 694  * info.SystemType = TAPI_NETWORK_SYSTEM_GSM;
 695  * memcpy(info.Plmn, plmn, strlen(plmn));
 696  *
 697  * // SET NETWORK PREFERRED PLMN
 698  * ret_status = tel_set_network_preferred_plmn(handle, operation, &info, callback, user_data);
 699  *
 700  * @endcode
 701  *
 702  * @see
 703  *  - None.
 704  *
 705  * @remarks
 706  *  - None.
 707  *
 708  *
 709  *
 710  */
 711 /*================================================================================================*/
 712 int tel_set_network_preferred_plmn(TapiHandle *handle, TelNetworkPreferredPlmnOp_t operation,
 713                 TelNetworkPreferredPlmnInfo_t *info, tapi_response_cb callback, void *user_data);
 714
 715 /**
 716  * @brief  This function is invoked to get the preferred plmn list
 717  *
 718  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 719  * However it just means that the API request has been transfered to the CP successfully.
 720  * The actual operation result is being delivered in the corresponding event asynchronously.
 721  *
 722  * @par Sync (or) Async:
 723  * This is an Asynchronous API.
 724  *
 725  * @par Important Notes:
 726  * - None.
 727  *
 728  * @warning
 729  * - None.
 730  *
 731  * @param [in] handle
 732  * - handle from tel_init().
 733  *
 734  * @param [in] callback
 735  * - To register callback function for result.
 736  *
 737  * @param [in] user_data
 738  * - user_data for user specification.
 739  *
 740  *
 741  * @par Async Response Message:
 742  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 743  * Data associated with the response is #TelNetworkPreferredPlmnList_t.
 744  *
 745  * @pre
 746  *  - A dbus connection is established with #tel_init
 747  *  - The application name is registered with #tel_register_app_name
 748  *  - The application is registered events to listen asynchronous response with #tel_register_event
 749  *  - A event loop is running to listen events
 750  *
 751  * @post
 752  *  - None.
 753  *
 754  * @return Return Type (int) \n
 755  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 756  * - Refer #TapiResult_t for failure and error code
 757  * @par Prospective Clients:
 758  * External Apps.
 759  *
 760  * @code
 761  * #include <ITapiNetwork.h>
 762  *
 763  * int ret_status;
 764  * TapiHandle *handle;
 765  * tapi_response_cb callback;
 766  * void *user_data;
 767  *
 768  * // GET NETWORK PREFERRED PLMN
 769  * ret_status = tel_get_network_preferred_plmn(handle, callback, user_data);
 770  *
 771  * @endcode
 772  *
 773  * @see
 774  *  - None.
 775  *
 776  * @remarks
 777  *  - None.
 778  *
 779  *
 780  *
 781  */
 782 /*================================================================================================*/
 783 int tel_get_network_preferred_plmn(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 784
 785
 786 /**
 787  * @brief  This function is called to cancel the triggered manual network search.
 788  *
 789  * @par Sync (or) Async:
 790  * This is an Asynchronous API.
 791  *
 792  * @par Important Notes:
 793  * - None.
 794  *
 795  * @warning
 796  * - None.
 797  *
 798  * @param [in] handle
 799  * - handle from tel_init().
 800  *
 801  * @param [in] callback
 802  * - To register callback function for result.
 803  *
 804  * @param [in] user_data
 805  * - user_data for user specification.
 806  *
 807  * @par Async Response Message:
 808  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 809  * There is no data associated with the response.
 810  *
 811  * @pre
 812  *  - Manual network search is already triggered.
 813  *
 814  * @post
 815  *  - None.
 816  *
 817  * @return Return Type (int) \n
 818  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 819  * - Refer #TapiResult_t for failure and error code
 820  *
 821  * @par Prospective Clients:
 822  * External Apps.
 823  *
 824  * @code
 825  * #include <ITapiNetwork.h>
 826  *
 827  * int ret_status;
 828  * TapiHandle *handle;
 829  * tapi_response_cb callback;
 830  * void *user_data;
 831  *
 832  * // CANCEL NETWORK MANUAL SEARCH
 833  * ret_status = tel_cancel_network_manual_search(handle, callback, user_data);
 834  *
 835  * @endcode
 836  *
 837  * @see
 838  *  - None.
 839  *
 840  * @remarks
 841  *  - None.
 842  *
 843  */
 844 /*================================================================================================*/
 845 int tel_cancel_network_manual_search(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 846
 847 /**
 848  * @brief  This function is called to get network serving information
 849  *
 850  * @par Sync (or) Async:
 851  * This is an Asynchronous API.
 852  *
 853  * @par Important Notes:
 854  * - None.
 855  *
 856  * @warning
 857  * - None.
 858  *
 859  * @param [in] handle
 860  * - handle from tel_init().
 861  *
 862  * @param [in] callback
 863  * - To register callback function for result.
 864  *
 865  * @param [in] user_data
 866  * - user_data for user specification.
 867  *
 868  * @par Async Response Message:
 869  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 870  * Data associated with the response is #TelNetworkServing_t.
 871  *
 872  * @pre
 873  *
 874  * @post
 875  *  - None.
 876  *
 877  * @return Return Type (int) \n
 878  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 879  * - Refer #TapiResult_t for failure and error code
 880  *
 881  * @par Prospective Clients:
 882  * External Apps.
 883  *
 884  * @code
 885  * #include <ITapiNetwork.h>
 886  *
 887  * int ret_status;
 888  * TapiHandle *handle;
 889  * tapi_response_cb callback;
 890  * void *user_data;
 891  *
 892  * // GET NETWORK SERVING
 893  * ret_status = tel_get_network_serving(handle, callback, user_data);
 894  *
 895  * @endcode
 896  *
 897  * @see
 898  *  - None.
 899  *
 900  * @remarks
 901  *  - None.
 902  *
 903  *
 904  */
 905 /*================================================================================================*/
 906 int tel_get_network_serving(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 907
 908 /**
 909  * @brief  This function is called to set network mode.
 910  *
 911  * @par Sync (or) Async:
 912  * This is an Asynchronous API.
 913  *
 914  * @par Important Notes:
 915  * - None.
 916  *
 917  * @warning
 918  * - None.
 919  *
 920  * @param [in] handle
 921  * - handle from tel_init().
 922  *
 923  * @param [in] mode
 924  * - Specifies the network mode (GSM only or WCDMA only or Automatic etc)
 925  *
 926  * @param [in] callback
 927  * - To register callback function for result.
 928  *
 929  * @param [in] user_data
 930  * - user_data for user specification.
 931  *
 932  * @par Async Response Message:
 933  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 934  * There is no data associated with the response.
 935  *
 936  * @pre
 937  *
 938  * @post
 939  *  - None.
 940  *
 941  * @return Return Type (int) \n
 942  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 943  * - Refer #TapiResult_t for failure and error code
 944  *
 945  * @par Prospective Clients:
 946  * External Apps.
 947  *
 948  * @code
 949  * #include <ITapiNetwork.h>
 950  *
 951  * int ret_status;
 952  * TapiHandle *handle;
 953  * int mode;
 954  * tapi_response_cb callback;
 955  * void *user_data;
 956  *
 957  * mode = 0x01; //GSM mode
 958  * // SET NETWORK MODE
 959  * ret_status = tel_set_network_mode(handle, mode, callback, user_data);
 960  *
 961  * @endcode
 962  *
 963  * @see
 964  *  - None.
 965  *
 966  * @remarks
 967  *  - None.
 968  *
 969  */
 970 /*================================================================================================*/
 971 int tel_set_network_mode(TapiHandle *handle, int mode, tapi_response_cb callback, void *user_data);
 972
 973 /**
 974  * @brief  This function is called to get network mode.
 975  *
 976  * @par Sync (or) Async:
 977  * This is an Asynchronous API.
 978  *
 979  * @par Important Notes:
 980  * - None.
 981  *
 982  * @warning
 983  * - None.
 984  *
 985  * @param [in] handle
 986  * - handle from tel_init().
 987  *
 988  * @param [in] callback
 989  * - To register callback function for result.
 990  *
 991  * @param [in] user_data
 992  * - user_data for user specification.
 993  *
 994  * @par Async Response Message:
 995  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 996  * Data associated with the response is GSM only or WCDMA only or Automatic etc.
 997  *
 998  * @pre
 999  *
1000  * @post
1001  *  - None.
1002  *
1003  * @return Return Type (int) \n
1004  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
1005  * - Refer #TapiResult_t for failure and error code
1006  *
1007  * @par Prospective Clients:
1008  * External Apps.
1009  *
1010  * @code
1011  * #include <ITapiNetwork.h>
1012  *
1013  * int ret_status;
1014  * TapiHandle *handle;
1015  * tapi_response_cb callback;
1016  * void *user_data;
1017  *
1018  * // GET NETWORK MODE
1019  * ret_status = tel_get_network_mode(handle, callback, user_data);
1020  *
1021  * @endcode
1022  *
1023  * @see
1024  *  - None.
1025  *
1026  * @remarks
1027  *  - None.
1028  *
1029  */
1030 /*================================================================================================*/
1031 int tel_get_network_mode(TapiHandle *handle, tapi_response_cb callback, void *user_data);
1032
1033 /**
1034  * @brief  This function is called to get neighboring cell info.
1035  *
1036  * @par Sync (or) Async:
1037  * This is an Asynchronous API.
1038  *
1039  * @par Important Notes:
1040  * - None.
1041  *
1042  * @warning
1043  * - None.
1044  *
1045  * @param [in] handle
1046  * - handle from tel_init().
1047  *
1048  * @param [in] callback
1049  * - To register callback function for result.
1050  *
1051  * @param [in] user_data
1052  * - user_data for user specification.
1053  *
1054  * @par Async Response Message:
1055  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
1056  * Data associated with the response is #TelNetworkNeighboringCellInfo_t.
1057  *
1058  * @pre
1059  *
1060  * @post
1061  *  - None.
1062  *
1063  * @return Return Type (int) \n
1064  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
1065  * - Refer #TapiResult_t for failure and error code
1066  *
1067  * @par Prospective Clients:
1068  * External Apps.
1069  *
1070  * @code
1071  * #include <ITapiNetwork.h>
1072  *
1073  * int ret_status;
1074  * TapiHandle *handle;
1075  * tapi_response_cb callback;
1076  * void *user_data;
1077  *
1078  * // GET NETWORK NEIGHBORING CELL INFO
1079  * ret_status = tel_get_network_neighboring_cell_info(handle, callback, user_data);
1080  *
1081  * @endcode
1082  *
1083  * @see
1084  *  - None.
1085  *
1086  * @remarks
1087  *  - None.
1088  *
1089  */
1090 /*================================================================================================*/
1091 int tel_get_network_neighboring_cell_info(TapiHandle *handle, tapi_response_cb callback, void *user_data);
1092
1093 #ifdef __cplusplus
1094 }
1095 #endif
1096
1097 #endif  /* _ITAPI_NETWORK_H_ */
1098
1099 /**
1100  * @}
1101  */