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_StateHandler *	le_cellnet_StateHandlerRef_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_StartClient (const char *serviceInstanceName)
void	le_cellnet_StopClient (void)
le_cellnet_StateHandlerRef_t	le_cellnet_AddStateHandler (le_cellnet_StateHandlerFunc_t handlerPtr, void *contextPtr)
void	le_cellnet_RemoveStateHandler (le_cellnet_StateHandlerRef_t addHandlerRef)
le_cellnet_RequestObjRef_t	le_cellnet_Request (void)
void	le_cellnet_Release (le_cellnet_RequestObjRef_t cellNetRef)

Detailed Description

Legato Cellular Network Service include file.

Copyright (C) Sierra Wireless, Inc. 2014. 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 void(* le_cellnet_StateHandlerFunc_t)(le_cellnet_State_t state, void *contextPtr)

Handler for network state changes

Parameters

state	The cellular network state
contextPtr

typedef struct le_cellnet_StateHandler* le_cellnet_StateHandlerRef_t

Reference type for le_cellnet_StateHandler handler ADD/REMOVE functions

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_StateHandlerRef_t le_cellnet_AddStateHandler	(	le_cellnet_StateHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

le_cellnet_StateHandler handler ADD function

Parameters

[in]	handlerPtr
[in]	contextPtr

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_RemoveStateHandler

(

le_cellnet_StateHandlerRef_t

addHandlerRef

)

le_cellnet_StateHandler handler REMOVE function

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

void le_cellnet_StartClient

(

const char *

serviceInstanceName

)

Start the service for the client main thread

Parameters

[in]

serviceInstanceName

void le_cellnet_StopClient

(

void

)

Stop the service for the current client thread