include/alp/mobile_network.h File Reference


Detailed Description

Public header file for the network services.

#include <alp/mobile_context.h>
#include <alp/mobile_operator.h>
#include <alp/mobile_services.h>

Go to the source code of this file.

Data Structures

struct  _AlpMblNetworkTime

Defines

#define ALP_MBL_NETWORK_ACCESS_TECHNOLOGY_EDGE   ALP_MBL_ACCESS_TECHNOLOGY_EDGE
#define ALP_MBL_NETWORK_ACCESS_TECHNOLOGY_GPRS   ALP_MBL_ACCESS_TECHNOLOGY_GPRS
#define ALP_MBL_NETWORK_ACCESS_TECHNOLOGY_GSM   ALP_MBL_ACCESS_TECHNOLOGY_GSM
#define ALP_MBL_NETWORK_ACCESS_TECHNOLOGY_UMTS   ALP_MBL_ACCESS_TECHNOLOGY_UMTS
#define ALP_MBL_NETWORK_ACCESS_TECHNOLOGY_UNKNOW   ALP_MBL_ACCESS_TECHNOLOGY_UNKNOW
#define ALP_MBL_NETWORK_DENIED_AUTHENTICATION_CANCEL   ((AlpMblNetworkDeniedInformation) 6)
 Network is denied due to authentication needed, and the user has cancel it.
#define ALP_MBL_NETWORK_DENIED_NO_NETWORK   ((AlpMblNetworkDeniedInformation) 5)
 Network is denied due to no network available.
#define ALP_MBL_NETWORK_DENIED_NO_SIM   ((AlpMblNetworkDeniedInformation) 1)
 Network is denied due to no sim card present.
#define ALP_MBL_NETWORK_DENIED_NOT_ALLOWED   ((AlpMblNetworkDeniedInformation) 4)
 Network is denied due to registration not allowed.
#define ALP_MBL_NETWORK_DENIED_SIM_DEACTIVATED   ((AlpMblNetworkDeniedInformation) 3)
 Network is denied due to the sim card deactivated.
#define ALP_MBL_NETWORK_DENIED_SIM_LOCK   ((AlpMblNetworkDeniedInformation) 2)
 Network is denied due to the sim card locked, and we are waiting for user authentication.
#define ALP_MBL_NETWORK_NOTIFICATION_AVAILABLE_OPERATORS_CHANGE   ((AlpMblNotificationId) 4)
 The available operators of a network have changed.
#define ALP_MBL_NETWORK_NOTIFICATION_NETWORK_TIME_AVAILABLE   ((AlpMblNotificationId) 6)
 The time of a network has changed.
#define ALP_MBL_NETWORK_NOTIFICATION_OPERATOR_CHANGE   ((AlpMblNotificationId) 3)
 The operator associated to a network has changed.
#define ALP_MBL_NETWORK_NOTIFICATION_PREFERRED_OPERATORS_CHANGE   ((AlpMblNotificationId) 5)
 The preferred operators of a network have changed.
#define ALP_MBL_NETWORK_NOTIFICATION_SIGNAL_LEVEL_CHANGE   ((AlpMblNotificationId) 2)
 The signal level of a network has changed.
#define ALP_MBL_NETWORK_NOTIFICATION_STATUS_CHANGE   ((AlpMblNotificationId) 1)
 The status of a network has changed.
#define ALP_MBL_NETWORK_REGISTRATION_MODE_AUTOMATIC   ((uint8_t) 0)
 Automatic registration mode. The network registration is up to the Phone Module.
#define ALP_MBL_NETWORK_REGISTRATION_MODE_MANUAL   ((uint8_t) 1)
 Manual registration mode. If the home operator is not available nor the previous operator, it will be up to the user to select an operator.
#define ALP_MBL_NETWORK_SIGNAL_LEVEL_0   ((AlpMblNetworkSignalLevel) 0)
 The signal level is 0 bar on 4.
#define ALP_MBL_NETWORK_SIGNAL_LEVEL_1   ((AlpMblNetworkSignalLevel) 1)
 The signal level is 1 bar on 4.
#define ALP_MBL_NETWORK_SIGNAL_LEVEL_2   ((AlpMblNetworkSignalLevel) 2)
 The signal level is 2 bar on 4.
#define ALP_MBL_NETWORK_SIGNAL_LEVEL_3   ((AlpMblNetworkSignalLevel) 3)
 The signal level is 3 bar on 4.
#define ALP_MBL_NETWORK_SIGNAL_LEVEL_4   ((AlpMblNetworkSignalLevel) 4)
 The signal level is 4 bar on 4.
#define ALP_MBL_NETWORK_SIGNAL_LEVEL_INVALID   ((AlpMblNetworkSignalLevel) -1)
 The signal level is not detectable.
#define ALP_MBL_NETWORK_STATUS_DENIED   ((AlpMblNetworkStatus) 3)
 The network is available for emergency calls only.
#define ALP_MBL_NETWORK_STATUS_REGISTERED   ((AlpMblNetworkStatus) 1)
 The network is registered to an operator.
#define ALP_MBL_NETWORK_STATUS_ROAMING   ((AlpMblNetworkStatus) 5)
 The network is registered to an operator in roaming mode.
#define ALP_MBL_NETWORK_STATUS_SEARCHING   ((AlpMblNetworkStatus) 2)
 The network is searching for an operator.
#define ALP_MBL_NETWORK_STATUS_UNKNOW   ((AlpMblNetworkStatus) 4)
 Initial status.
#define ALP_MBL_NETWORK_STATUS_UNREGISTERED   ((AlpMblNetworkStatus) 0)
 The network is not registered.

Typedefs

typedef AlpMblAccessTechnology AlpMblNetworkAccessTechnology
typedef void(* AlpMblNetworkAvailableOperatorsChangeCallbackPtr )(void *iUserDataP, AlpMblNetworkId iNetworkId, AlpMblOperatorList iAvailableOperators)
typedef unsigned char AlpMblNetworkDeniedInformation
typedef void(* AlpMblNetworkOperatorChangeCallbackPtr )(void *iUserDataP, AlpMblNetworkId iNetworkId, AlpMblOperatorId iPrevious, AlpMblOperatorId iCurrent)
typedef void(* AlpMblNetworkPreferredOperatorsChangeCallbackPtr )(void *iUserDataP, AlpMblNetworkId iNetworkId, AlpMblOperatorList iPreferredOperators)
typedef char AlpMblNetworkSignalLevel
typedef void(* AlpMblNetworkSignalLevelChangeCallbackPtr )(void *iUserDataP, AlpMblNetworkId iNetworkId, AlpMblNetworkSignalLevel iPrevious, AlpMblNetworkSignalLevel iCurrent)
typedef unsigned char AlpMblNetworkStatus
typedef void(* AlpMblNetworkStatusChangeCallbackPtr )(void *iUserDataP, AlpMblNetworkId iNetworkId, AlpMblNetworkStatus iPrevious, AlpMblNetworkStatus iCurrent, AlpMblNetworkAccessTechnology iAccessTechnology, AlpMblNetworkDeniedInformation iDeniedInformation)
typedef _AlpMblNetworkTime AlpMblNetworkTime
 Network Time.
typedef void(* AlpMblNetworkTimeAvailableCallbackPtr )(void *iUserDataP, AlpMblNetworkId iNetworkId, AlpMblNetworkTime iNetworkTime)

Functions

alp_status_t alp_mbl_network_get_available_operators (AlpMblNetworkId iNetworkId, AlpMblOperatorList *oOperatorListP)
alp_status_t alp_mbl_network_get_denied_information (AlpMblNetworkId iNetworkId, AlpMblNetworkDeniedInformation *oInformationP)
alp_status_t alp_mbl_network_get_mobile_context (AlpMblNetworkId iNetworkId, AlpMblContextId *oContextIdP)
alp_status_t alp_mbl_network_get_network_time (AlpMblNetworkId iNetworkId, AlpMblNetworkTime *oNetworkTimeP)
alp_status_t alp_mbl_network_get_operator (AlpMblNetworkId iNetworkId, AlpMblOperatorId *oOperatorIdP)
alp_status_t alp_mbl_network_get_preferred_operators (AlpMblNetworkId iNetworkId, AlpMblOperatorList *oOperatorListP)
alp_status_t alp_mbl_network_get_registration_mode (AlpMblNetworkId iNetworkId, uint8_t *oRegistrationModeP)
alp_status_t alp_mbl_network_get_signal_level (AlpMblNetworkId iNetworkId, AlpMblNetworkSignalLevel *oNetworkSignalLevelP)
alp_status_t alp_mbl_network_get_status (AlpMblNetworkId iNetworkId, AlpMblNetworkStatus *oNetworkStatusP, AlpMblNetworkAccessTechnology *oNetworkAccessTechnologyP)
alp_status_t alp_mbl_network_set_operator (AlpMblNetworkId iNetworkId, AlpMblOperatorId iOperatorId)
alp_status_t alp_mbl_network_set_registration_mode (AlpMblNetworkId iNetworkId, uint8_t iRegistrationMode)


Generated on Wed Jul 30 07:06:40 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.