taf_diagSecBackend_common.h File Reference

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

Go to the source code of this file.

Macros
#define	IFGEN_TAF_DIAGSECBACKEND_PROTOCOL_ID   "3db4168f14dfbf56d84be47b1a6da71e"
#define	IFGEN_TAF_DIAGSECBACKEND_MSG_SIZE   16
#define	TAF_DIAGSECBACKEND_MAX_PAYLOAD_SIZE   4095

Typedefs
typedef struct taf_diagSecBackend_SesTypeCheck *	taf_diagSecBackend_SesTypeCheckRef_t
typedef struct taf_diagSecBackend_SesTypeCheckHandler *	taf_diagSecBackend_SesTypeCheckHandlerRef_t
typedef struct taf_diagSecBackend_SesChangeHandler *	taf_diagSecBackend_SesChangeHandlerRef_t
typedef void(*	taf_diagSecBackend_SesTypeHandlerFunc_t) (taf_diagSecBackend_SesTypeCheckRef_t sesTypeRef, taf_diagSecBackend_SessionType_t sesCtrlType, void *contextPtr)
typedef void(*	taf_diagSecBackend_SesChangeHandlerFunc_t) (taf_diagSecBackend_SessionType_t previousType, taf_diagSecBackend_SessionType_t currentType, void *contextPtr)

Enumerations
enum	taf_diagSecBackend_SessionType_t {   TAF_DIAGSECBACKEND_DEFAULT = 1, TAF_DIAGSECBACKEND_PROGRAMMING = 2, TAF_DIAGSECBACKEND_EXTENDED = 3, TAF_DIAGSECBACKEND_VEHICLE_MANUFACTURER_SPECIFIC = 64,   TAF_DIAGSECBACKEND_FOTA = 66, TAF_DIAGSECBACKEND_SYSTEM_SUPPLIER_SPECIFIC = 96 }
enum	taf_diagSecBackend_SesControlErrorCode_t { TAF_DIAGSECBACKEND_SES_CONTROL_NO_ERROR = 0, TAF_DIAGSECBACKEND_SES_CONTROL_CONDITIONS_NOT_CORRECT = 34 }

Functions
LE_SHARED bool	ifgen_taf_diagSecBackend_HasLocalBinding (void)
LE_SHARED void	ifgen_taf_diagSecBackend_InitCommonData (void)
LE_SHARED void	ifgen_taf_diagSecBackend_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
LE_SHARED le_result_t	ifgen_taf_diagSecBackend_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
LE_SHARED taf_diagSecBackend_SesTypeCheckHandlerRef_t	ifgen_taf_diagSecBackend_AddSesTypeCheckHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagSecBackend_SesTypeHandlerFunc_t handlerPtr, void *contextPtr)
LE_SHARED void	ifgen_taf_diagSecBackend_RemoveSesTypeCheckHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagSecBackend_SesTypeCheckHandlerRef_t handlerRef)
LE_SHARED le_result_t	ifgen_taf_diagSecBackend_SendSesTypeCheckResp (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagSecBackend_SesTypeCheckRef_t sesTypeRef, taf_diagSecBackend_SesControlErrorCode_t errCode)
LE_SHARED taf_diagSecBackend_SesChangeHandlerRef_t	ifgen_taf_diagSecBackend_AddSesChangeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagSecBackend_SesChangeHandlerFunc_t handlerPtr, void *contextPtr)
LE_SHARED void	ifgen_taf_diagSecBackend_RemoveSesChangeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_diagSecBackend_SesChangeHandlerRef_t handlerRef)

Macro Definition Documentation

IFGEN_TAF_DIAGSECBACKEND_PROTOCOL_ID

#define IFGEN_TAF_DIAGSECBACKEND_PROTOCOL_ID   "3db4168f14dfbf56d84be47b1a6da71e"

IFGEN_TAF_DIAGSECBACKEND_MSG_SIZE

#define IFGEN_TAF_DIAGSECBACKEND_MSG_SIZE   16

TAF_DIAGSECBACKEND_MAX_PAYLOAD_SIZE

#define TAF_DIAGSECBACKEND_MAX_PAYLOAD_SIZE   4095

The maximum size of the payload data in bytes.

Typedef Documentation

taf_diagSecBackend_SesTypeCheckRef_t

typedef struct taf_diagSecBackend_SesTypeCheck* taf_diagSecBackend_SesTypeCheckRef_t

Reference to the SessionControl request message.

taf_diagSecBackend_SesTypeCheckHandlerRef_t

typedef struct taf_diagSecBackend_SesTypeCheckHandler* taf_diagSecBackend_SesTypeCheckHandlerRef_t

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

taf_diagSecBackend_SesChangeHandlerRef_t

typedef struct taf_diagSecBackend_SesChangeHandler* taf_diagSecBackend_SesChangeHandlerRef_t

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

taf_diagSecBackend_SesTypeHandlerFunc_t

typedef void(* taf_diagSecBackend_SesTypeHandlerFunc_t) (taf_diagSecBackend_SesTypeCheckRef_t sesTypeRef, taf_diagSecBackend_SessionType_t sesCtrlType, void *contextPtr)

Handler for a session control type.

taf_diagSecBackend_SesChangeHandlerFunc_t

typedef void(* taf_diagSecBackend_SesChangeHandlerFunc_t) (taf_diagSecBackend_SessionType_t previousType, taf_diagSecBackend_SessionType_t currentType, void *contextPtr)

Handler for a session control type change.

Enumeration Type Documentation

taf_diagSecBackend_SessionType_t

enum taf_diagSecBackend_SessionType_t

Diagnostic SessionControl type.

Enumerator
TAF_DIAGSECBACKEND_DEFAULT	Default session.
TAF_DIAGSECBACKEND_PROGRAMMING	Programming session.
TAF_DIAGSECBACKEND_EXTENDED	Extended diagnostic session.
TAF_DIAGSECBACKEND_VEHICLE_MANUFACTURER_SPECIFIC	Vehicle manufacture specific session.
TAF_DIAGSECBACKEND_FOTA	FOTA session.
TAF_DIAGSECBACKEND_SYSTEM_SUPPLIER_SPECIFIC	System supplier specific session.

taf_diagSecBackend_SesControlErrorCode_t

enum taf_diagSecBackend_SesControlErrorCode_t

Error code for SessionControl.

Enumerator
TAF_DIAGSECBACKEND_SES_CONTROL_NO_ERROR
TAF_DIAGSECBACKEND_SES_CONTROL_CONDITIONS_NOT_CORRECT

Function Documentation

ifgen_taf_diagSecBackend_HasLocalBinding()

LE_SHARED bool ifgen_taf_diagSecBackend_HasLocalBinding

(

void

)

Get if this client bound locally.

ifgen_taf_diagSecBackend_InitCommonData()

LE_SHARED void ifgen_taf_diagSecBackend_InitCommonData

(

void

)

Init data that is common across all threads

ifgen_taf_diagSecBackend_CleanupCommonData()

LE_SHARED void ifgen_taf_diagSecBackend_CleanupCommonData

(

le_msg_SessionRef_t

_ifgen_sessionRef

)

Cleanup the data of a session

ifgen_taf_diagSecBackend_OpenSession()

LE_SHARED le_result_t ifgen_taf_diagSecBackend_OpenSession	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		bool	isBlocking
	)

Perform common initialization and open a session

ifgen_taf_diagSecBackend_AddSesTypeCheckHandler()

LE_SHARED taf_diagSecBackend_SesTypeCheckHandlerRef_t ifgen_taf_diagSecBackend_AddSesTypeCheckHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_diagSecBackend_SesTypeHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_diagSecBackend_SesTypeCheck'

This event provides information on Rx session control type.

Parameters

[in]	handlerPtr	Received message handler.
[in]	contextPtr

ifgen_taf_diagSecBackend_RemoveSesTypeCheckHandler()

LE_SHARED void ifgen_taf_diagSecBackend_RemoveSesTypeCheckHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_diagSecBackend_SesTypeCheckHandlerRef_t	handlerRef
	)

Remove handler function for EVENT 'taf_diagSecBackend_SesTypeCheck'

Parameters

[in]

handlerRef

ifgen_taf_diagSecBackend_SendSesTypeCheckResp()

LE_SHARED le_result_t ifgen_taf_diagSecBackend_SendSesTypeCheckResp	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_diagSecBackend_SesTypeCheckRef_t	sesTypeRef,
		taf_diagSecBackend_SesControlErrorCode_t	errCode
	)

Sends a response message for the condition check of session control type.

Note

This function must be called to send a response if receiving a message.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Invalid rxMsgRef.
• LE_NOT_FOUND – Reference not found.
• LE_FAULT – Failed.

Note

The process exits if an invalid reference is passed.

Parameters

[in]	sesTypeRef	Session type reference.
[in]	errCode	Error code type.

ifgen_taf_diagSecBackend_AddSesChangeHandler()

LE_SHARED taf_diagSecBackend_SesChangeHandlerRef_t ifgen_taf_diagSecBackend_AddSesChangeHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_diagSecBackend_SesChangeHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_diagSecBackend_SesChange'

This event provides information on session control type change.

Parameters

[in]	handlerPtr	Received message handler.
[in]	contextPtr

ifgen_taf_diagSecBackend_RemoveSesChangeHandler()

LE_SHARED void ifgen_taf_diagSecBackend_RemoveSesChangeHandler	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_diagSecBackend_SesChangeHandlerRef_t	handlerRef
	)

Remove handler function for EVENT 'taf_diagSecBackend_SesChange'

Parameters

[in]

handlerRef