Operator Service
[Mobile Services]

Detailed Description

This service groups the Operator functions.

Data Structures

struct _AlpMblOperatorApn

struct _AlpMblOperatorList

Defines

#define ALP_MBL_OPERATOR_APN_TYPE_CSD   1

#define ALP_MBL_OPERATOR_APN_TYPE_GPRS   2

#define ALP_MBL_OPERATOR_INVALID_OPERATOR_ID   ((AlpMblOperatorId) 0)

#define ALP_MBL_OPERATOR_NOTIFICATION_LOGO_AVAILABLE   ((AlpMblNotificationId) 2)

The operator logo path is available.

#define ALP_MBL_OPERATOR_NOTIFICATION_NAME_AVAILABLE   ((AlpMblNotificationId) 1)

The name of an operator is available.

#define ALP_MBL_OPERATOR_STATUS_AVAILABLE   ((AlpMblOperatorStatus) 1)

The operator is available.

#define ALP_MBL_OPERATOR_STATUS_CURRENT   ((AlpMblOperatorStatus) 2)

The operator is the current one.

#define ALP_MBL_OPERATOR_STATUS_FORBIDDEN   ((AlpMblOperatorStatus) 3)

The operator is forbidden.

#define ALP_MBL_OPERATOR_STATUS_UNKNOW   ((AlpMblOperatorStatus) 0)

The operator status is unknown.

Typedefs

typedef _AlpMblOperatorApn AlpMblOperatorApn

typedef char AlpMblOperatorApnAddress [32]

typedef char AlpMblOperatorApnLogin [32]

typedef char AlpMblOperatorApnName [32]

typedef char AlpMblOperatorApnPassword [32]

typedef unsigned char AlpMblOperatorId

typedef _AlpMblOperatorList AlpMblOperatorList

typedef void(* AlpMblOperatorLogoAvailableCallbackPtr )(void *iUserDataP, AlpMblOperatorId iOperatorId, AlpMblOperatorLogoPath iLogoPath)

typedef char AlpMblOperatorLogoPath [256]

typedef char AlpMblOperatorName [32]

typedef void(* AlpMblOperatorNameAvailableCallbackPtr )(void *iUserDataP, AlpMblOperatorId iOperatorId, AlpMblOperatorName iName)

typedef char AlpMblOperatorNumber [8]

Operator number could start with "00" so we store it as string instead of integer. In GSM world, operator number is compose of MCC (3 digits) and MNC (2 or 3 digits).

typedef uint8_t AlpMblOperatorStatus

Functions

alp_status_t alp_mbl_operator_get_access_technology (AlpMblOperatorId iOperatorId, AlpMblAccessTechnology *oAccessTechnologyP)

alp_status_t alp_mbl_operator_get_apn (AlpMblOperatorId iOperatorId, uint32_t iOperatorApnIndex, AlpMblOperatorApn *oOperatorApnP)

alp_status_t alp_mbl_operator_get_apn_count (AlpMblOperatorId iOperatorId, uint32_t *oOperatorApnCountP)

alp_status_t alp_mbl_operator_get_logo (AlpMblOperatorId iOperatorId, AlpMblOperatorLogoPath *oOperatorLogoPathP)

alp_status_t alp_mbl_operator_get_name (AlpMblOperatorId iOperatorId, AlpMblOperatorName *oOperatorNameP)

alp_status_t alp_mbl_operator_get_number (AlpMblOperatorId iOperatorId, AlpMblOperatorNumber *oOperatorNumberP)

alp_status_t alp_mbl_operator_get_status (AlpMblOperatorId iOperatorId, AlpMblOperatorStatus *oStatusP)

Define Documentation

#define ALP_MBL_OPERATOR_APN_TYPE_CSD 1

#define ALP_MBL_OPERATOR_APN_TYPE_GPRS 2

#define ALP_MBL_OPERATOR_INVALID_OPERATOR_ID ((AlpMblOperatorId) 0)

#define ALP_MBL_OPERATOR_NOTIFICATION_LOGO_AVAILABLE ((AlpMblNotificationId) 2)

The operator logo path is available.

#define ALP_MBL_OPERATOR_NOTIFICATION_NAME_AVAILABLE ((AlpMblNotificationId) 1)

The name of an operator is available.

#define ALP_MBL_OPERATOR_STATUS_AVAILABLE ((AlpMblOperatorStatus) 1)

The operator is available.

#define ALP_MBL_OPERATOR_STATUS_CURRENT ((AlpMblOperatorStatus) 2)

The operator is the current one.

#define ALP_MBL_OPERATOR_STATUS_FORBIDDEN ((AlpMblOperatorStatus) 3)

The operator is forbidden.

#define ALP_MBL_OPERATOR_STATUS_UNKNOW ((AlpMblOperatorStatus) 0)

The operator status is unknown.

Typedef Documentation

typedef struct _AlpMblOperatorApn AlpMblOperatorApn

typedef char AlpMblOperatorApnAddress[32]

typedef char AlpMblOperatorApnLogin[32]

typedef char AlpMblOperatorApnName[32]

typedef char AlpMblOperatorApnPassword[32]

typedef unsigned char AlpMblOperatorId

typedef struct _AlpMblOperatorList AlpMblOperatorList

typedef void(* AlpMblOperatorLogoAvailableCallbackPtr)(void *iUserDataP, AlpMblOperatorId iOperatorId, AlpMblOperatorLogoPath iLogoPath)

Callback prototype for ALP_MBL_OPERATOR_NOTIFICATION_LOGO_AVAILABLE notification.
Parameters:

[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

[in] iOperatorId - Id of the operator associated with the logo path.

[in] iLogoPath - The path of the operator logo. Note that this path could be void meaning that the logo does not exist for the specified operator id.

typedef char AlpMblOperatorLogoPath[256]

typedef char AlpMblOperatorName[32]

typedef void(* AlpMblOperatorNameAvailableCallbackPtr)(void *iUserDataP, AlpMblOperatorId iOperatorId, AlpMblOperatorName iName)

Callback prototype for ALP_MBL_OPERATOR_NOTIFICATION_NAME_AVAILABLE notification.
Parameters:

[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

[in] iOperatorId - Id of the operator that its name is available.

[in] iName - The name of the operator.

typedef char AlpMblOperatorNumber[8]

Operator number could start with "00" so we store it as string instead of integer. In GSM world, operator number is compose of MCC (3 digits) and MNC (2 or 3 digits).

typedef uint8_t AlpMblOperatorStatus

Function Documentation

alp_status_t alp_mbl_operator_get_access_technology ( AlpMblOperatorId iOperatorId,

AlpMblAccessTechnology * oAccessTechnologyP

)

Returns the access technology of the operator.

Parameters:

[in] iOperatorId - Id of the operator.

[out] oAccessTechnologyP - Operator's access technology.

Returns:
ALP_STATUS_OK - The call has been created successfully.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.
ALP_STATUS_MBL_INVALID_OBJECT - The operator id is not valid: the operator doesn't exist.
ALP_STATUS_MBL_INVALID_PARAMETER - oAccessTechnologyP is NULL, and it's not valid.

Since:
ALP iSDK 2.0

alp_status_t alp_mbl_operator_get_apn ( AlpMblOperatorId iOperatorId,

uint32_t iOperatorApnIndex,

AlpMblOperatorApn * oOperatorApnP

)

Returns information about an access point network for the specified operator.

Parameters:

[in] iOperatorId - Id of the operator.

[in] iOperatorApnIndex - Index of the apn (index is 0-based).

[out] oOperatorApnP - Apn info.

Returns:
ALP_STATUS_OK - The call has been created successfully.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.
ALP_STATUS_MBL_INVALID_OBJECT - The operator id is not valid: the operator doesn't exist.
ALP_STATUS_MBL_INVALID_PARAMETER - oOperatorApnP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_operator_get_apn_count ( AlpMblOperatorId iOperatorId,

uint32_t * oOperatorApnCountP

)

Returns the count of access point network for the specified operator.

Parameters:

[in] iOperatorId - Id of the operator.

[out] oOperatorApnCountP - Apn count.

Returns:
ALP_STATUS_OK - The call has been created successfully.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.
ALP_STATUS_MBL_INVALID_OBJECT - The operator id is not valid: the operator doesn't exist.
ALP_STATUS_MBL_INVALID_PARAMETER - oOperatorApnCountP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_operator_get_logo ( AlpMblOperatorId iOperatorId,

AlpMblOperatorLogoPath * oOperatorLogoPathP

)

Returns the logo of the operator.

Parameters:

[in] iOperatorId - Id of the operator.

[out] oOperatorLogoPathP - Path of the operator's logo.

Returns:
ALP_STATUS_OK - The call has been created successfully.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.
ALP_STATUS_MBL_INVALID_OBJECT - The operator id is not valid: the operator doesn't exist.
ALP_STATUS_MBL_INVALID_PARAMETER - oOperatorLogoPathP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_operator_get_name ( AlpMblOperatorId iOperatorId,

AlpMblOperatorName * oOperatorNameP

)

Returns the name of the operator.

Parameters:

[in] iOperatorId - Id of the operator.

[out] oOperatorNameP - Name of the operator.

Returns:
ALP_STATUS_OK - The call has been created successfully.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.
ALP_STATUS_MBL_INVALID_OBJECT - The operator id is not valid: the operator doesn't exist.
ALP_STATUS_MBL_VALUE_NOT_AVAILABLE - The name is not yet available, wait for ALP_MBL_OPERATOR_NOTIFICATION_NAME_AVAILABLE notification.
ALP_STATUS_MBL_INVALID_PARAMETER - oOperatorNameP is NULL, and it's not valid.

Example:
You can see an example of use with the description of the function alp_mbl_context_get_home_operator_id().

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_operator_get_number ( AlpMblOperatorId iOperatorId,

AlpMblOperatorNumber * oOperatorNumberP

)

Returns the number of the operator. For a GSM operator, the number is a combination of the Mobile Country Code (MCC) and Mobile Network Code (MNC). For exemple, the number for the operator 'Orange FR' is 20801: 208 is the MMC of France, and 01 is the MCC of 'Orange FR'.

Parameters:

[in] iOperatorId - Id of the operator.

[out] oOperatorNumberP - Number of the operator.

Returns:
ALP_STATUS_OK - The call has been created successfully.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.
ALP_STATUS_MBL_INVALID_OBJECT - The operator id is not valid: the operator doesn't exist.
ALP_STATUS_MBL_INVALID_PARAMETER - oOperatorNumberP is NULL, and it's not valid.

Since:
ALP iSDK 1.0

alp_status_t alp_mbl_operator_get_status ( AlpMblOperatorId iOperatorId,

AlpMblOperatorStatus * oStatusP

)

Returns the status of the operator.

Parameters:

[in] iOperatorId - Id of the operator.

[out] oStatusP - Operator's status.

Returns:
ALP_STATUS_OK - The call has been created successfully.
ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.
ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.
ALP_STATUS_MBL_INVALID_OBJECT - The operator id is not valid: the operator doesn't exist.
ALP_STATUS_MBL_INVALID_PARAMETER - oStatusP is NULL, and it's not valid.

Since:
ALP iSDK 2.0

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


Data Structures
struct	_AlpMblOperatorApn
struct	_AlpMblOperatorList
Defines
#define	ALP_MBL_OPERATOR_APN_TYPE_CSD 1
#define	ALP_MBL_OPERATOR_APN_TYPE_GPRS 2
#define	ALP_MBL_OPERATOR_INVALID_OPERATOR_ID ((AlpMblOperatorId) 0)
#define	ALP_MBL_OPERATOR_NOTIFICATION_LOGO_AVAILABLE ((AlpMblNotificationId) 2)
	The operator logo path is available.
#define	ALP_MBL_OPERATOR_NOTIFICATION_NAME_AVAILABLE ((AlpMblNotificationId) 1)
	The name of an operator is available.
#define	ALP_MBL_OPERATOR_STATUS_AVAILABLE ((AlpMblOperatorStatus) 1)
	The operator is available.
#define	ALP_MBL_OPERATOR_STATUS_CURRENT ((AlpMblOperatorStatus) 2)
	The operator is the current one.
#define	ALP_MBL_OPERATOR_STATUS_FORBIDDEN ((AlpMblOperatorStatus) 3)
	The operator is forbidden.
#define	ALP_MBL_OPERATOR_STATUS_UNKNOW ((AlpMblOperatorStatus) 0)
	The operator status is unknown.
Typedefs
typedef _AlpMblOperatorApn	AlpMblOperatorApn
typedef char	AlpMblOperatorApnAddress [32]
typedef char	AlpMblOperatorApnLogin [32]
typedef char	AlpMblOperatorApnName [32]
typedef char	AlpMblOperatorApnPassword [32]
typedef unsigned char	AlpMblOperatorId
typedef _AlpMblOperatorList	AlpMblOperatorList
typedef void(*	AlpMblOperatorLogoAvailableCallbackPtr )(void *iUserDataP, AlpMblOperatorId iOperatorId, AlpMblOperatorLogoPath iLogoPath)
typedef char	AlpMblOperatorLogoPath [256]
typedef char	AlpMblOperatorName [32]
typedef void(*	AlpMblOperatorNameAvailableCallbackPtr )(void *iUserDataP, AlpMblOperatorId iOperatorId, AlpMblOperatorName iName)
typedef char	AlpMblOperatorNumber [8]
	Operator number could start with "00" so we store it as string instead of integer. In GSM world, operator number is compose of MCC (3 digits) and MNC (2 or 3 digits).
typedef uint8_t	AlpMblOperatorStatus
Functions
alp_status_t	alp_mbl_operator_get_access_technology (AlpMblOperatorId iOperatorId, AlpMblAccessTechnology *oAccessTechnologyP)
alp_status_t	alp_mbl_operator_get_apn (AlpMblOperatorId iOperatorId, uint32_t iOperatorApnIndex, AlpMblOperatorApn *oOperatorApnP)
alp_status_t	alp_mbl_operator_get_apn_count (AlpMblOperatorId iOperatorId, uint32_t *oOperatorApnCountP)
alp_status_t	alp_mbl_operator_get_logo (AlpMblOperatorId iOperatorId, AlpMblOperatorLogoPath *oOperatorLogoPathP)
alp_status_t	alp_mbl_operator_get_name (AlpMblOperatorId iOperatorId, AlpMblOperatorName *oOperatorNameP)
alp_status_t	alp_mbl_operator_get_number (AlpMblOperatorId iOperatorId, AlpMblOperatorNumber *oOperatorNumberP)
alp_status_t	alp_mbl_operator_get_status (AlpMblOperatorId iOperatorId, AlpMblOperatorStatus *oStatusP)

Operator Service [Mobile Services]

Detailed Description

Data Structures

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation

Function Documentation

Operator Service
[Mobile Services]