taf_diagDIDBackend_server.h File Reference

#include "legato.h"
#include "taf_diagDIDBackend_common.h"

Go to the source code of this file.

Functions
le_msg_ServiceRef_t	taf_diagDIDBackend_GetServiceRef (void)
le_msg_SessionRef_t	taf_diagDIDBackend_GetClientSessionRef (void)
void	taf_diagDIDBackend_AdvertiseService (void)
taf_diagDIDBackend_ReadDIDHandlerRef_t	taf_diagDIDBackend_AddReadDIDHandler (taf_diagDIDBackend_ReadDIDHandlerFunc_t handlerPtr, void *contextPtr)
void	taf_diagDIDBackend_RemoveReadDIDHandler (taf_diagDIDBackend_ReadDIDHandlerRef_t handlerRef)
le_result_t	taf_diagDIDBackend_SendReadDIDResp (taf_diagDIDBackend_ReadDIDRef_t readDIDRef, taf_diagDIDBackend_ReadDIDErrorCode_t errCode, const uint8_t *dataPtr, size_t dataSize)
taf_diagDIDBackend_WriteDIDHandlerRef_t	taf_diagDIDBackend_AddWriteDIDHandler (taf_diagDIDBackend_WriteDIDHandlerFunc_t handlerPtr, void *contextPtr)
void	taf_diagDIDBackend_RemoveWriteDIDHandler (taf_diagDIDBackend_WriteDIDHandlerRef_t handlerRef)
le_result_t	taf_diagDIDBackend_SendWriteDIDResp (taf_diagDIDBackend_WriteDIDRef_t rxMsgRef, taf_diagDIDBackend_WriteDIDErrorCode_t errCode, uint16_t dataId)

Function Documentation

taf_diagDIDBackend_GetServiceRef()

le_msg_ServiceRef_t taf_diagDIDBackend_GetServiceRef

(

void

)

Get the server service reference

taf_diagDIDBackend_GetClientSessionRef()

le_msg_SessionRef_t taf_diagDIDBackend_GetClientSessionRef

(

void

)

Get the client session reference for the current message

taf_diagDIDBackend_AdvertiseService()

void taf_diagDIDBackend_AdvertiseService

(

void

)

Initialize the server and advertise the service.

taf_diagDIDBackend_AddReadDIDHandler()

taf_diagDIDBackend_ReadDIDHandlerRef_t taf_diagDIDBackend_AddReadDIDHandler	(	taf_diagDIDBackend_ReadDIDHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Error code for ReadDID. Error code for WriteDID. Reference to the ReadDID request message. Reference to the WriteDID request message. Handler for a received ReadDID message. Reference type used by Add/Remove functions for EVENT 'taf_diagDIDBackend_ReadDID' Handler for a WriteDID message. Reference type used by Add/Remove functions for EVENT 'taf_diagDIDBackend_WriteDID' Add handler function for EVENT 'taf_diagDIDBackend_ReadDID'

This event provides information about the received ReadDID message.

Add handler function for EVENT 'taf_diagDIDBackend_ReadDID'

This event provides information about the received ReadDID message.

Parameters

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

taf_diagDIDBackend_RemoveReadDIDHandler()

void taf_diagDIDBackend_RemoveReadDIDHandler

(

taf_diagDIDBackend_ReadDIDHandlerRef_t

handlerRef

)

Remove handler function for EVENT 'taf_diagDIDBackend_ReadDID'

Parameters

[in]

handlerRef

taf_diagDIDBackend_SendReadDIDResp()

le_result_t taf_diagDIDBackend_SendReadDIDResp	(	taf_diagDIDBackend_ReadDIDRef_t	readDIDRef,
		taf_diagDIDBackend_ReadDIDErrorCode_t	errCode,
		const uint8_t *	dataPtr,
		size_t	dataSize
	)

Sends a response message for the received ReadDID message.

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]	readDIDRef	ReadDID message reference.
[in]	errCode	Error code type.
[in]	dataPtr	Data payload.
[in]	dataSize

taf_diagDIDBackend_AddWriteDIDHandler()

taf_diagDIDBackend_WriteDIDHandlerRef_t taf_diagDIDBackend_AddWriteDIDHandler	(	taf_diagDIDBackend_WriteDIDHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_diagDIDBackend_WriteDID'

This event provides information about the received ReadDID message.

Parameters

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

taf_diagDIDBackend_RemoveWriteDIDHandler()

void taf_diagDIDBackend_RemoveWriteDIDHandler

(

taf_diagDIDBackend_WriteDIDHandlerRef_t

handlerRef

)

Remove handler function for EVENT 'taf_diagDIDBackend_WriteDID'

Parameters

[in]

handlerRef

taf_diagDIDBackend_SendWriteDIDResp()

le_result_t taf_diagDIDBackend_SendWriteDIDResp	(	taf_diagDIDBackend_WriteDIDRef_t	rxMsgRef,
		taf_diagDIDBackend_WriteDIDErrorCode_t	errCode,
		uint16_t	dataId
	)

Sends a response message for the WriteDID message.

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]	rxMsgRef	Received message reference.
[in]	errCode	Error code type.
[in]	dataId	Data identifier.