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  * - This function passes the
  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  * The event associated is TAPI_EVENT_NETWORK_SELECT_CNF and there is no data associated with this event. Asynchronous return status
  73  * is indicated by #TelNetworkOperationCause_t.
  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  * int RequestID;
  96  *
  97  * // AUTOMATIC MODE
  98  * ret_status = tel_select_network_automatic(&RequestId);
  99  * @endcode
 100  *
 101  * @see
 102  *  - None.
 103  *
 104  * @remarks
 105  *  - None.
 106  *
 107  *
 108  */
 109 /*================================================================================================*/
 110 int tel_select_network_automatic(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 111
 112 /**
 113  * @brief  This function requests the lower layers to select the network (PLMN) which has been selected by the user from the Network List
 114  *           displayed to the User.
 115  *
 116  * @par Sync (or) Async:
 117  * This is an Asynchronous API.
 118  *
 119  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 120  * However it just means that the API request has been transfered to the CP successfully.
 121  * The actual operation result is being delivered in the corresponding event asynchronously.
 122  *
 123  * @par Important Notes:
 124  * - This function passes the .
 125  *
 126  * @warning
 127  * - None.
 128  *
 129  * @param [in] handle
 130  * - handle from tel_init().
 131  *
 132  * @param[in] plmn
 133  *
 134  * @param [in] act
 135  *
 136  * @param [in] callback
 137  * - To register callback function for result.
 138  *
 139  * @param [in] user_data
 140  * - user_data for user specification.
 141  *
 142  * @par Async Response Message:
 143  * The event associated is TAPI_EVENT_NETWORK_SELECT_CNF and there is no data associated with this event. Asynchronous return status
 144  * is indicated by #TelNetworkOperationCause_t.
 145  *
 146  * @pre
 147  *  - A dbus connection is established with #tel_init
 148  *  - The application name is registered with #tel_register_app_name
 149  *  - The application is registered events to listen asynchronous response with #tel_register_event
 150  *  - A event loop is running to listen events
 151  *
 152  * @post
 153  *  - None.
 154  *
 155  * @return Return Type (int) \n
 156  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 157  * - Refer #TapiResult_t for failure and error code
 158  * @par Prospective Clients:
 159  * External Apps.
 160  *
 161  * @code
 162  * #include <ITapiNetwork.h>
 163  *
 164  * int ret_status;
 165  * int RequestID;
 166  * unsigned int plmn = 0;
 167  *
 168  * // MANUAL MODE
 169  * plmn = 45454;
 170  * ret_status = tel_select_network_manual(Plmn, &RequestId);
 171  * @endcode
 172  *
 173  * @see
 174  *  - None.
 175  *
 176  * @remarks
 177  *  - None.
 178  *
 179  *
 180  */
 181 /*================================================================================================*/
 182 int tel_select_network_manual(TapiHandle *handle, const char *plmn, int act, tapi_response_cb callback, void *user_data);
 183
 184 /**
 185  * @brief  This function sends a request to do manual network selection to search for the available networks and provide the
 186  *           Network List to the User/Application.
 187  *
 188  * @par Sync (or) Async:
 189  * This is an Asynchronous API.
 190  *
 191  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 192  * However it just means that the API request has been transfered to the CP successfully.
 193  * The actual operation result is being delivered in the corresponding event asynchronously.
 194  *
 195  * @par Important Notes:
 196  * - None.
 197  *
 198  * @warning
 199  * - None.
 200  *
 201  * @param [in] handle
 202  * - handle from tel_init().
 203  *
 204  * @param [in] callback
 205  * - To register callback function for result.
 206  *
 207  * @param [in] user_data
 208  * - user_data for user specification.
 209  *
 210  * @par Async Response Message:
 211  * The event associated is TAPI_EVENT_NETWORK_SEARCH_CNF and the event data is #TelNetworkPlmnList_t.
 212  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 213  *
 214  * @pre
 215  *  - A dbus connection is established with #tel_init
 216  *  - The application name is registered with #tel_register_app_name
 217  *  - The application is registered events to listen asynchronous response with #tel_register_event
 218  *  - A event loop is running to listen events
 219  *
 220  * @post
 221  *  - In the available network list, user can select one of the networks successfully.
 222  *
 223  * @return Return Type (int) \n
 224  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 225  * - Refer #TapiResult_t for failure and error code
 226  * @par Prospective Clients:
 227  * External Apps.
 228  *
 229  * @code
 230  * #include <ITapiNetwork.h>
 231  *
 232  * int ret_status;
 233  * int RequestID;
 234  *
 235  * // NETWORK SEARCH
 236  * ret_status = tel_search_network(&RequestId);
 237  * @endcode
 238  *
 239  * @see
 240  *  - None.
 241  *
 242  * @remarks
 243  *  - None.
 244  *
 245  *
 246  */
 247 /*================================================================================================*/
 248 int tel_search_network(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 249
 250 /**
 251  * @brief  This function requests for the present network selection mode i.e. automatic or manual.
 252  *
 253  * @par Sync (or) Async:
 254  * This is an Asynchronous API.
 255  *
 256  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 257  * However it just means that the API request has been transfered to the CP successfully.
 258  * The actual operation result is being delivered in the corresponding event asynchronously.
 259  *
 260  * @par Important Notes:
 261  * - None.
 262  *
 263  * @warning
 264  * - None.
 265  *
 266  * @param [in] handle
 267  * - handle from tel_init().
 268  *
 269  * @param [in] callback
 270  * - To register callback function for result.
 271  *
 272  * @param [in] user_data
 273  * - user_data for user specification.
 274  *
 275  * @par Async Response Message:
 276  * The event associated is TAPI_EVENT_NETWORK_GETSELECTIONMODE_CNF and the event data is #TelNetworkSelectionMode_t.
 277  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 278  *
 279  * @pre
 280  *  - A dbus connection is established with #tel_init
 281  *  - The application name is registered with #tel_register_app_name
 282  *  - The application is registered events to listen asynchronous response with #tel_register_event
 283  *  - A event loop is running to listen events
 284  *
 285  * @post
 286  *  - None.
 287  *
 288  * @return Return Type (int) \n
 289  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 290  * - Refer #TapiResult_t for failure and error code
 291  * @par Prospective Clients:
 292  * External Apps.
 293  *
 294  * @code
 295  * #include <ITapiNetwork.h>
 296  *
 297  * int ret_status;
 298  * int RequestId;
 299  *
 300  * // GET THE SELECTION MODE
 301  * ret_status = tel_get_network_selection_mode (&RequestId);
 302  * @endcode
 303  *
 304  * @see
 305  *  - None.
 306  *
 307  * @remarks
 308  *  - None.
 309  *
 310  *
 311  *
 312  */
 313 /*================================================================================================*/
 314 int tel_get_network_selection_mode(struct tapi_handle *handle, tapi_response_cb callback, void *user_data);
 315
 316 /**
 317  * @brief  This function is called when User/application wants to configure the service domain to only CS or Only PS or Both.
 318  * This API triggers the underlying protocol stack to do register with Network for only CS services or only PS services
 319  * or both based on the option set using this API.
 320  *
 321  * @par Sync (or) Async:
 322  * This is an Asynchronous API.
 323  *
 324  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 325  * However it just means that the API request has been transfered to the CP successfully.
 326  * The actual operation result is being delivered in the corresponding event asynchronously.
 327  *
 328  * @par Important Notes:
 329  * - None.
 330  *
 331  * @warning
 332  * - None.
 333  *
 334  *
 335  * @param [in] handle
 336  * - handle from tel_init().
 337  *
 338  * @param[in] ServiceDomain
 339  * - Specifies the type of Service domain (Packet switch, circuit switch,etc)
 340  *
 341  * @param [in] callback
 342  * - To register callback function for result.
 343  *
 344  * @param [in] user_data
 345  * - user_data for user specification.
 346  *
 347  * @par Async Response Message:
 348  * The event associated is TAPI_EVENT_NETWORK_SET_SVC_DOMAIN_CNF and there is no event data associated with this event
 349  * and asynchronous return status is indicated by #TelNetworkOperationCause_t.
 350  *
 351  * @pre
 352  *  - A dbus connection is established with #tel_init
 353  *  - The application name is registered with #tel_register_app_name
 354  *  - The application is registered events to listen asynchronous response with #tel_register_event
 355  *  - A event loop is running to listen events
 356  *
 357  * @post
 358  *  - None.
 359  *
 360  * @return Return Type (int) \n
 361  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 362  * - Refer #TapiResult_t for failure and error code
 363  *
 364  * @par Prospective Clients:
 365  * External Apps.
 366  *
 367  * @code
 368  * #include <ITapiNetwork.h>
 369  *
 370  * int ret_status;
 371  * int RequestId;
 372  *
 373  * // SET NETWORK SERVICE DOMAIN
 374  * TelNetworkServiceDomain_t ServiceDomain = TAPI_NETWORK_SERVICE_DOMAIN_AUTOMATIC;
 375  *
 376  * ret_status = tel_set_network_service_domain (ServiceDomain, &RequestId);
 377  * @endcode
 378  *
 379  * @see
 380  *  - None.
 381  *
 382  * @remarks
 383  *  - None.
 384  *
 385  *
 386  */
 387 /*================================================================================================*/
 388 int tel_set_network_service_domain(TapiHandle *handle, TelNetworkServiceDomain_t domain,
 389                 tapi_response_cb callback, void *user_data);
 390
 391 /**
 392  * @brief  This function requests for the present network service domain i.e. CS or PS or both or automatic.
 393  *
 394  * @par Sync (or) Async:
 395  * This is an Asynchronous API.
 396  *
 397  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 398  * However it just means that the API request has been transfered to the CP successfully.
 399  * The actual operation result is being delivered in the corresponding event asynchronously.
 400  *
 401  * @par Important Notes:
 402  * - None.
 403  *
 404  * @warning
 405  * - None.
 406  *
 407  * @param [in] handle
 408  * - handle from tel_init().
 409  *
 410  * @param [in] callback
 411  * - To register callback function for result.
 412  *
 413  * @param [in] user_data
 414  * - user_data for user specification.
 415  *
 416  * @par Async Response Message:
 417  * The event associated is TAPI_EVENT_NETWORK_GET_SVC_DOMAIN_CNF and the event data is #TelNetworkServiceDomain_t.
 418  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 419  *
 420  * @pre
 421  *  - A dbus connection is established with #tel_init
 422  *  - The application name is registered with #tel_register_app_name
 423  *  - The application is registered events to listen asynchronous response with #tel_register_event
 424  *  - A event loop is running to listen events
 425  *
 426  * @post
 427  *  - None.
 428  *
 429  * @return Return Type (int) \n
 430  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 431  * - Refer #TapiResult_t for failure and error code
 432  * @par Prospective Clients:
 433  * External Apps.
 434  *
 435  * @code
 436  * #include <ITapiNetwork.h>
 437  *
 438  * int ret_status;
 439  * int RequestId;
 440  *
 441  * // GET NETWORK SERVICE DOMAIN
 442  * ret_status = tel_get_network_service_domain (&RequestId);
 443  *
 444  * @endcode
 445  *
 446  * @see
 447  *  - None.
 448  *
 449  * @remarks
 450  *  - None.
 451  *
 452  *
 453  */
 454 /*================================================================================================*/
 455 int tel_get_network_service_domain(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 456
 457
 458 /**
 459  * @brief  This function is invoked to set the network band and allows the underlying OEM provider to scan the set band.
 460  *
 461  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 462  * However it just means that the API request has been transfered to the CP successfully.
 463  * The actual operation result is being delivered in the corresponding event asynchronously.
 464  *
 465  * @par Sync (or) Async:
 466  * This is an Asynchronous API.
 467  *
 468  * @par Important Notes:
 469  * - None.
 470  *
 471  * @warning
 472  * - None.
 473  *
 474  *
 475  * @param [in] handle
 476  * - handle from tel_init().
 477  *
 478  * @param[in]  mode
 479  * - Band preference indicates the band provide to be preferred or select the band.
 480  *
 481  * @param[in]  band
 482  * - This enumeration defines different network Bands that user can choose.
 483  *
 484  * @param [in] callback
 485  * - To register callback function for result.
 486  *
 487  * @param [in] user_data
 488  * - user_data for user specification.
 489  *
 490  * @par Async Response Message:
 491  * The event associated is TAPI_EVENT_NETWORK_SETNWBAND_CNF and there is no event data associated with this event and asynchronous
 492  * return status is indicated by #TelNetworkOperationCause_t.
 493  *
 494  * @pre
 495  *  - A dbus connection is established with #tel_init
 496  *  - The application name is registered with #tel_register_app_name
 497  *  - The application is registered events to listen asynchronous response with #tel_register_event
 498  *  - A event loop is running to listen events
 499  *
 500  * @post
 501  *  - None.
 502  *
 503  * @return Return Type (int) \n
 504  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 505  * - Refer #TapiResult_t for failure and error code
 506  * @par Prospective Clients:
 507  * External Apps.
 508  *
 509  * @code
 510  * #include <ITapiNetwork.h>
 511  *
 512  * int ret_status;
 513  * int RequestId;
 514  *
 515  * TelNetworkBandPreferred_t BandMode = TAPI_NETWORK_BAND_MODE_PREFERRED;
 516  * TelNetworkBand_t Band = TAPI_NETWORK_BAND_TYPE_GSM_900_1800;
 517  *
 518  * // SET NETWORK BAND
 519  * ret_status = tel_set_network_band (BandMode, Band, &RequestId);
 520  *
 521  * @endcode
 522  *
 523  * @see
 524  *  - None.
 525  *
 526  * @remarks
 527  *  - None.
 528  *
 529  *
 530  *
 531  */
 532 /*================================================================================================*/
 533 int tel_set_network_band(TapiHandle *handle, TelNetworkBandPreferred_t mode,
 534                 TelNetworkBand_t band, tapi_response_cb callback, void *user_data);
 535
 536 /**
 537  * @brief  This function requests for the present network band.
 538  *
 539  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 540  * However it just means that the API request has been transfered to the CP successfully.
 541  * The actual operation result is being delivered in the corresponding event asynchronously.
 542  *
 543  * @par Sync (or) Async:
 544  * This is an Asynchronous API.
 545  *
 546  * @par Important Notes:
 547  * - None.
 548  *
 549  * @warning
 550  * - None.
 551  *
 552  *
 553  * @param [in] handle
 554  * - handle from tel_init().
 555  *
 556  * @param [in] callback
 557  * - To register callback function for result.
 558  *
 559  * @param [in] user_data
 560  * - user_data for user specification.
 561  *
 562  * @par Async Response Message:
 563  * The event associated is TAPI_EVENT_NETWORK_GETNWBAND_CNF and the event data is #TelNetworkBand_t.
 564  * Asynchronous return status is indicated by #TelNetworkOperationCause_t.
 565  *
 566  * @pre
 567  *  - A dbus connection is established with #tel_init
 568  *  - The application name is registered with #tel_register_app_name
 569  *  - The application is registered events to listen asynchronous response with #tel_register_event
 570  *  - A event loop is running to listen events
 571  *
 572  * @post
 573  *  - None.
 574  *
 575  * @return Return Type (int) \n
 576  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 577  * - Refer #TapiResult_t for failure and error code
 578  * @par Prospective Clients:
 579  * External Apps.
 580  *
 581  * @code
 582  * #include <ITapiNetwork.h>
 583  *
 584  * int ret_status;
 585  * int RequestId;
 586  *
 587  * // GET NETWORK BAND
 588  * ret_status = tel_get_network_band(&RequestId);
 589  *
 590  * @endcode
 591  *
 592  * @see
 593  *  - None.
 594  *
 595  * @remarks
 596  *  - None.
 597  *
 598  *
 599  *
 600  */
 601 /*================================================================================================*/
 602 int tel_get_network_band(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 603
 604 /**
 605  * @brief  This function is invoked to set the network preferred plmn
 606  *
 607  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 608  * However it just means that the API request has been transfered to the CP successfully.
 609  * The actual operation result is being delivered in the corresponding event asynchronously.
 610  *
 611  * @par Sync (or) Async:
 612  * This is an Asynchronous API.
 613  *
 614  * @par Important Notes:
 615  * - None.
 616  *
 617  * @warning
 618  * - None.
 619  *
 620  *
 621  * @param [in] handle
 622  * - handle from tel_init().
 623  *
 624  * @param[in]  operation
 625  * - Operation indicates the operation to be done on preferred plmn .
 626  *
 627  * @param[in]  info
 628  * - This gives the plmn Info.
 629  *
 630  * @param [in] callback
 631  * - To register callback function for result.
 632  *
 633  * @param [in] user_data
 634  * - user_data for user specification.
 635  *
 636  * @par Async Response Message:
 637  * The event associated is TAPI_EVENT_NETWORK_SETPREFFPLMN_CNF and there is no event data associated with this event and asynchronous
 638  * return status is indicated by #TelNetworkOperationCause_t.
 639  *
 640  * @pre
 641  *  - A dbus connection is established with #tel_init
 642  *  - The application name is registered with #tel_register_app_name
 643  *  - The application is registered events to listen asynchronous response with #tel_register_event
 644  *  - A event loop is running to listen events
 645  *
 646  * @post
 647  *  - None.
 648  *
 649  * @return Return Type (int) \n
 650  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 651  * - Refer #TapiResult_t for failure and error code
 652  * @par Prospective Clients:
 653  * External Apps.
 654  *
 655  * @code
 656  * #include <ITapiNetwork.h>
 657  *
 658  * int ret_status;
 659  * int RequestId;
 660  *
 661  * TelNetworkPreferredPlmnOp_t Operation = TAPI_NETWORK_PREF_PLMN_ADD;
 662  * TelNetworkPreferredPlmnInfo_t PrefPlmnInfo;
 663  *
 664  * memset(&PrefPlmnInfo, 0, sizeof(TelNetworkPreferredPlmnInfo_t));
 665  * PrefPlmnInfo.Index = 0;
 666  * PrefPlmnInfo.SystemType = TAPI_NETWORK_SYSTEM_GSM;
 667  * unsigned char *plmn = "45454";
 668  * memcpy(PrefPlmnInfo.Plmn, plmn, strlen(plmn));
 669  *
 670  * // SET PREFERRED PLMN
 671  * ret_status = tel_set_network_preferred_plmn(Operation, PrefPlmnInfo, &RequestId);
 672  *
 673  * @endcode
 674  *
 675  * @see
 676  *  - None.
 677  *
 678  * @remarks
 679  *  - None.
 680  *
 681  *
 682  *
 683  */
 684 /*================================================================================================*/
 685 int tel_set_network_preferred_plmn(TapiHandle *handle, TelNetworkPreferredPlmnOp_t operation,
 686                 TelNetworkPreferredPlmnInfo_t *info, tapi_response_cb callback, void *user_data);
 687
 688 /**
 689  * @brief  This function is invoked to get the preferred plmn list
 690  *
 691  * This function makes Dbus method call to Telephony Sever and returns immediate value.
 692  * However it just means that the API request has been transfered to the CP successfully.
 693  * The actual operation result is being delivered in the corresponding event asynchronously.
 694  *
 695  * @par Sync (or) Async:
 696  * This is an Asynchronous API.
 697  *
 698  * @par Important Notes:
 699  * - None.
 700  *
 701  * @warning
 702  * - None.
 703  *
 704  * @param [in] handle
 705  * - handle from tel_init().
 706  *
 707  * @param [in] callback
 708  * - To register callback function for result.
 709  *
 710  * @param [in] user_data
 711  * - user_data for user specification.
 712  *
 713  *
 714  * @par Async Response Message:
 715  * The event associated is TAPI_EVENT_NETWORK_GETPREFFPLMN_CNF and event data associated with this event  is #TelNetworkPreferredPlmnList_t
 716  * and asynchronous  return status is indicated by #TelNetworkOperationCause_t.
 717  *
 718  * @pre
 719  *  - A dbus connection is established with #tel_init
 720  *  - The application name is registered with #tel_register_app_name
 721  *  - The application is registered events to listen asynchronous response with #tel_register_event
 722  *  - A event loop is running to listen events
 723  *
 724  * @post
 725  *  - None.
 726  *
 727  * @return Return Type (int) \n
 728  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 729  * - Refer #TapiResult_t for failure and error code
 730  * @par Prospective Clients:
 731  * External Apps.
 732  *
 733  * @code
 734  * #include <ITapiNetwork.h>
 735  *
 736  * int ret_status;
 737  * int RequestId;
 738  *
 739  * // GET NETWORK PREFERRED PLMN
 740  * ret_status = tel_get_network_preferred_plmn(&RequestId);
 741  *
 742  * @endcode
 743  *
 744  * @see
 745  *  - None.
 746  *
 747  * @remarks
 748  *  - None.
 749  *
 750  *
 751  *
 752  */
 753 /*================================================================================================*/
 754 int tel_get_network_preferred_plmn(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 755
 756
 757 /**
 758  * @brief  This function is called to cancel the triggered manual network search.
 759  *
 760  * @par Sync (or) Async:
 761  * This is an Asynchronous API.
 762  *
 763  * @par Important Notes:
 764  * - None.
 765  *
 766  * @warning
 767  * - None.
 768  *
 769  * @param [in] handle
 770  * - handle from tel_init().
 771  *
 772  * @param [in] callback
 773  * - To register callback function for result.
 774  *
 775  * @param [in] user_data
 776  * - user_data for user specification.
 777  *
 778  * @par Async Response Message:
 779  * The event associated is TAPI_EVENT_NETWORK_CANCELMANUALSEARCH_CNF and there is no event data associated with this event
 780  * and asynchronous return status is indicated by #TelNetworkOperationCause_t.
 781  *
 782  * @pre
 783  *  - Manual network search is already triggered.
 784  *
 785  * @post
 786  *  - None.
 787  *
 788  * @return Return Type (int) \n
 789  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 790  * - Refer #TapiResult_t for failure and error code
 791  *
 792  * @par Prospective Clients:
 793  * External Apps.
 794  *
 795  *
 796  */
 797 /*================================================================================================*/
 798 int tel_cancel_network_manual_search(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 799
 800 /**
 801  * @brief  This function is called to get network serving.
 802  *
 803  * @par Sync (or) Async:
 804  * This is an Asynchronous API.
 805  *
 806  * @par Important Notes:
 807  * - None.
 808  *
 809  * @warning
 810  * - None.
 811  *
 812  * @param [in] handle
 813  * - handle from tel_init().
 814  *
 815  * @param [in] callback
 816  * - To register callback function for result.
 817  *
 818  * @param [in] user_data
 819  * - user_data for user specification.
 820  *
 821  * @par Async Response Message:
 822  * The event associated is TAPI_EVENT_NETWORK_CANCELMANUALSEARCH_CNF and there is no event data associated with this event
 823  * and asynchronous return status is indicated by #TelNetworkOperationCause_t.
 824  *
 825  * @pre
 826  *
 827  * @post
 828  *  - None.
 829  *
 830  * @return Return Type (int) \n
 831  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 832  * - Refer #TapiResult_t for failure and error code
 833  *
 834  * @par Prospective Clients:
 835  * External Apps.
 836  *
 837  */
 838 /*================================================================================================*/
 839 int tel_get_network_serving(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 840
 841 /**
 842  * @brief  This function is called to set network mode.
 843  *
 844  * @par Sync (or) Async:
 845  * This is an Asynchronous API.
 846  *
 847  * @par Important Notes:
 848  * - None.
 849  *
 850  * @warning
 851  * - None.
 852  *
 853  * @param [in] handle
 854  * - handle from tel_init().
 855  *
 856  * @param [in] mode
 857  *
 858  * @param [in] callback
 859  * - To register callback function for result.
 860  *
 861  * @param [in] user_data
 862  * - user_data for user specification.
 863  *
 864  * @par Async Response Message:
 865  * The event associated is TAPI_EVENT_NETWORK_CANCELMANUALSEARCH_CNF and there is no event data associated with this event
 866  * and asynchronous return status is indicated by #TelNetworkOperationCause_t.
 867  *
 868  * @pre
 869  *
 870  * @post
 871  *  - None.
 872  *
 873  * @return Return Type (int) \n
 874  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 875  * - Refer #TapiResult_t for failure and error code
 876  *
 877  * @par Prospective Clients:
 878  * External Apps.
 879  *
 880  */
 881 /*================================================================================================*/
 882 int tel_set_network_mode(TapiHandle *handle, int mode, tapi_response_cb callback, void *user_data);
 883
 884 /**
 885  * @brief  This function is called to get network mode.
 886  *
 887  * @par Sync (or) Async:
 888  * This is an Asynchronous API.
 889  *
 890  * @par Important Notes:
 891  * - None.
 892  *
 893  * @warning
 894  * - None.
 895  *
 896  * @param [in] handle
 897  * - handle from tel_init().
 898  *
 899  * @param [in] callback
 900  * - To register callback function for result.
 901  *
 902  * @param [in] user_data
 903  * - user_data for user specification.
 904  *
 905  * @par Async Response Message:
 906  * The event associated is TAPI_EVENT_NETWORK_CANCELMANUALSEARCH_CNF and there is no event data associated with this event
 907  * and asynchronous return status is indicated by #TelNetworkOperationCause_t.
 908  *
 909  * @pre
 910  *
 911  * @post
 912  *  - None.
 913  *
 914  * @return Return Type (int) \n
 915  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 916  * - Refer #TapiResult_t for failure and error code
 917  *
 918  * @par Prospective Clients:
 919  * External Apps.
 920  *
 921  */
 922 /*================================================================================================*/
 923 int tel_get_network_mode(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 924
 925 /**
 926  * @brief  This function is called to get neighboring cell info.
 927  *
 928  * @par Sync (or) Async:
 929  * This is an Asynchronous API.
 930  *
 931  * @par Important Notes:
 932  * - None.
 933  *
 934  * @warning
 935  * - None.
 936  *
 937  * @param [in] handle
 938  * - handle from tel_init().
 939  *
 940  * @param [in] callback
 941  * - To register callback function for result.
 942  *
 943  * @param [in] user_data
 944  * - user_data for user specification.
 945  *
 946  * @par Async Response Message:
 947  * - The event data is #TelNetworkNeighboringCellInfo_t.
 948  *
 949  * @pre
 950  *
 951  * @post
 952  *  - None.
 953  *
 954  * @return Return Type (int) \n
 955  * - TAPI_API_SUCCESS - indicating that the operation has completed successfully. \n
 956  * - Refer #TapiResult_t for failure and error code
 957  *
 958  * @par Prospective Clients:
 959  * External Apps.
 960  *
 961  */
 962 /*================================================================================================*/
 963 int tel_get_network_neighboring_cell_info(TapiHandle *handle, tapi_response_cb callback, void *user_data);
 964
 965 #ifdef __cplusplus
 966 }
 967 #endif
 968
 969 #endif  /* _ITAPI_NETWORK_H_ */
 970
 971 /**
 972  * @}
 973  */