Filesystem

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 }

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	~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.

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	~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.

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