taf_mdc_common.h File Reference

#include "legato.h"
#include "taf_types_common.h"
#include "taf_dcs_common.h"

Go to the source code of this file.

Macros
#define	IFGEN_TAF_MDC_PROTOCOL_ID   "03bc0472e26043aba7929c3cb1b5558c"
#define	IFGEN_TAF_MDC_MSG_SIZE   12

Functions
LE_SHARED bool	ifgen_taf_mdc_HasLocalBinding (void)
LE_SHARED void	ifgen_taf_mdc_InitCommonData (void)
LE_SHARED void	ifgen_taf_mdc_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
LE_SHARED le_result_t	ifgen_taf_mdc_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
LE_SHARED le_result_t	ifgen_taf_mdc_StartSession (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef)
LE_SHARED le_result_t	ifgen_taf_mdc_StartSessionAsync (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef)
LE_SHARED le_result_t	ifgen_taf_mdc_StopSession (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef)
LE_SHARED le_result_t	ifgen_taf_mdc_StopSessionAsync (le_msg_SessionRef_t _ifgen_sessionRef, taf_dcs_ProfileRef_t profileRef)

Macro Definition Documentation

IFGEN_TAF_MDC_PROTOCOL_ID

#define IFGEN_TAF_MDC_PROTOCOL_ID   "03bc0472e26043aba7929c3cb1b5558c"

IFGEN_TAF_MDC_MSG_SIZE

#define IFGEN_TAF_MDC_MSG_SIZE   12

Function Documentation

ifgen_taf_mdc_HasLocalBinding()

LE_SHARED bool ifgen_taf_mdc_HasLocalBinding

(

void

)

Get if this client bound locally.

ifgen_taf_mdc_InitCommonData()

LE_SHARED void ifgen_taf_mdc_InitCommonData

(

void

)

Init data that is common across all threads

ifgen_taf_mdc_CleanupCommonData()

LE_SHARED void ifgen_taf_mdc_CleanupCommonData

(

le_msg_SessionRef_t

_ifgen_sessionRef

)

Cleanup the data of a session

ifgen_taf_mdc_OpenSession()

LE_SHARED le_result_t ifgen_taf_mdc_OpenSession	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		bool	isBlocking
	)

Perform common initialization and open a session

ifgen_taf_mdc_StartSession()

LE_SHARED le_result_t ifgen_taf_mdc_StartSession	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_dcs_ProfileRef_t	profileRef
	)

Starts a permanent synchronous data cellular session for the given profile reference.

Returns

• LE_OK Successfully made the data call.
• LE_NOT_FOUND Parameter is invalid or cannot create the data call.
• LE_OUT_OF_RANGE PDP type is unknown.
• LE_BUSY Profile is in use.
• LE_TIMEOUT Timed out while attempting to make the data call.
• LE_FAULT Failed to make the data call.

Parameters

[in]

profileRef

The taf_dcs profile reference.

ifgen_taf_mdc_StartSessionAsync()

LE_SHARED le_result_t ifgen_taf_mdc_StartSessionAsync	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_dcs_ProfileRef_t	profileRef
	)

Starts a permanent asynchronous data cellular session for the given profile reference.

Returns

• LE_OK Successfully made the data call.
• LE_NOT_FOUND Parameter is invalid or cannot create the data call.
• LE_OUT_OF_RANGE PDP type is unknown.
• LE_BUSY Profile is in use.
• LE_TIMEOUT Timed out while attempting to make the data call.
• LE_FAULT Failed to make the data call.

Parameters

[in]

profileRef

The taf_dcs profile reference.

ifgen_taf_mdc_StopSession()

LE_SHARED le_result_t ifgen_taf_mdc_StopSession	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_dcs_ProfileRef_t	profileRef
	)

Synchronously stops a permanent data cellular session for the given profile reference.

Returns

• LE_OK Successfully stopped the data call.
• LE_NOT_FOUND Could not find the data call to stop.
• LE_OUT_OF_RANGE PDP type is unknown.
• LE_BAD_PARAMETER Call context is NULL.
• LE_TIMEOUT Timed out while attempting to stop the data call.
• LE_FAULT Failed to stop the data call.

Parameters

[in]

profileRef

The taf_dcs profile reference.

ifgen_taf_mdc_StopSessionAsync()

LE_SHARED le_result_t ifgen_taf_mdc_StopSessionAsync	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_dcs_ProfileRef_t	profileRef
	)

Asynchronously stops a permanent data cellular session for the given profile reference.

Returns

• LE_OK Successfully stopped the data call.
• LE_NOT_FOUND Could not find the data call to stop .
• LE_OUT_OF_RANGE PDP type is unknown.
• LE_BAD_PARAMETER Call context is NULL.
• LE_TIMEOUT Timed out while attempting to stop the data call.
• LE_FAULT Failed to stop the data call.

Parameters

[in]

profileRef

The taf_dcs profile reference.