taf_diagDIDBackend_interface.h File Reference

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

Go to the source code of this file.

Typedefs
typedef void(*	taf_diagDIDBackend_DisconnectHandler_t) (void *)

Functions
void	taf_diagDIDBackend_ConnectService (void)
le_result_t	taf_diagDIDBackend_TryConnectService (void)
LE_FULL_API void	taf_diagDIDBackend_SetServerDisconnectHandler (taf_diagDIDBackend_DisconnectHandler_t disconnectHandler, void *contextPtr)
LE_FULL_API void	taf_diagDIDBackend_SetNonExitServerDisconnectHandler (taf_diagDIDBackend_DisconnectHandler_t disconnectHandler, void *contextPtr)
void	taf_diagDIDBackend_DisconnectService (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)

Typedef Documentation

taf_diagDIDBackend_DisconnectHandler_t

typedef void(* taf_diagDIDBackend_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

taf_diagDIDBackend_ConnectService()

void taf_diagDIDBackend_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_diagDIDBackend_TryConnectService()

le_result_t taf_diagDIDBackend_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_diagDIDBackend_SetServerDisconnectHandler()

LE_FULL_API void taf_diagDIDBackend_SetServerDisconnectHandler	(	taf_diagDIDBackend_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_diagDIDBackend_SetNonExitServerDisconnectHandler()

LE_FULL_API void taf_diagDIDBackend_SetNonExitServerDisconnectHandler	(	taf_diagDIDBackend_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_diagDIDBackend_DisconnectService()

void taf_diagDIDBackend_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_diagDIDBackend_AddReadDIDHandler()

taf_diagDIDBackend_ReadDIDHandlerRef_t taf_diagDIDBackend_AddReadDIDHandler	(	taf_diagDIDBackend_ReadDIDHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

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.