taf_diagDataID_interface.h File Reference

#include "legato.h"
#include "taf_types_interface.h"
#include "taf_diagDataID_common.h"

Go to the source code of this file.

Typedefs
typedef void(*	taf_diagDataID_DisconnectHandler_t) (void *)

Functions
void	taf_diagDataID_ConnectService (void)
le_result_t	taf_diagDataID_TryConnectService (void)
LE_FULL_API void	taf_diagDataID_SetServerDisconnectHandler (taf_diagDataID_DisconnectHandler_t disconnectHandler, void *contextPtr)
LE_FULL_API void	taf_diagDataID_SetNonExitServerDisconnectHandler (taf_diagDataID_DisconnectHandler_t disconnectHandler, void *contextPtr)
void	taf_diagDataID_DisconnectService (void)
taf_diagDataID_ServiceRef_t	taf_diagDataID_GetService (void)
taf_diagDataID_RxReadDIDMsgHandlerRef_t	taf_diagDataID_AddRxReadDIDMsgHandler (taf_diagDataID_ServiceRef_t svcRef, taf_diagDataID_RxReadDIDMsgHandlerFunc_t handlerPtr, void *contextPtr)
void	taf_diagDataID_RemoveRxReadDIDMsgHandler (taf_diagDataID_RxReadDIDMsgHandlerRef_t handlerRef)
le_result_t	taf_diagDataID_SendReadDIDResp (taf_diagDataID_RxReadDIDMsgRef_t rxMsgRef, taf_diagDataID_ReadDIDErrorCode_t errCode, const uint8_t *dataPtr, size_t dataSize)
taf_diagDataID_RxWriteDIDMsgHandlerRef_t	taf_diagDataID_AddRxWriteDIDMsgHandler (taf_diagDataID_ServiceRef_t svcRef, taf_diagDataID_RxWriteDIDMsgHandlerFunc_t handlerPtr, void *contextPtr)
void	taf_diagDataID_RemoveRxWriteDIDMsgHandler (taf_diagDataID_RxWriteDIDMsgHandlerRef_t handlerRef)
le_result_t	taf_diagDataID_GetWriteDataRecord (taf_diagDataID_RxWriteDIDMsgRef_t rxMsgRef, uint8_t *dataRecordPtr, size_t *dataRecordSizePtr)
le_result_t	taf_diagDataID_SendWriteDIDResp (taf_diagDataID_RxWriteDIDMsgRef_t rxMsgRef, taf_diagDataID_WriteDIDErrorCode_t errCode, uint16_t dataId)
le_result_t	taf_diagDataID_RemoveSvc (taf_diagDataID_ServiceRef_t svcRef)

Typedef Documentation

taf_diagDataID_DisconnectHandler_t

typedef void(* taf_diagDataID_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

taf_diagDataID_ConnectService()

void taf_diagDataID_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_diagDataID_TryConnectService()

le_result_t taf_diagDataID_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_diagDataID_SetServerDisconnectHandler()

LE_FULL_API void taf_diagDataID_SetServerDisconnectHandler	(	taf_diagDataID_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_diagDataID_SetNonExitServerDisconnectHandler()

LE_FULL_API void taf_diagDataID_SetNonExitServerDisconnectHandler	(	taf_diagDataID_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_diagDataID_DisconnectService()

void taf_diagDataID_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_diagDataID_GetService()

taf_diagDataID_ServiceRef_t taf_diagDataID_GetService

(

void

)

Gets the reference of a DataID service. If there is no service, a new one will be created.

Returns

• Reference to the service instance.
• NULL if not allowed to create the service.

Note

The process exits if an invalid reference is passed.

taf_diagDataID_AddRxReadDIDMsgHandler()

taf_diagDataID_RxReadDIDMsgHandlerRef_t taf_diagDataID_AddRxReadDIDMsgHandler	(	taf_diagDataID_ServiceRef_t	svcRef,
		taf_diagDataID_RxReadDIDMsgHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_diagDataID_RxReadDIDMsg'

This event provides information about the received ReadDID message.

Parameters

[in]	svcRef	Service reference.
[in]	handlerPtr	Received message handler.
[in]	contextPtr

taf_diagDataID_RemoveRxReadDIDMsgHandler()

void taf_diagDataID_RemoveRxReadDIDMsgHandler

(

taf_diagDataID_RxReadDIDMsgHandlerRef_t

handlerRef

)

Remove handler function for EVENT 'taf_diagDataID_RxReadDIDMsg'

Parameters

[in]

handlerRef

taf_diagDataID_SendReadDIDResp()

le_result_t taf_diagDataID_SendReadDIDResp	(	taf_diagDataID_RxReadDIDMsgRef_t	rxMsgRef,
		taf_diagDataID_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]	rxMsgRef	Received message reference.
[in]	errCode	Error code type.
[in]	dataPtr	Data payload.
[in]	dataSize

taf_diagDataID_AddRxWriteDIDMsgHandler()

taf_diagDataID_RxWriteDIDMsgHandlerRef_t taf_diagDataID_AddRxWriteDIDMsgHandler	(	taf_diagDataID_ServiceRef_t	svcRef,
		taf_diagDataID_RxWriteDIDMsgHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_diagDataID_RxWriteDIDMsg'

This event provides information about the received ReadDID message.

Parameters

[in]	svcRef	Service reference.
[in]	handlerPtr	Received message handler.
[in]	contextPtr

taf_diagDataID_RemoveRxWriteDIDMsgHandler()

void taf_diagDataID_RemoveRxWriteDIDMsgHandler

(

taf_diagDataID_RxWriteDIDMsgHandlerRef_t

handlerRef

)

Remove handler function for EVENT 'taf_diagDataID_RxWriteDIDMsg'

Parameters

[in]

handlerRef

taf_diagDataID_GetWriteDataRecord()

le_result_t taf_diagDataID_GetWriteDataRecord	(	taf_diagDataID_RxWriteDIDMsgRef_t	rxMsgRef,
		uint8_t *	dataRecordPtr,
		size_t *	dataRecordSizePtr
	)

Gets the data record of the received WriteDID message.

Returns

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

Note

The process exits if an invalid reference is passed.

Parameters

[in]	rxMsgRef	Received message reference.
[out]	dataRecordPtr	Data record.
[in,out]	dataRecordSizePtr

taf_diagDataID_SendWriteDIDResp()

le_result_t taf_diagDataID_SendWriteDIDResp	(	taf_diagDataID_RxWriteDIDMsgRef_t	rxMsgRef,
		taf_diagDataID_WriteDIDErrorCode_t	errCode,
		uint16_t	dataId
	)

Sends a response message for the received 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.

taf_diagDataID_RemoveSvc()

le_result_t taf_diagDataID_RemoveSvc

(

taf_diagDataID_ServiceRef_t

svcRef

)

Removes the DID service.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Invalid svcRef.

Parameters

[in]

svcRef

Service reference.