taf_diagReset_server.h File Reference

#include "legato.h"
#include "taf_types_server.h"
#include "taf_diagReset_common.h"

Go to the source code of this file.

Functions
le_msg_ServiceRef_t	taf_diagReset_GetServiceRef (void)
le_msg_SessionRef_t	taf_diagReset_GetClientSessionRef (void)
void	taf_diagReset_AdvertiseService (void)
taf_diagReset_ServiceRef_t	taf_diagReset_GetService (taf_diagReset_Type_t resetType)
taf_diagReset_RxMsgHandlerRef_t	taf_diagReset_AddRxMsgHandler (taf_diagReset_ServiceRef_t svcRef, taf_diagReset_RxMsgHandlerFunc_t handlerPtr, void *contextPtr)
void	taf_diagReset_RemoveRxMsgHandler (taf_diagReset_RxMsgHandlerRef_t handlerRef)
le_result_t	taf_diagReset_SendResp (taf_diagReset_RxMsgRef_t rxMsgRef, taf_diagReset_ErrorCode_t errCode)
le_result_t	taf_diagReset_RemoveSvc (taf_diagReset_ServiceRef_t svcRef)

Function Documentation

taf_diagReset_GetServiceRef()

le_msg_ServiceRef_t taf_diagReset_GetServiceRef

(

void

)

Get the server service reference

taf_diagReset_GetClientSessionRef()

le_msg_SessionRef_t taf_diagReset_GetClientSessionRef

(

void

)

Get the client session reference for the current message

taf_diagReset_AdvertiseService()

void taf_diagReset_AdvertiseService

(

void

)

Initialize the server and advertise the service.

taf_diagReset_GetService()

taf_diagReset_ServiceRef_t taf_diagReset_GetService

(

taf_diagReset_Type_t

resetType

)

Reset type. Error code for Reset. Reference to the Reset service. Reference to the Reset received request message. Handler for a Rx Reset message. Reference type used by Add/Remove functions for EVENT 'taf_diagReset_RxMsg' Gets the reference to a Reset service, if there's no Reset 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.

Gets the reference to a Reset service, if there's no Reset 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.

Parameters

[in]

resetType

taf_diagReset_AddRxMsgHandler()

taf_diagReset_RxMsgHandlerRef_t taf_diagReset_AddRxMsgHandler	(	taf_diagReset_ServiceRef_t	svcRef,
		taf_diagReset_RxMsgHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_diagReset_RxMsg'

This event provides information on Rx Reset message.

Parameters

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

taf_diagReset_RemoveRxMsgHandler()

void taf_diagReset_RemoveRxMsgHandler

(

taf_diagReset_RxMsgHandlerRef_t

handlerRef

)

Remove handler function for EVENT 'taf_diagReset_RxMsg'

Parameters

[in]

handlerRef

taf_diagReset_SendResp()

le_result_t taf_diagReset_SendResp	(	taf_diagReset_RxMsgRef_t	rxMsgRef,
		taf_diagReset_ErrorCode_t	errCode
	)

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

taf_diagReset_RemoveSvc()

le_result_t taf_diagReset_RemoveSvc

(

taf_diagReset_ServiceRef_t

svcRef

)

Removes the Reset service.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Invalid svcRef.

Parameters

[in]

svcRef

Service reference.