taf_mngdConn_interface.h File Reference

#include "legato.h"
#include "taf_sim_interface.h"
#include "taf_radio_interface.h"
#include "taf_dcs_interface.h"
#include "taf_mngdConn_common.h"

Go to the source code of this file.

Typedefs
typedef void(*	taf_mngdConn_DisconnectHandler_t) (void *)

Functions
void	taf_mngdConn_ConnectService (void)
le_result_t	taf_mngdConn_TryConnectService (void)
LE_FULL_API void	taf_mngdConn_SetServerDisconnectHandler (taf_mngdConn_DisconnectHandler_t disconnectHandler, void *contextPtr)
LE_FULL_API void	taf_mngdConn_SetNonExitServerDisconnectHandler (taf_mngdConn_DisconnectHandler_t disconnectHandler, void *contextPtr)
void	taf_mngdConn_DisconnectService (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)

Typedef Documentation

taf_mngdConn_DisconnectHandler_t

typedef void(* taf_mngdConn_DisconnectHandler_t) (void *)

Include Managed Services common definitions. Type for handler called when a server disconnects.

Function Documentation

taf_mngdConn_ConnectService()

void taf_mngdConn_ConnectService

(

void

)

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

taf_mngdConn_TryConnectService()

le_result_t taf_mngdConn_TryConnectService

(

void

)

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

Returns

• LE_OK if the client connected successfully to the service.
• LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
• LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
• LE_COMM_ERROR if the Service Directory cannot be reached.

taf_mngdConn_SetServerDisconnectHandler()

LE_FULL_API void taf_mngdConn_SetServerDisconnectHandler	(	taf_mngdConn_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

taf_mngdConn_SetNonExitServerDisconnectHandler()

LE_FULL_API void taf_mngdConn_SetNonExitServerDisconnectHandler	(	taf_mngdConn_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected without exiting.

When a server connection is lost, call this handler without exit.

Warning

When using the API, it needs the application developer to handle some cases like re-connecting and recycling the resources. For most of cases, it is safe to use SetServerDisconnectHandler.

taf_mngdConn_DisconnectService()

void taf_mngdConn_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 apiFilesC_client.

This function is created automatically.

taf_mngdConn_AddDataStateHandler()

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

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]	dataRef	The data reference.
[in]	handlerPtr	The 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]	handlerPtr	The 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]

dataId

The 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]

dataName

The 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]	dataRef	The data reference.
[out]	dataIdPtr	The 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]	dataRef	The data reference.
[out]	dataName	The 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]

dataRef

The 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]

dataRef

The 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]	dataRef	The data reference.
[out]	statePtr	The 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]	dataRef	The data reference.
[out]	IPv4Addr	IPv4 Address.
[in]	IPv4AddrSize
[out]	IPv6Addr	IPv6 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]

dataRef

The 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]

dataRef

The 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]

dataRef

The data reference.