All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Macros | Typedefs | Enumerations | Functions
le_mrc_interface.h File Reference
#include "legato.h"

Go to the source code of this file.

Macros

#define LE_MRC_MCC_LEN   3
 
#define LE_MRC_MCC_BYTES   4
 
#define LE_MRC_MNC_LEN   3
 
#define LE_MRC_MNC_BYTES   4
 
#define LE_MRC_BITMASK_RAT_CDMA   1
 
#define LE_MRC_BITMASK_RAT_GSM   2
 
#define LE_MRC_BITMASK_RAT_UMTS   4
 
#define LE_MRC_BITMASK_RAT_LTE   8
 
#define LE_MRC_BITMASK_BAND_CLASS_0_A_SYSTEM   1
 
#define LE_MRC_BITMASK_BAND_CLASS_0_B_SYSTEM   2
 
#define LE_MRC_BITMASK_BAND_CLASS_1_ALL_BLOCKS   4
 
#define LE_MRC_BITMASK_BAND_CLASS_2_PLACEHOLDER   8
 
#define LE_MRC_BITMASK_BAND_CLASS_3_A_SYSTEM   16
 
#define LE_MRC_BITMASK_BAND_CLASS_4_ALL_BLOCKS   32
 
#define LE_MRC_BITMASK_BAND_CLASS_5_ALL_BLOCKS   64
 
#define LE_MRC_BITMASK_BAND_CLASS_6   128
 
#define LE_MRC_BITMASK_BAND_CLASS_7   256
 
#define LE_MRC_BITMASK_BAND_CLASS_8   512
 
#define LE_MRC_BITMASK_BAND_CLASS_9   1024
 
#define LE_MRC_BITMASK_BAND_CLASS_10   2048
 
#define LE_MRC_BITMASK_BAND_CLASS_11   4096
 
#define LE_MRC_BITMASK_BAND_CLASS_12   8192
 
#define LE_MRC_BITMASK_BAND_CLASS_14   16384
 
#define LE_MRC_BITMASK_BAND_CLASS_15   32768
 
#define LE_MRC_BITMASK_BAND_CLASS_16   65536
 
#define LE_MRC_BITMASK_BAND_CLASS_17   131072
 
#define LE_MRC_BITMASK_BAND_CLASS_18   262144
 
#define LE_MRC_BITMASK_BAND_CLASS_19   524288
 
#define LE_MRC_BITMASK_BAND_GSM_DCS_1800   1048576
 
#define LE_MRC_BITMASK_BAND_EGSM_900   2097152
 
#define LE_MRC_BITMASK_BAND_PRI_GSM_900   4194304
 
#define LE_MRC_BITMASK_BAND_GSM_450   8388608
 
#define LE_MRC_BITMASK_BAND_GSM_480   16777216
 
#define LE_MRC_BITMASK_BAND_GSM_750   33554432
 
#define LE_MRC_BITMASK_BAND_GSM_850   67108864
 
#define LE_MRC_BITMASK_BAND_GSMR_900   134217728
 
#define LE_MRC_BITMASK_BAND_GSM_PCS_1900   268435456
 
#define LE_MRC_BITMASK_BAND_WCDMA_EU_J_CH_IMT_2100   536870912
 
#define LE_MRC_BITMASK_BAND_WCDMA_US_PCS_1900   1073741824
 
#define LE_MRC_BITMASK_BAND_WCDMA_EU_CH_DCS_1800   2147483648
 
#define LE_MRC_BITMASK_BAND_WCDMA_US_1700   4294967296
 
#define LE_MRC_BITMASK_BAND_WCDMA_US_850   8589934592
 
#define LE_MRC_BITMASK_BAND_WCDMA_J_800   17179869184
 
#define LE_MRC_BITMASK_BAND_WCDMA_EU_2600   34359738368
 
#define LE_MRC_BITMASK_BAND_WCDMA_EU_J_900   68719476736
 
#define LE_MRC_BITMASK_BAND_WCDMA_J_1700   137438953472
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_1   1
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_2   2
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_3   4
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_4   8
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_5   16
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_6   32
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_7   64
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_8   128
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_9   256
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_10   512
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_11   1024
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_12   2048
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_13   4096
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_14   8192
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_17   16384
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_18   32768
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_19   65536
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_20   131072
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_21   262144
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_24   524288
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_25   1048576
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_33   2097152
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_34   4194304
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_35   8388608
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_36   16777216
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_37   33554432
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_38   67108864
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_39   134217728
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_40   268435456
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_41   536870912
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_42   1073741824
 
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_43   2147483648
 
#define LE_MRC_BITMASK_TDSCDMA_BAND_A   1
 
#define LE_MRC_BITMASK_TDSCDMA_BAND_B   2
 
#define LE_MRC_BITMASK_TDSCDMA_BAND_C   4
 
#define LE_MRC_BITMASK_TDSCDMA_BAND_D   8
 
#define LE_MRC_BITMASK_TDSCDMA_BAND_E   16
 
#define LE_MRC_BITMASK_TDSCDMA_BAND_F   32
 

Typedefs

typedef struct
le_mrc_ScanInformation * 		le_mrc_ScanInformationRef_t
 
typedef struct
le_mrc_ScanInformationList * 		le_mrc_ScanInformationListRef_t
 
typedef struct le_mrc_CellInfo * le_mrc_CellInfoRef_t
 
typedef struct
le_mrc_NeighborCells * 		le_mrc_NeighborCellsRef_t
 
typedef struct
le_mrc_NetRegStateHandler * 		le_mrc_NetRegStateHandlerRef_t
 
typedef struct
le_mrc_RatChangeHandler * 		le_mrc_RatChangeHandlerRef_t
 
typedef void(* le_mrc_NetRegStateHandlerFunc_t )(le_mrc_NetRegState_t state, void *contextPtr)
 
typedef void(* le_mrc_RatChangeHandlerFunc_t )(le_mrc_Rat_t rat, void *contextPtr)
 

Enumerations

enum  le_mrc_NetRegState_t {
  LE_MRC_REG_NONE, LE_MRC_REG_HOME, LE_MRC_REG_SEARCHING, LE_MRC_REG_DENIED,
  LE_MRC_REG_ROAMING, LE_MRC_REG_UNKNOWN
}
 
enum  le_mrc_Rat_t {
  LE_MRC_RAT_UNKNOWN, LE_MRC_RAT_GSM, LE_MRC_RAT_UMTS, LE_MRC_RAT_UMTS_GSM,
  LE_MRC_RAT_LTE, LE_MRC_RAT_LTE_GSM, LE_MRC_RAT_LTE_UMTS, LE_MRC_RAT_LTE_UMTS_GSM,
  LE_MRC_RAT_CDMA, LE_MRC_RAT_CDMA_GSM, LE_MRC_RAT_CDMA_UMTS, LE_MRC_RAT_CDMA_UMTS_GSM,
  LE_MRC_RAT_CDMA_LTE, LE_MRC_RAT_CDMA_LTE_GSM, LE_MRC_RAT_CDMA_LTE_UMTS, LE_MRC_RAT_ALL
}
 

Functions

void le_mrc_StartClient (const char *serviceInstanceName)
 
void le_mrc_StopClient (void)
 
le_mrc_NetRegStateHandlerRef_t le_mrc_AddNetRegStateHandler (le_mrc_NetRegStateHandlerFunc_t handlerPtr, void *contextPtr)
 
void le_mrc_RemoveNetRegStateHandler (le_mrc_NetRegStateHandlerRef_t addHandlerRef)
 
le_mrc_RatChangeHandlerRef_t le_mrc_AddRatChangeHandler (le_mrc_RatChangeHandlerFunc_t handlerPtr, void *contextPtr)
 
void le_mrc_RemoveRatChangeHandler (le_mrc_RatChangeHandlerRef_t addHandlerRef)
 
le_result_t le_mrc_GetNetRegState (le_mrc_NetRegState_t *statePtr)
 
le_result_t le_mrc_GetSignalQual (uint32_t *qualityPtr)
 
le_result_t le_mrc_SetRadioPower (le_onoff_t power)
 
le_result_t le_mrc_GetRadioPower (le_onoff_t *powerPtr)
 
le_result_t le_mrc_RegisterCellularNetwork (const char *mcc, const char *mnc)
 
le_mrc_ScanInformationListRef_t le_mrc_PerformCellularNetworkScan (le_mrc_Rat_t ratMask)
 
le_mrc_ScanInformationRef_t le_mrc_GetFirstCellularNetworkScan (le_mrc_ScanInformationListRef_t scanInformationListRef)
 
le_mrc_ScanInformationRef_t le_mrc_GetNextCellularNetworkScan (le_mrc_ScanInformationListRef_t scanInformationListRef)
 
void le_mrc_DeleteCellularNetworkScan (le_mrc_ScanInformationListRef_t scanInformationListRef)
 
le_result_t le_mrc_GetCellularNetworkMccMnc (le_mrc_ScanInformationRef_t scanInformationRef, char *mccPtr, size_t mccPtrNumElements, char *mncPtr, size_t mncPtrNumElements)
 
le_result_t le_mrc_GetCellularNetworkName (le_mrc_ScanInformationRef_t scanInformationRef, char *namePtr, size_t namePtrNumElements)
 
bool le_mrc_IsCellularNetworkRatAvailable (le_mrc_ScanInformationRef_t scanInformationRef, le_mrc_Rat_t rat)
 
bool le_mrc_IsCellularNetworkInUse (le_mrc_ScanInformationRef_t scanInformationRef)
 
bool le_mrc_IsCellularNetworkAvailable (le_mrc_ScanInformationRef_t scanInformationRef)
 
bool le_mrc_IsCellularNetworkHome (le_mrc_ScanInformationRef_t scanInformationRef)
 
bool le_mrc_IsCellularNetworkForbidden (le_mrc_ScanInformationRef_t scanInformationRef)
 
le_result_t le_mrc_GetHomeNetworkName (char *nameStr, size_t nameStrNumElements)
 
le_result_t le_mrc_GetRadioAccessTechInUse (le_mrc_Rat_t *ratPtr)
 
le_mrc_NeighborCellsRef_t le_mrc_GetNeighborCellsInfo (void)
 
void le_mrc_DeleteNeighborCellsInfo (le_mrc_NeighborCellsRef_t ngbrCellsRef)
 
le_mrc_CellInfoRef_t le_mrc_GetFirstNeighborCellInfo (le_mrc_NeighborCellsRef_t ngbrCellsRef)
 
le_mrc_CellInfoRef_t le_mrc_GetNextNeighborCellInfo (le_mrc_NeighborCellsRef_t ngbrCellsRef)
 
uint32_t le_mrc_GetNeighborCellId (le_mrc_CellInfoRef_t ngbrCellInfoRef)
 
uint32_t le_mrc_GetNeighborCellLocAreaCode (le_mrc_CellInfoRef_t ngbrCellInfoRef)
 
int32_t le_mrc_GetNeighborCellRxLevel (le_mrc_CellInfoRef_t ngbrCellInfoRef)
 

Detailed Description

Legato Modem Radio Control include file.

Copyright (C) Sierra Wireless, Inc. 2014. Use of this work is subject to license.

Macro Definition Documentation

#define LE_MRC_BITMASK_BAND_CLASS_0_A_SYSTEM   1

Band Bit Mask

#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_1   1

LTE Band Bit Mask

#define LE_MRC_BITMASK_RAT_CDMA   1

Radio Access Technology Bit Mask

#define LE_MRC_BITMASK_TDSCDMA_BAND_A   1

TDSCDMA Band Bit Mask

Typedef Documentation

typedef struct le_mrc_CellInfo* le_mrc_CellInfoRef_t

Reference type for one Cell Information.

typedef struct le_mrc_NeighborCells* le_mrc_NeighborCellsRef_t

Reference type for all Neighboring Cells Information.

typedef void(* le_mrc_NetRegStateHandlerFunc_t)(le_mrc_NetRegState_t state, void *contextPtr)

Handler for Network registration state changes.

Parameters
stateParameter ready to receive the Network Registration state.
contextPtr
typedef struct le_mrc_NetRegStateHandler* le_mrc_NetRegStateHandlerRef_t

Reference type for le_mrc_NetRegStateHandler handler ADD/REMOVE functions

typedef void(* le_mrc_RatChangeHandlerFunc_t)(le_mrc_Rat_t rat, void *contextPtr)

Handler for Radio Access Technologie changes.

Parameters
ratParameter ready to receive the Radio Access Technology.
contextPtr
typedef struct le_mrc_RatChangeHandler* le_mrc_RatChangeHandlerRef_t

Reference type for le_mrc_RatChangeHandler handler ADD/REMOVE functions

typedef struct le_mrc_ScanInformationList* le_mrc_ScanInformationListRef_t

Reference type for Scan Information Listing.

typedef struct le_mrc_ScanInformation* le_mrc_ScanInformationRef_t

Reference type for referring to MRC Scan Information objects.

Enumeration Type Documentation

enum le_mrc_NetRegState_t

Network Registration states.

Enumerator
LE_MRC_REG_NONE 

Not registered and not currently searching for new operator.

LE_MRC_REG_HOME 

Registered, home network.

LE_MRC_REG_SEARCHING 

Not registered but currently searching for a new operator.

LE_MRC_REG_DENIED 

Registration was denied, usually because of invalid access credentials.

LE_MRC_REG_ROAMING 

Registered to a roaming network.

LE_MRC_REG_UNKNOWN 

Unknown state.

enum le_mrc_Rat_t

Radio Access Technology

Enumerator
LE_MRC_RAT_UNKNOWN 

Unknown.

LE_MRC_RAT_GSM 

GSM network.

LE_MRC_RAT_UMTS 

UMTS network.

LE_MRC_RAT_LTE 

LTE network.

LE_MRC_RAT_CDMA 

CDMA network.

Function Documentation

le_mrc_NetRegStateHandlerRef_t le_mrc_AddNetRegStateHandler ( le_mrc_NetRegStateHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

le_mrc_NetRegStateHandler handler ADD function

Parameters
[in]handlerPtr
[in]contextPtr
le_mrc_RatChangeHandlerRef_t le_mrc_AddRatChangeHandler ( le_mrc_RatChangeHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

le_mrc_RatChangeHandler handler ADD function

Parameters
[in]handlerPtr
[in]contextPtr
void le_mrc_DeleteCellularNetworkScan ( le_mrc_ScanInformationListRef_t  scanInformationListRef)

This function must be called to delete the list of the Scan Information retrieved with le_mrc_PerformNetworkScan().

Note
On failure, the process exits, so you don't have to worry about checking the returned reference for validity.
Parameters
[in]scanInformationListRefThe list of scan information.
void le_mrc_DeleteNeighborCellsInfo ( le_mrc_NeighborCellsRef_t  ngbrCellsRef)

This function must be called to delete the Neighboring Cells information.

Note
On failure, the process exits, so you don't have to worry about checking the returned reference for validity.
Parameters
[in]ngbrCellsRefThe Neighboring Cells reference.
le_result_t le_mrc_GetCellularNetworkMccMnc ( le_mrc_ScanInformationRef_t  scanInformationRef,
char *  mccPtr,
size_t  mccPtrNumElements,
char *  mncPtr,
size_t  mncPtrNumElements 
)

This function must be called to get the Cellular Network Code [mcc:mnc]

Returns
  • LE_OK on success
  • LE_NOT_POSSIBLE for all other errors
Note
On failure, the process exits, so you don't have to worry about checking the returned reference for validity.
Parameters
[in]scanInformationRefScan information reference
[out]mccPtrMobile Country Code
[in]mccPtrNumElements
[out]mncPtrMobile Network Code
[in]mncPtrNumElements
le_result_t le_mrc_GetCellularNetworkName ( le_mrc_ScanInformationRef_t  scanInformationRef,
char *  namePtr,
size_t  namePtrNumElements 
)

This function must be called to get the Cellular Network Name.

Returns
  • LE_OK on success
  • LE_OVERFLOW if the operator name would not fit in buffer
  • LE_NOT_POSSIBLE for all other errors
Note
On failure, the process exits, so you don't have to worry about checking the returned reference for validity.
Parameters
[in]scanInformationRefScan information reference
[out]namePtrName of operator
[in]namePtrNumElements
le_mrc_ScanInformationRef_t le_mrc_GetFirstCellularNetworkScan ( le_mrc_ScanInformationListRef_t  scanInformationListRef)

This function must be called to get the first Scan Information object reference in the list of scan Information retrieved with le_mrc_PerformNetworkScan().

Returns
NULL No scan information found.
le_mrc_ScanInformationRef_t The Scan Information object reference.
Note
If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
Parameters
[in]scanInformationListRefThe list of scan information.
le_mrc_CellInfoRef_t le_mrc_GetFirstNeighborCellInfo ( le_mrc_NeighborCellsRef_t  ngbrCellsRef)

This function must be called to get the first Cell Information reference in the list of Neighboring Cells information retrieved with le_mrc_GetNeighborCellsInfo().

Returns
NULL No Cell information object found.
le_mrc_CellInfoRef_t The Cell information object reference.
Note
If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
Parameters
[in]ngbrCellsRefThe Neighboring Cells reference.
le_result_t le_mrc_GetHomeNetworkName ( char *  nameStr,
size_t  nameStrNumElements 
)

This function must be called to get the Home Network Name information.

Returns
  • LE_OK on success
  • LE_OVERFLOW if the Home Network Name can't fit in nameStr
  • LE_NOT_POSSIBLE on any other failure
Note
If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
Parameters
[out]nameStrthe home network Name
[in]nameStrNumElements
uint32_t le_mrc_GetNeighborCellId ( le_mrc_CellInfoRef_t  ngbrCellInfoRef)

This function must be called to get the Cell Identifier.

Returns
The Cell Identifier.
Note
If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
Parameters
[in]ngbrCellInfoRefThe Cell information reference.
uint32_t le_mrc_GetNeighborCellLocAreaCode ( le_mrc_CellInfoRef_t  ngbrCellInfoRef)

This function must be called to get the Location Area Code of a cell.

Returns
The Location Area Code of a cell.
Note
If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
Parameters
[in]ngbrCellInfoRefThe Cell information reference.
int32_t le_mrc_GetNeighborCellRxLevel ( le_mrc_CellInfoRef_t  ngbrCellInfoRef)

This function must be called to get the signal strength of a cell.

Returns
The signal strength of a cell.
Note
If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
Parameters
[in]ngbrCellInfoRefThe Cell information reference.
le_mrc_NeighborCellsRef_t le_mrc_GetNeighborCellsInfo ( void  )

This function must be called to retrieve the Neighboring Cells information. It creates and returns a reference to the Neighboring Cells information.

Returns
A reference to the Neighboring Cells information.
NULL if no Cells Information are available.
le_result_t le_mrc_GetNetRegState ( le_mrc_NetRegState_t *  statePtr)

Get the network registration state.

Returns
LE_NOT_POSSIBLE Function failed to get the Network registration state.
LE_OK Function succeeded.
Note
If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
Parameters
[out]statePtrNetwork Registration state.
le_mrc_ScanInformationRef_t le_mrc_GetNextCellularNetworkScan ( le_mrc_ScanInformationListRef_t  scanInformationListRef)

This function must be called to get the next Scan Information object reference in the list of scan Information retrieved with le_mrc_PerformNetworkScan().

Returns
NULL No scan information found.
le_mrc_ScanInformationRef_t The Scan Information object reference.
Note
If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
Parameters
[in]scanInformationListRefThe list of scan information.
le_mrc_CellInfoRef_t le_mrc_GetNextNeighborCellInfo ( le_mrc_NeighborCellsRef_t  ngbrCellsRef)

This function must be called to get the next Cell Information reference in the list of Neighboring Cells information retrieved with le_mrc_GetNeighborCellsInfo().

Returns
NULL No Cell information object found.
le_mrc_CellInfoRef_t The Cell information object reference.
Note
If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
Parameters
[in]ngbrCellsRefThe Neighboring Cells reference.
le_result_t le_mrc_GetRadioAccessTechInUse ( le_mrc_Rat_t *  ratPtr)

This function must be called to get the current Radio Access Technology in use.

Returns
LE_NOT_POSSIBLE Function failed to get the Radio Access Technology.
LE_OK Function succeeded.
Note
If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
Parameters
[out]ratPtrThe Radio Access Technology.
le_result_t le_mrc_GetRadioPower ( le_onoff_t *  powerPtr)

Must be called to get the Radio Module power state.

Returns
LE_NOT_POSSIBLE Function failed to get the Radio Module power state.
LE_OK Function succeeded.
Note
If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
Parameters
[out]powerPtrPower state.
le_result_t le_mrc_GetSignalQual ( uint32_t *  qualityPtr)

Get the signal quality.

Returns
LE_NOT_POSSIBLE Function failed to obtain the signal quality.
LE_OK Function succeeded.
Note
If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.
Parameters
[out]qualityPtr[OUT] Received signal strength quality (0 = no signal strength,
bool le_mrc_IsCellularNetworkAvailable ( le_mrc_ScanInformationRef_t  scanInformationRef)

This function must be called to check if a cellular network is available.

Returns
true The network is available
false The network is not available
Note
On failure, the process exits, so you don't have to worry about checking the returned reference for validity.
Parameters
[in]scanInformationRefScan information reference
bool le_mrc_IsCellularNetworkForbidden ( le_mrc_ScanInformationRef_t  scanInformationRef)

This function must be called to check if a cellular network is forbidden by the operator.

Returns
true The network is forbidden
false The network is allowed
Note
On failure, the process exits, so you don't have to worry about checking the returned reference for validity.
Parameters
[in]scanInformationRefScan information reference
bool le_mrc_IsCellularNetworkHome ( le_mrc_ScanInformationRef_t  scanInformationRef)

This function must be called to check if a cellular network is currently in home mode.

Returns
true The network is home
false The network is roaming
Note
On failure, the process exits, so you don't have to worry about checking the returned reference for validity.
Parameters
[in]scanInformationRefScan information reference
bool le_mrc_IsCellularNetworkInUse ( le_mrc_ScanInformationRef_t  scanInformationRef)

This function must be called to check if a cellular network is currently in use.

Returns
true The network is in use
false The network is not in use
Note
On failure, the process exits, so you don't have to worry about checking the returned reference for validity.
Parameters
[in]scanInformationRefScan information reference
bool le_mrc_IsCellularNetworkRatAvailable ( le_mrc_ScanInformationRef_t  scanInformationRef,
le_mrc_Rat_t  rat 
)

This function must be called to know if the radio control access is in scanInformationRef.

Returns
  • true the radio access technology is available
  • false otherwise
Note
On failure, the process exits.
Parameters
[in]scanInformationRefScan information reference
[in]ratThe Radio Access Technology
le_mrc_ScanInformationListRef_t le_mrc_PerformCellularNetworkScan ( le_mrc_Rat_t  ratMask)

This function must be called to perform a cellular network scan.

Returns
Reference to the List object. Null pointer if the scan failed.
Parameters
[in]ratMaskTechnology mask
le_result_t le_mrc_RegisterCellularNetwork ( const char *  mcc,
const char *  mnc 
)

This function must be called to register on a cellular network [mcc;mnc]

Returns
LE_NOT_POSSIBLE The function failed to register on the network.
LE_OK The function succeeded.
Note
If one code is too long (max 3 digits), it is a fatal error, the function will not return.
Parameters
[in]mccMobile Country Code
[in]mncMobile Network Code
void le_mrc_RemoveNetRegStateHandler ( le_mrc_NetRegStateHandlerRef_t  addHandlerRef)

le_mrc_NetRegStateHandler handler REMOVE function

Parameters
[in]addHandlerRef
void le_mrc_RemoveRatChangeHandler ( le_mrc_RatChangeHandlerRef_t  addHandlerRef)

le_mrc_RatChangeHandler handler REMOVE function

Parameters
[in]addHandlerRef
le_result_t le_mrc_SetRadioPower ( le_onoff_t  power)

Set the power of the Radio Module.

Returns
LE_FAULT Function failed.
LE_OK Function succeed.
Parameters
[in]powerThe power state.
void le_mrc_StartClient ( const char *  serviceInstanceName)

Start the service for the client main thread

Parameters
[in]serviceInstanceName
void le_mrc_StopClient ( void  )

Stop the service for the current client thread

 Sierra Wireless 2014  -  Generated by Doxygen 1.8.6