le_cellnet_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Typedefs
typedef struct le_cellnet_RequestObj *	le_cellnet_RequestObjRef_t
typedef struct le_cellnet_StateEventHandler *	le_cellnet_StateEventHandlerRef_t
typedef void(*	le_cellnet_StateHandlerFunc_t) (le_cellnet_State_t state, void *contextPtr)

Enumerations
enum	le_cellnet_State_t {   LE_CELLNET_RADIO_OFF, LE_CELLNET_REG_EMERGENCY, LE_CELLNET_REG_HOME, LE_CELLNET_REG_ROAMING,   LE_CELLNET_REG_UNKNOWN }

Functions
void	le_cellnet_ConnectService (void)
void	le_cellnet_DisconnectService (void)
le_cellnet_StateEventHandlerRef_t	le_cellnet_AddStateEventHandler (le_cellnet_StateHandlerFunc_t handlerPtr, void *contextPtr)
void	le_cellnet_RemoveStateEventHandler (le_cellnet_StateEventHandlerRef_t addHandlerRef)
le_cellnet_RequestObjRef_t	le_cellnet_Request (void)
void	le_cellnet_Release (le_cellnet_RequestObjRef_t cellNetRef)

Detailed Description

Legato Cellular Network include file.

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

Typedef Documentation

typedef struct le_cellnet_RequestObj* le_cellnet_RequestObjRef_t

Reference returned by Request function and used by Release function

typedef struct le_cellnet_StateEventHandler* le_cellnet_StateEventHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'le_cellnet_StateEvent'

typedef void(* le_cellnet_StateHandlerFunc_t) (le_cellnet_State_t state, void *contextPtr)

Handler for network state changes

Parameters

state	The cellular network state
contextPtr

Enumeration Type Documentation

enum le_cellnet_State_t

Cellular Network states.

Enumerator
LE_CELLNET_RADIO_OFF	The radio is Off.
LE_CELLNET_REG_EMERGENCY	Only Emergency calls are allowed.
LE_CELLNET_REG_HOME	Registered, home network.
LE_CELLNET_REG_ROAMING	Registered to a roaming network.
LE_CELLNET_REG_UNKNOWN	Unknown state.

Function Documentation

le_cellnet_StateEventHandlerRef_t le_cellnet_AddStateEventHandler	(	le_cellnet_StateHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'le_cellnet_StateEvent'

This event provides information on network state changes

Parameters

[in]	handlerPtr
[in]	contextPtr

void le_cellnet_ConnectService

(

void

)

Connect the current client thread to the service providing this API.

This function must be called before any other functions in this API. Normally, it's automatically called for the main thread, but must be explicitly called for other threads. For details, see Client-specific Functions.

This function is created automatically.

void le_cellnet_DisconnectService

(

void

)

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see Client-specific Functions.

This function is created automatically.

void le_cellnet_Release

(

le_cellnet_RequestObjRef_t

cellNetRef

)

Release a cellular network

Parameters

[in]

cellNetRef

Reference to a cellular network request.

void le_cellnet_RemoveStateEventHandler

(

le_cellnet_StateEventHandlerRef_t

addHandlerRef

)

Remove handler function for EVENT 'le_cellnet_StateEvent'

Parameters

[in]

addHandlerRef

le_cellnet_RequestObjRef_t le_cellnet_Request

(

void

)

Request a cellular network

Returns

• A reference to the cellular network
• 0 (zero) if the network requested could not be processed