taf_diagSecBackend_interface.h File Reference

#include "legato.h"
#include "taf_types_interface.h"
#include "taf_diagSecBackend_common.h"

Go to the source code of this file.

Typedefs
typedef void(*	taf_diagSecBackend_DisconnectHandler_t) (void *)

Functions
void	taf_diagSecBackend_ConnectService (void)
le_result_t	taf_diagSecBackend_TryConnectService (void)
LE_FULL_API void	taf_diagSecBackend_SetServerDisconnectHandler (taf_diagSecBackend_DisconnectHandler_t disconnectHandler, void *contextPtr)
LE_FULL_API void	taf_diagSecBackend_SetNonExitServerDisconnectHandler (taf_diagSecBackend_DisconnectHandler_t disconnectHandler, void *contextPtr)
void	taf_diagSecBackend_DisconnectService (void)
taf_diagSecBackend_SesTypeCheckHandlerRef_t	taf_diagSecBackend_AddSesTypeCheckHandler (taf_diagSecBackend_SesTypeHandlerFunc_t handlerPtr, void *contextPtr)
void	taf_diagSecBackend_RemoveSesTypeCheckHandler (taf_diagSecBackend_SesTypeCheckHandlerRef_t handlerRef)
le_result_t	taf_diagSecBackend_SendSesTypeCheckResp (taf_diagSecBackend_SesTypeCheckRef_t sesTypeRef, taf_diagSecBackend_SesControlErrorCode_t errCode)
taf_diagSecBackend_SesChangeHandlerRef_t	taf_diagSecBackend_AddSesChangeHandler (taf_diagSecBackend_SesChangeHandlerFunc_t handlerPtr, void *contextPtr)
void	taf_diagSecBackend_RemoveSesChangeHandler (taf_diagSecBackend_SesChangeHandlerRef_t handlerRef)

Typedef Documentation

taf_diagSecBackend_DisconnectHandler_t

typedef void(* taf_diagSecBackend_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

taf_diagSecBackend_ConnectService()

void taf_diagSecBackend_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_diagSecBackend_TryConnectService()

le_result_t taf_diagSecBackend_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_diagSecBackend_SetServerDisconnectHandler()

LE_FULL_API void taf_diagSecBackend_SetServerDisconnectHandler	(	taf_diagSecBackend_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_diagSecBackend_SetNonExitServerDisconnectHandler()

LE_FULL_API void taf_diagSecBackend_SetNonExitServerDisconnectHandler	(	taf_diagSecBackend_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_diagSecBackend_DisconnectService()

void taf_diagSecBackend_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_diagSecBackend_AddSesTypeCheckHandler()

taf_diagSecBackend_SesTypeCheckHandlerRef_t taf_diagSecBackend_AddSesTypeCheckHandler	(	taf_diagSecBackend_SesTypeHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_diagSecBackend_SesTypeCheck'

This event provides information on Rx session control type.

Parameters

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

taf_diagSecBackend_RemoveSesTypeCheckHandler()

void taf_diagSecBackend_RemoveSesTypeCheckHandler

(

taf_diagSecBackend_SesTypeCheckHandlerRef_t

handlerRef

)

Remove handler function for EVENT 'taf_diagSecBackend_SesTypeCheck'

Parameters

[in]

handlerRef

taf_diagSecBackend_SendSesTypeCheckResp()

le_result_t taf_diagSecBackend_SendSesTypeCheckResp	(	taf_diagSecBackend_SesTypeCheckRef_t	sesTypeRef,
		taf_diagSecBackend_SesControlErrorCode_t	errCode
	)

Sends a response message for the condition check of session control type.

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]	sesTypeRef	Session type reference.
[in]	errCode	Error code type.

taf_diagSecBackend_AddSesChangeHandler()

taf_diagSecBackend_SesChangeHandlerRef_t taf_diagSecBackend_AddSesChangeHandler	(	taf_diagSecBackend_SesChangeHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_diagSecBackend_SesChange'

This event provides information on session control type change.

Parameters

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

taf_diagSecBackend_RemoveSesChangeHandler()

void taf_diagSecBackend_RemoveSesChangeHandler

(

taf_diagSecBackend_SesChangeHandlerRef_t

handlerRef

)

Remove handler function for EVENT 'taf_diagSecBackend_SesChange'

Parameters

[in]

handlerRef