le_data_interface.h File Reference
#include "legato.h"

Go to the source code of this file.

Typedefs

typedef struct le_data_RequestObj * le_data_RequestObjRef_t
 
typedef struct le_data_ConnectionStateHandler * le_data_ConnectionStateHandlerRef_t
 
typedef void(* le_data_ConnectionStateHandlerFunc_t) (const char *intfName, bool isConnected, void *contextPtr)
 

Functions

void le_data_ConnectService (void)
 
void le_data_DisconnectService (void)
 
le_data_ConnectionStateHandlerRef_t le_data_AddConnectionStateHandler (le_data_ConnectionStateHandlerFunc_t handlerPtr, void *contextPtr)
 
void le_data_RemoveConnectionStateHandler (le_data_ConnectionStateHandlerRef_t addHandlerRef)
 
le_data_RequestObjRef_t le_data_Request (void)
 
void le_data_Release (le_data_RequestObjRef_t requestRef)
 

Detailed Description

Legato Data Connection include file.

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

Typedef Documentation

typedef void(* le_data_ConnectionStateHandlerFunc_t) (const char *intfName, bool isConnected, void *contextPtr)

Handler for connection state changes

Parameters
intfNameInterface name for the data connection
isConnectedState: connected or disconnected
contextPtr
typedef struct le_data_ConnectionStateHandler* le_data_ConnectionStateHandlerRef_t

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

typedef struct le_data_RequestObj* le_data_RequestObjRef_t

Reference returned by Request function and used by Release function

Function Documentation

le_data_ConnectionStateHandlerRef_t le_data_AddConnectionStateHandler ( le_data_ConnectionStateHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'le_data_ConnectionState'

This event provides information on connection state changes

Parameters
[in]handlerPtr
[in]contextPtr
void le_data_ConnectService ( void  )

Connect the client to the service

void le_data_DisconnectService ( void  )

Disconnect the client from the service

void le_data_Release ( le_data_RequestObjRef_t  requestRef)

Release a previously requested data connection

Parameters
[in]requestRefReference to a previously requested data connection
void le_data_RemoveConnectionStateHandler ( le_data_ConnectionStateHandlerRef_t  addHandlerRef)

Remove handler function for EVENT 'le_data_ConnectionState'

Parameters
[in]addHandlerRef
le_data_RequestObjRef_t le_data_Request ( void  )

Request the default data connection

Returns
  • Reference to the data connection (to be used later for releasing the connection)
  • NULL if the data connection requested could not be processed