Snapdragon® Telematics Application Framework (TelAF) Interface Specification
taf_mngdConn_server.h File Reference
#include "legato.h"
#include "taf_sim_server.h"
#include "taf_radio_server.h"
#include "taf_dcs_server.h"
#include "taf_mngdConn_common.h"

Go to the source code of this file.

Functions

le_msg_ServiceRef_t taf_mngdConn_GetServiceRef (void)
 
le_msg_SessionRef_t taf_mngdConn_GetClientSessionRef (void)
 
void taf_mngdConn_AdvertiseService (void)
 
taf_mngdConn_DataStateHandlerRef_t taf_mngdConn_AddDataStateHandler (taf_mngdConn_DataRef_t dataRef, taf_mngdConn_DataStateHandlerFunc_t handlerPtr, void *contextPtr)
 
void taf_mngdConn_RemoveDataStateHandler (taf_mngdConn_DataStateHandlerRef_t handlerRef)
 
taf_mngdConn_RecoveryStateHandlerRef_t taf_mngdConn_AddRecoveryStateHandler (taf_mngdConn_RecoveryStateHandlerFunc_t handlerPtr, void *contextPtr)
 
void taf_mngdConn_RemoveRecoveryStateHandler (taf_mngdConn_RecoveryStateHandlerRef_t handlerRef)
 
taf_mngdConn_DataRef_t taf_mngdConn_GetData (uint8_t dataId)
 
taf_mngdConn_DataRef_t taf_mngdConn_GetDataByName (const char *LE_NONNULL dataName)
 
le_result_t taf_mngdConn_GetDataIdByRef (taf_mngdConn_DataRef_t dataRef, uint8_t *dataIdPtr)
 
le_result_t taf_mngdConn_GetDataNameByRef (taf_mngdConn_DataRef_t dataRef, char *dataName, size_t dataNameSize)
 
le_result_t taf_mngdConn_StartData (taf_mngdConn_DataRef_t dataRef)
 
le_result_t taf_mngdConn_StopData (taf_mngdConn_DataRef_t dataRef)
 
le_result_t taf_mngdConn_GetDataConnectionState (taf_mngdConn_DataRef_t dataRef, taf_mngdConn_DataState_t *statePtr)
 
le_result_t taf_mngdConn_GetDataConnectionIPAddresses (taf_mngdConn_DataRef_t dataRef, char *IPv4Addr, size_t IPv4AddrSize, char *IPv6Addr, size_t IPv6AddrSize)
 
le_result_t taf_mngdConn_StartDataRetry (taf_mngdConn_DataRef_t dataRef)
 
le_result_t taf_mngdConn_CancelL1Recovery (taf_mngdConn_DataRef_t dataRef)
 
le_result_t taf_mngdConn_CancelL2Recovery (taf_mngdConn_DataRef_t dataRef)
 

Function Documentation

◆ taf_mngdConn_GetServiceRef()

le_msg_ServiceRef_t taf_mngdConn_GetServiceRef ( void  )

Get the server service reference

◆ taf_mngdConn_GetClientSessionRef()

le_msg_SessionRef_t taf_mngdConn_GetClientSessionRef ( void  )

Get the client session reference for the current message

◆ taf_mngdConn_AdvertiseService()

void taf_mngdConn_AdvertiseService ( void  )

Initialize the server and advertise the service.

◆ taf_mngdConn_AddDataStateHandler()

taf_mngdConn_DataStateHandlerRef_t taf_mngdConn_AddDataStateHandler ( taf_mngdConn_DataRef_t  dataRef,
taf_mngdConn_DataStateHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Reference to data. The data state. Handler for data state. Reference type used by Add/Remove functions for EVENT 'taf_mngdConn_DataState' The connectivity recovery states. Handler for recovery state. Reference type used by Add/Remove functions for EVENT 'taf_mngdConn_RecoveryState' Add handler function for EVENT 'taf_mngdConn_DataState'

Events to report data state.

Add handler function for EVENT 'taf_mngdConn_DataState'

Events to report data state.

Include Managed Services common definitions. Add handler function for EVENT 'taf_mngdConn_DataState'

Events to report data state.

Parameters
[in]dataRefThe data reference.
[in]handlerPtrThe event handler reference.
[in]contextPtr

◆ taf_mngdConn_RemoveDataStateHandler()

void taf_mngdConn_RemoveDataStateHandler ( taf_mngdConn_DataStateHandlerRef_t  handlerRef)

Remove handler function for EVENT 'taf_mngdConn_DataState'

Parameters
[in]handlerRef

◆ taf_mngdConn_AddRecoveryStateHandler()

taf_mngdConn_RecoveryStateHandlerRef_t taf_mngdConn_AddRecoveryStateHandler ( taf_mngdConn_RecoveryStateHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_mngdConn_RecoveryState'

Events to report recovery state.

Parameters
[in]handlerPtrThe event handler reference.
[in]contextPtr

◆ taf_mngdConn_RemoveRecoveryStateHandler()

void taf_mngdConn_RemoveRecoveryStateHandler ( taf_mngdConn_RecoveryStateHandlerRef_t  handlerRef)

Remove handler function for EVENT 'taf_mngdConn_RecoveryState'

Parameters
[in]handlerRef

◆ taf_mngdConn_GetData()

taf_mngdConn_DataRef_t taf_mngdConn_GetData ( uint8_t  dataId)

Gets the data reference for the given data ID(as provided in the configuration JSON).

Returns
  • NULL – Error.
  • Others – The data reference.
Parameters
[in]dataIdThe data ID to use.

◆ taf_mngdConn_GetDataByName()

taf_mngdConn_DataRef_t taf_mngdConn_GetDataByName ( const char *LE_NONNULL  dataName)

Gets the data reference for the given data name(as provided in the configuration JSON).

Returns
  • NULL – Error.
  • Others – The data reference.
Parameters
[in]dataNameThe data name to use.

◆ taf_mngdConn_GetDataIdByRef()

le_result_t taf_mngdConn_GetDataIdByRef ( taf_mngdConn_DataRef_t  dataRef,
uint8_t *  dataIdPtr 
)

Gets the data object ID (as provided in the configuration JSON) for the given data reference.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Data reference not found.
  • Appropriate error is returned on failure.
Parameters
[in]dataRefThe data reference.
[out]dataIdPtrThe data object ID from the configuration JSON.

◆ taf_mngdConn_GetDataNameByRef()

le_result_t taf_mngdConn_GetDataNameByRef ( taf_mngdConn_DataRef_t  dataRef,
char *  dataName,
size_t  dataNameSize 
)

Gets the data object name (as provided in the configuration JSON) for the given data reference.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_FOUND – Data reference not found.
  • Appropriate error is returned on failure.
Parameters
[in]dataRefThe data reference.
[out]dataNameThe data object name from the configuration JSON.
[in]dataNameSize

◆ taf_mngdConn_StartData()

le_result_t taf_mngdConn_StartData ( taf_mngdConn_DataRef_t  dataRef)

Starts a data session for the given data reference. This API should be used when the value of "AutoStart" is "No" in the configuration file.

The service tracks clients that call StartData for Data objects with AutoStart:No and is used to manage StopData behavior.

Returns
  • LE_OK – Succeeded.
  • LE_DUPLICATE – The data connection is already started.
  • LE_IN_PROGRESS – The data connection establishment retry is in progress.
  • Appropriate error is returned on failure.
Parameters
[in]dataRefThe data reference.

◆ taf_mngdConn_StopData()

le_result_t taf_mngdConn_StopData ( taf_mngdConn_DataRef_t  dataRef)

Stops a data cellular session for the given data reference.

Data will be stopped only when all clients that have called StartData for data objects with AutoStart:No either stop data or exit.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_PERMITTED – If data is auto started by the service, application cannot stop data.
  • Appropriate error is returned on failure.
Parameters
[in]dataRefThe data reference.

◆ taf_mngdConn_GetDataConnectionState()

le_result_t taf_mngdConn_GetDataConnectionState ( taf_mngdConn_DataRef_t  dataRef,
taf_mngdConn_DataState_t statePtr 
)

Gets the data connection state information for the given data reference.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • Appropriate error is returned on failure.
Parameters
[in]dataRefThe data reference.
[out]statePtrThe data state.

◆ taf_mngdConn_GetDataConnectionIPAddresses()

le_result_t taf_mngdConn_GetDataConnectionIPAddresses ( taf_mngdConn_DataRef_t  dataRef,
char *  IPv4Addr,
size_t  IPv4AddrSize,
char *  IPv6Addr,
size_t  IPv6AddrSize 
)

Gets the data connection IP addresses for the given data reference. An empty string is returned if either IP address is not available.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • Appropriate error is returned on failure.
Parameters
[in]dataRefThe data reference.
[out]IPv4AddrIPv4 Address.
[in]IPv4AddrSize
[out]IPv6AddrIPv6 Address.
[in]IPv6AddrSize

◆ taf_mngdConn_StartDataRetry()

le_result_t taf_mngdConn_StartDataRetry ( taf_mngdConn_DataRef_t  dataRef)

Starts the data retry mechanism. If data session is connected, the data session will be disconnected before data retry mechanism is started. This function is asynchronous and applications should monitor taf_mngdConn_DataState_t events.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Bad parameter.
  • Appropriate error is returned on failure.
Parameters
[in]dataRefThe data reference.

◆ taf_mngdConn_CancelL1Recovery()

le_result_t taf_mngdConn_CancelL1Recovery ( taf_mngdConn_DataRef_t  dataRef)

Cancels a scheduled L1 recovery process. A L1 recovery could be scheduled for one or more data connetions. For a scheduled L1 recovery process to be canceled, this API should be called for all data references for which L1 recovery has been scheduled.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_POSSIBLE – A L1 recovery process has not been scheduled.
  • LE_NOT_PERMITTED – A L1 recovery process has already started.
  • Appropriate error is returned on failure.
Parameters
[in]dataRefThe data reference.

◆ taf_mngdConn_CancelL2Recovery()

le_result_t taf_mngdConn_CancelL2Recovery ( taf_mngdConn_DataRef_t  dataRef)

Cancels a scheduled L2 recovery process. A L2 recovery could be scheduled for one or more data connetions. For a scheduled L2 recovery process to be canceled, this API should be called for all data references for which L2 recovery has been scheduled.

Returns
  • LE_OK – Succeeded.
  • LE_NOT_POSSIBLE – A L2 recovery process has not been scheduled.
  • LE_NOT_PERMITTED – A L2 recovery process has already started.
  • Appropriate error is returned on failure.
Parameters
[in]dataRefThe data reference.