taf_fsc_interface.h File Reference

#include "legato.h"
#include "taf_fsc_common.h"

Go to the source code of this file.

Typedefs
typedef void(*	taf_fsc_DisconnectHandler_t) (void *)

Functions
void	taf_fsc_ConnectService (void)
le_result_t	taf_fsc_TryConnectService (void)
LE_FULL_API void	taf_fsc_SetServerDisconnectHandler (taf_fsc_DisconnectHandler_t disconnectHandler, void *contextPtr)
LE_FULL_API void	taf_fsc_SetNonExitServerDisconnectHandler (taf_fsc_DisconnectHandler_t disconnectHandler, void *contextPtr)
void	taf_fsc_DisconnectService (void)
taf_fsc_StorageRef_t	taf_fsc_GetStorageRef (const char *LE_NONNULL dirPath, le_result_t *resultPtr)
le_result_t	taf_fsc_LockStorage (taf_fsc_StorageRef_t StorageRef)
le_result_t	taf_fsc_UnlockStorage (taf_fsc_StorageRef_t StorageRef)
le_result_t	taf_fsc_DeleteStorage (taf_fsc_StorageRef_t StorageRef)

Typedef Documentation

taf_fsc_DisconnectHandler_t

typedef void(* taf_fsc_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

taf_fsc_ConnectService()

void taf_fsc_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_fsc_TryConnectService()

le_result_t taf_fsc_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_fsc_SetServerDisconnectHandler()

LE_FULL_API void taf_fsc_SetServerDisconnectHandler	(	taf_fsc_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_fsc_SetNonExitServerDisconnectHandler()

LE_FULL_API void taf_fsc_SetNonExitServerDisconnectHandler	(	taf_fsc_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_fsc_DisconnectService()

void taf_fsc_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_fsc_GetStorageRef()

taf_fsc_StorageRef_t taf_fsc_GetStorageRef	(	const char *LE_NONNULL	dirPath,
		le_result_t *	resultPtr
	)

Gets the FS-Crypt storage object reference, including initialization for the FS-Crypt directory.

Returns

• Storage – The FS-Crypt storage object reference.
• NULL – Failure in process.

Parameters

[in]	dirPath	Storage name.
[out]	resultPtr	Error status.

taf_fsc_LockStorage()

le_result_t taf_fsc_LockStorage

(

taf_fsc_StorageRef_t

StorageRef

)

Removes an FS-Crypt key from the kernel keyring to lock the directory.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Bad parameter(s).
• LE_NOT_FOUND – The key does not exist or is not provisioned.
• LE_FAULT – Error in process.

Parameters

[in]

StorageRef

Storage reference.

taf_fsc_UnlockStorage()

le_result_t taf_fsc_UnlockStorage

(

taf_fsc_StorageRef_t

StorageRef

)

Adds an FS-Crypt key to the kernel keyring to unlock the directory.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Bad parameter(s).
• LE_NOT_FOUND – Key does not exist.
• LE_FAULT – Error in process.

Parameters

[in]

StorageRef

Storage reference.

taf_fsc_DeleteStorage()

le_result_t taf_fsc_DeleteStorage

(

taf_fsc_StorageRef_t

StorageRef

)

Cleans the entire FS-Crypt directory and encryption key.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Bad parameter(s).
• LE_NOT_FOUND – Key does not exist.
• LE_FAULT – Error in process.

Parameters

[in]

StorageRef

Storage reference.