taf_diagRoutineCtrl_interface.h File Reference

#include "legato.h"
#include "taf_types_interface.h"
#include "taf_diagRoutineCtrl_common.h"

Go to the source code of this file.

Typedefs
typedef void(*	taf_diagRoutineCtrl_DisconnectHandler_t) (void *)

Functions
void	taf_diagRoutineCtrl_ConnectService (void)
le_result_t	taf_diagRoutineCtrl_TryConnectService (void)
LE_FULL_API void	taf_diagRoutineCtrl_SetServerDisconnectHandler (taf_diagRoutineCtrl_DisconnectHandler_t disconnectHandler, void *contextPtr)
LE_FULL_API void	taf_diagRoutineCtrl_SetNonExitServerDisconnectHandler (taf_diagRoutineCtrl_DisconnectHandler_t disconnectHandler, void *contextPtr)
void	taf_diagRoutineCtrl_DisconnectService (void)
taf_diagRoutineCtrl_ServiceRef_t	taf_diagRoutineCtrl_GetService (uint16_t identifier)
taf_diagRoutineCtrl_RxMsgHandlerRef_t	taf_diagRoutineCtrl_AddRxMsgHandler (taf_diagRoutineCtrl_ServiceRef_t svcRef, taf_diagRoutineCtrl_RxMsgHandlerFunc_t handlerPtr, void *contextPtr)
void	taf_diagRoutineCtrl_RemoveRxMsgHandler (taf_diagRoutineCtrl_RxMsgHandlerRef_t handlerRef)
le_result_t	taf_diagRoutineCtrl_GetRoutineCtrlRec (taf_diagRoutineCtrl_RxMsgRef_t rxMsgRef, uint8_t *optionRecPtr, size_t *optionRecSizePtr)
le_result_t	taf_diagRoutineCtrl_SendResp (taf_diagRoutineCtrl_RxMsgRef_t rxMsgRef, taf_diagRoutineCtrl_ErrorCode_t errCode, const uint8_t *dataPtr, size_t dataSize)
le_result_t	taf_diagRoutineCtrl_RemoveSvc (taf_diagRoutineCtrl_ServiceRef_t svcRef)

Typedef Documentation

taf_diagRoutineCtrl_DisconnectHandler_t

typedef void(* taf_diagRoutineCtrl_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

taf_diagRoutineCtrl_ConnectService()

void taf_diagRoutineCtrl_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_diagRoutineCtrl_TryConnectService()

le_result_t taf_diagRoutineCtrl_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_diagRoutineCtrl_SetServerDisconnectHandler()

LE_FULL_API void taf_diagRoutineCtrl_SetServerDisconnectHandler	(	taf_diagRoutineCtrl_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_diagRoutineCtrl_SetNonExitServerDisconnectHandler()

LE_FULL_API void taf_diagRoutineCtrl_SetNonExitServerDisconnectHandler	(	taf_diagRoutineCtrl_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_diagRoutineCtrl_DisconnectService()

void taf_diagRoutineCtrl_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_diagRoutineCtrl_GetService()

taf_diagRoutineCtrl_ServiceRef_t taf_diagRoutineCtrl_GetService

(

uint16_t

identifier

)

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

identifier

Routine identifier.

taf_diagRoutineCtrl_AddRxMsgHandler()

taf_diagRoutineCtrl_RxMsgHandlerRef_t taf_diagRoutineCtrl_AddRxMsgHandler	(	taf_diagRoutineCtrl_ServiceRef_t	svcRef,
		taf_diagRoutineCtrl_RxMsgHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_diagRoutineCtrl_RxMsg'

This event provides information on Rx RoutineControl message.

Parameters

[in]	svcRef	Service reference.
[in]	handlerPtr
[in]	contextPtr

taf_diagRoutineCtrl_RemoveRxMsgHandler()

void taf_diagRoutineCtrl_RemoveRxMsgHandler

(

taf_diagRoutineCtrl_RxMsgHandlerRef_t

handlerRef

)

Remove handler function for EVENT 'taf_diagRoutineCtrl_RxMsg'

Parameters

[in]

handlerRef

taf_diagRoutineCtrl_GetRoutineCtrlRec()

le_result_t taf_diagRoutineCtrl_GetRoutineCtrlRec	(	taf_diagRoutineCtrl_RxMsgRef_t	rxMsgRef,
		uint8_t *	optionRecPtr,
		size_t *	optionRecSizePtr
	)

Gets the RoutineControl option record of the Rx RoutineControl 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]	optionRecPtr	RoutineControl option record.
[in,out]	optionRecSizePtr

taf_diagRoutineCtrl_SendResp()

le_result_t taf_diagRoutineCtrl_SendResp	(	taf_diagRoutineCtrl_RxMsgRef_t	rxMsgRef,
		taf_diagRoutineCtrl_ErrorCode_t	errCode,
		const uint8_t *	dataPtr,
		size_t	dataSize
	)

Sends a response message for the Rx RoutineControl 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	Payload data.
[in]	dataSize

taf_diagRoutineCtrl_RemoveSvc()

le_result_t taf_diagRoutineCtrl_RemoveSvc

(

taf_diagRoutineCtrl_ServiceRef_t

svcRef

)

Removes the RoutineControl server service.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Invalid svcRef.

Parameters

[in]

svcRef

Service reference.