Data Structures
struct	telux::platform::EfsEventInfo

class	telux::platform::IFsListener
	Listener class for getting notifications related to EFS backup/restore operations. The client needs to implement these methods as briefly as possible and avoid blocking calls in it. The methods in this class can be invoked from multiple different threads. Client needs to make sure that the implementation is thread-safe. More...

class	telux::platform::IFsManager
	IFsManager provides interface to to control and get notified about file system operations. This includes Embedded file system (EFS) operations. More...

Enumerations
enum	telux::platform::EfsEvent { telux::platform::EfsEvent::START, telux::platform::EfsEvent::END }

enum	telux::platform::OperationStatus { telux::platform::OperationStatus::UNKNOWN, telux::platform::OperationStatus::SUCCESS, telux::platform::OperationStatus::FAILURE }

enum	telux::platform::OtaOperation { telux::platform::OtaOperation::INVALID, telux::platform::OtaOperation::START, telux::platform::OtaOperation::RESUME }

Detailed Description

This section contains APIs, data structures and components to configure and acquire information from the filesystem manager.

Data Structure Documentation

struct telux::platform::EfsEventInfo

Data Fields
EfsEvent	event	The event being notified
ErrorCode	error	telux::common::ErrorCode associated with the event

class telux::platform::IFsListener

Listener class for getting notifications related to EFS backup/restore operations. The client needs to implement these methods as briefly as possible and avoid blocking calls in it. The methods in this class can be invoked from multiple different threads. Client needs to make sure that the implementation is thread-safe.

Public Member Functions
virtual void	OnEfsRestoreEvent (EfsEventInfo event)

virtual void	OnEfsBackupEvent (EfsEventInfo event)

virtual void	OnFsOperationImminentEvent (uint32_t timeLeftToStart)

virtual	~IFsListener ()

Public Member Functions inherited from telux::common::IServiceStatusListener
virtual void	onServiceStatusChange (ServiceStatus status)

virtual	~IServiceStatusListener ()

Constructor & Destructor Documentation

virtual telux::platform::IFsListener::~IFsListener ( )

virtual

Destructor of IFsListener

Member Function Documentation

virtual void telux::platform::IFsListener::OnEfsRestoreEvent ( EfsEventInfo event )

virtual

This function is called when a EFS restore operation is detected.

Parameters

[in] event Event related data. telux::platform::EfsEventInfo.

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual void telux::platform::IFsListener::OnEfsBackupEvent ( EfsEventInfo event )

virtual

This function is called when a EFS backup operation is detected.

Parameters

[in] event Event related data. telux::platform::EfsEventInfo.

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual void telux::platform::IFsListener::OnFsOperationImminentEvent ( uint32_t timeLeftToStart )

virtual

When the client is about to make an eCall it is expected to invoke prepareForEcall. This starts a timer within the FsManager which represents the max duration of the eCall. After which the filesystem operations will resume. This API will be invoked to let the client know that resumption of Fs operations is imminent. If the eCall has not yet ended, the client should call prepareForEcall again to reset the timer, which will continue to suspend the FS operations.

Parameters

[in] timeLeftToStart The time in seconds after which filesystem operations shall re-enable.

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

class telux::platform::IFsManager

IFsManager provides interface to to control and get notified about file system operations. This includes Embedded file system (EFS) operations.

Public Member Functions
virtual telux::common::ServiceStatus	getServiceStatus ()=0

virtual telux::common::Status	registerListener (std::weak_ptr< IFsListener > listener)=0

virtual telux::common::Status	deregisterListener (std::weak_ptr< IFsListener > listener)=0

virtual telux::common::Status	startEfsBackup ()=0

virtual telux::common::Status	prepareForEcall ()=0

virtual telux::common::Status	eCallCompleted ()=0

virtual telux::common::Status	prepareForOta (OtaOperation otaOperation, telux::common::ResponseCallback responseCb)=0

virtual telux::common::Status	otaCompleted (OperationStatus operationStatus, telux::common::ResponseCallback responseCb)=0

virtual telux::common::Status	startAbSync (telux::common::ResponseCallback responseCb)=0

virtual	~IFsManager ()

Constructor & Destructor Documentation

virtual telux::platform::IFsManager::~IFsManager ( )

virtual

Destructor of IFsManager

Member Function Documentation

virtual telux::common::ServiceStatus telux::platform::IFsManager::getServiceStatus ( )

pure virtual

This status indicates whether the object is in a usable state.

Returns: telux::common::ServiceStatus indicating the current status of the file system service.

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::platform::IFsManager::registerListener ( std::weak_ptr< IFsListener > listener )

pure virtual

Registers the listener for FileSystem Manager indications.

Parameters

[in] listener - pointer to implemented listener.

Returns: status of the registration request.

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::platform::IFsManager::deregisterListener ( std::weak_ptr< IFsListener > listener )

pure virtual

Deregisters the previously registered listener.

Parameters

[in] listener - pointer to registered listener that needs to be removed.

Returns: status of the deregistration request.

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::platform::IFsManager::startEfsBackup ( )

pure virtual

Request to trigger an EFS backup. If the request is successful, the status of EFS backup is notified via telux::platform::IFsListener::OnEfsBackupEvent.

Returns: The status of the request - telux::common::Status

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::platform::IFsManager::prepareForEcall ( )

pure virtual

The Filesystem Manager performs periodic operations which might be resource intensive. Such operations are not desired during other crucial events like an eCall. To avoid performing such operations during such events, the client is recommended to invoke this API before it initiates an eCall. This allows the filesystem manager to prepare the system to restrict any resource intensive operations like filesystem scrubbing during the eCall.

Note: - The client would need to periodically invoke this API to ensure that the timer gets reset so that operations do not get re-enabled.

Returns: - telux::common::Status

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::platform::IFsManager::eCallCompleted ( )

pure virtual

Once ecall complete, the client should invoke this API to re-enable filesystem operations like filesystem scrubbing.If the API invocation results in telux::common::Status::NOTREADY,indicating that the sub-system is not ready, the client should retry.

Returns: - telux::common::Status

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::platform::IFsManager::prepareForOta	(	OtaOperation	otaOperation,
		telux::common::ResponseCallback	responseCb
	)

pure virtual

This API should be invoked to allow the filesystem manager to perform operations like prepare the filesystem for an OTA. In addition to this preparation, any on-going operations like scrubbing is stopped.

Parameters

[in]	otaOperation	- telux::platform::OtaOperation.
[out]	responseCb	- telux::common::ResponseCallback The callback method to be invoked upon completion of OTA preparation and the response is indicated asynchronously.

Returns: - telux::common::Status

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::platform::IFsManager::otaCompleted	(	OperationStatus	operationStatus,
		telux::common::ResponseCallback	responseCb
	)

pure virtual

This API should be invoked upon completion of OTA, this will allow the filesystem manager to perform post OTA verifications and re-enable operations that were disabled for performing the OTA, like scrubbing.

Parameters

[in]	operationStatus	- telux::platform::OperationStatus The status of the OTA operation that the client attempted.
[out]	responseCb	- telux::common::ResponseCallback The callback method to be invoked upon completion of OTA related filesystem verifications and the response is indicated asynchronously.

Returns: - telux::common::Status

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

virtual telux::common::Status telux::platform::IFsManager::startAbSync ( telux::common::ResponseCallback responseCb )

pure virtual

This API should be invoked when the client decides to mirror the active partition to the inactive partition.

Parameters

[out] responseCb - telux::common::ResponseCallback The callback method to be invoked when the mirroring operation is completed and the response is indicated asynchronously.

Returns: - telux::common::Status

Note: Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

Enumeration Type Documentation

enum telux::platform::EfsEvent

strong

Enumerator
START	Indicating the beginning of Backup/Restore operation
END	Indicating the completion of Backup/Restore operation

enum telux::platform::OperationStatus

strong

Enumerator
UNKNOWN
SUCCESS
FAILURE

enum telux::platform::OtaOperation

strong

Enumerator
INVALID
START
RESUME

Data Structures

Enumerations

Detailed Description

Data Structure Documentation

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Enumeration Type Documentation