apra::StorageUSB Class Reference

#include <StorageUSB.h>

Public Member Functions
	StorageUSB (std::string mountPath, std::vector< STORAGE_TYPE > supportedTypes, bool shouldPrint, bool skipMount=false)
virtual	~StorageUSB ()
virtual string	insertCheck ()
virtual string	mountDevice ()
virtual bool	ejectDevice ()
virtual bool	isUnsafeEject ()
bool	getStorageInfo (uint64_t &freeSpaceInMB, uint64_t &totalCapacityInMB)
STORAGE_STATE	getStatus ()
std::string	getMountPath ()
struct udev_device *	getChildDevice (struct udev *udev, struct udev_device *parent, const char *subsystem)

Protected Member Functions
string	findMountDeviceBylsblk (string devicePartitionNode)
string	findMountedDevice (string devicePartitionNode)
std::string	enumerateDevices (struct udev *udev)
std::vector< StorageMinimalInfo >	getPartitions (std::string devpath)
bool	mountDeviceNode (string deviceNode)
bool	mountUSBDevice (StorageMinimalInfo storageDevice, uint8_t retryLimit=3)
bool	unMountUSBDevice ()
bool	unMountWithPrivilege ()
bool	unMountWithoutPrivilege ()
bool	mountWithPrivilege (StorageMinimalInfo storageDevice, uint8_t retryLimit=3)
bool	mountWithoutPrivilege (StorageMinimalInfo storageDevice)
StorageMinimalInfo	getHighCapacityPartition (std::string deviceNode)
bool	isDeviceNodeConnected ()
void	checkDeviceNode ()

Protected Attributes
bool	m_shouldPrint
std::vector< STORAGE_TYPE >	m_supportedTypes
std::string	m_mountPoint
std::string	m_deviceNode
std::string	m_partitionNode
bool	m_skipMount
STORAGE_STATE	m_state
std::string	m_manualPath
int8_t	m_retryCount

Detailed Description

Definition at line 23 of file StorageUSB.h.

Constructor & Destructor Documentation

StorageUSB()

apra::StorageUSB::StorageUSB	(	std::string	mountPath,
		std::vector< STORAGE_TYPE >	supportedTypes,
		bool	shouldPrint,
		bool	skipMount = false
	)

Definition at line 37 of file StorageUSB.cpp.

References m_mountPoint, and m_supportedTypes.

~StorageUSB()

apra::StorageUSB::~StorageUSB ( )

virtual

Definition at line 59 of file StorageUSB.cpp.

Member Function Documentation

checkDeviceNode()

void apra::StorageUSB::checkDeviceNode ( )

protected

Definition at line 646 of file StorageUSB.cpp.

References m_deviceNode, m_retryCount, m_state, and apra::STORAGE_SAFE_EJECT.

ejectDevice()

bool apra::StorageUSB::ejectDevice ( )

virtual

Definition at line 523 of file StorageUSB.cpp.

References m_deviceNode, m_mountPoint, m_partitionNode, m_retryCount, m_state, apra::STORAGE_SAFE_EJECT, and unMountUSBDevice().

enumerateDevices()

string apra::StorageUSB::enumerateDevices ( struct udev *  udev )

protected

Definition at line 98 of file StorageUSB.cpp.

References getChildDevice().

Referenced by insertCheck().

findMountDeviceBylsblk()

string apra::StorageUSB::findMountDeviceBylsblk ( string  devicePartitionNode )

protected

Definition at line 538 of file StorageUSB.cpp.

References apra::Utils::caseInsensitiveSearch(), apra::Utils::exec(), m_shouldPrint, and apra::Utils::trim().

Referenced by isUnsafeEject(), mountDevice(), and mountUSBDevice().

findMountedDevice()

string apra::StorageUSB::findMountedDevice ( string  devicePartitionNode )

protected

Definition at line 564 of file StorageUSB.cpp.

getChildDevice()

struct udev_device * apra::StorageUSB::getChildDevice	(	struct udev *	udev,
		struct udev_device *	parent,
		const char *	subsystem
	)

Definition at line 78 of file StorageUSB.cpp.

Referenced by enumerateDevices().

getHighCapacityPartition()

StorageMinimalInfo apra::StorageUSB::getHighCapacityPartition ( std::string  deviceNode )

protected

Definition at line 244 of file StorageUSB.cpp.

References getPartitions(), apra::StorageMinimalInfo::m_fsType, apra::StorageMinimalInfo::m_partition, m_shouldPrint, and apra::StorageMinimalInfo::m_size.

Referenced by mountDevice(), and mountDeviceNode().

getMountPath()

std::string apra::StorageUSB::getMountPath

(

)

Definition at line 68 of file StorageUSB.cpp.

References m_mountPoint, m_state, and apra::STORAGE_MOUNTED.

getPartitions()

vector< StorageMinimalInfo > apra::StorageUSB::getPartitions ( std::string  devpath )

protected

Definition at line 279 of file StorageUSB.cpp.

References apra::Utils::caseInsensitiveSearch(), apra::Utils::exec(), m_shouldPrint, and MAX_BUF_LEN.

Referenced by getHighCapacityPartition().

getStatus()

STORAGE_STATE apra::StorageUSB::getStatus

(

)

Definition at line 63 of file StorageUSB.cpp.

References m_state.

getStorageInfo()

bool apra::StorageUSB::getStorageInfo	(	uint64_t &	freeSpaceInMB,
		uint64_t &	totalCapacityInMB
	)

Definition at line 590 of file StorageUSB.cpp.

References m_mountPoint, and m_shouldPrint.

insertCheck()

string apra::StorageUSB::insertCheck ( )

virtual

Definition at line 140 of file StorageUSB.cpp.

References enumerateDevices(), m_deviceNode, m_shouldPrint, m_state, apra::STORAGE_INSERTED, apra::STORAGE_SAFE_EJECT, and apra::STORAGE_UNSAFE_EJECT.

Referenced by mountDevice().

isDeviceNodeConnected()

bool apra::StorageUSB::isDeviceNodeConnected ( )

protected

Definition at line 265 of file StorageUSB.cpp.

References m_mountPoint.

isUnsafeEject()

bool apra::StorageUSB::isUnsafeEject ( )

virtual

Definition at line 212 of file StorageUSB.cpp.

References findMountDeviceBylsblk(), m_deviceNode, m_partitionNode, m_retryCount, m_state, apra::STORAGE_MOUNTED, and apra::STORAGE_UNSAFE_EJECT.

mountDevice()

string apra::StorageUSB::mountDevice ( )

virtual

Definition at line 161 of file StorageUSB.cpp.

References findMountDeviceBylsblk(), apra::STORAGE_TYPE_STRING::getEnum(), getHighCapacityPartition(), insertCheck(), apra::StorageMinimalInfo::m_fsType, m_mountPoint, apra::StorageMinimalInfo::m_partition, m_partitionNode, m_retryCount, m_shouldPrint, apra::StorageMinimalInfo::m_size, m_skipMount, m_state, m_supportedTypes, mountDeviceNode(), apra::STORAGE_INSERTED_UNMOUNTED, and apra::STORAGE_MOUNTED.

mountDeviceNode()

bool apra::StorageUSB::mountDeviceNode ( string  deviceNode )

protected

Definition at line 363 of file StorageUSB.cpp.

References getHighCapacityPartition(), m_deviceNode, apra::StorageMinimalInfo::m_partition, m_partitionNode, m_shouldPrint, and mountUSBDevice().

Referenced by mountDevice().

mountUSBDevice()

bool apra::StorageUSB::mountUSBDevice ( StorageMinimalInfo  storageDevice, uint8_t  retryLimit = 3  )

protected

Definition at line 324 of file StorageUSB.cpp.

References findMountDeviceBylsblk(), m_manualPath, m_mountPoint, apra::StorageMinimalInfo::m_partition, m_partitionNode, m_shouldPrint, mountWithoutPrivilege(), mountWithPrivilege(), and unMountUSBDevice().

Referenced by mountDeviceNode().

mountWithoutPrivilege()

bool apra::StorageUSB::mountWithoutPrivilege ( StorageMinimalInfo  storageDevice )

protected

Definition at line 449 of file StorageUSB.cpp.

References apra::Utils::caseInsensitiveSearch(), apra::Utils::exec(), apra::StorageMinimalInfo::m_partition, and m_shouldPrint.

Referenced by mountUSBDevice().

mountWithPrivilege()

bool apra::StorageUSB::mountWithPrivilege ( StorageMinimalInfo  storageDevice, uint8_t  retryLimit = 3  )

protected

Definition at line 390 of file StorageUSB.cpp.

References apra::StorageMinimalInfo::m_fsType, m_mountPoint, apra::StorageMinimalInfo::m_partition, m_shouldPrint, mountWithPrivilege(), and unMountUSBDevice().

Referenced by mountUSBDevice(), and mountWithPrivilege().

unMountUSBDevice()

bool apra::StorageUSB::unMountUSBDevice ( )

protected

Definition at line 514 of file StorageUSB.cpp.

References unMountWithoutPrivilege(), and unMountWithPrivilege().

Referenced by ejectDevice(), mountUSBDevice(), and mountWithPrivilege().

unMountWithoutPrivilege()

bool apra::StorageUSB::unMountWithoutPrivilege ( )

protected

Definition at line 497 of file StorageUSB.cpp.

References apra::Utils::caseInsensitiveSearch(), apra::Utils::exec(), m_partitionNode, and m_shouldPrint.

Referenced by unMountUSBDevice().

unMountWithPrivilege()

bool apra::StorageUSB::unMountWithPrivilege ( )

protected

Definition at line 471 of file StorageUSB.cpp.

References m_mountPoint, and m_shouldPrint.

Referenced by unMountUSBDevice().

Member Data Documentation

m_deviceNode

std::string apra::StorageUSB::m_deviceNode

protected

Definition at line 59 of file StorageUSB.h.

Referenced by checkDeviceNode(), ejectDevice(), insertCheck(), isUnsafeEject(), and mountDeviceNode().

m_manualPath

std::string apra::StorageUSB::m_manualPath

protected

Definition at line 63 of file StorageUSB.h.

Referenced by mountUSBDevice().

m_mountPoint

std::string apra::StorageUSB::m_mountPoint

protected

Definition at line 58 of file StorageUSB.h.

Referenced by ejectDevice(), getMountPath(), getStorageInfo(), isDeviceNodeConnected(), mountDevice(), mountUSBDevice(), mountWithPrivilege(), StorageUSB(), and unMountWithPrivilege().

m_partitionNode

std::string apra::StorageUSB::m_partitionNode

protected

Definition at line 60 of file StorageUSB.h.

Referenced by ejectDevice(), isUnsafeEject(), mountDevice(), mountDeviceNode(), mountUSBDevice(), and unMountWithoutPrivilege().

m_retryCount

int8_t apra::StorageUSB::m_retryCount

protected

Definition at line 64 of file StorageUSB.h.

Referenced by checkDeviceNode(), ejectDevice(), isUnsafeEject(), and mountDevice().

m_shouldPrint

bool apra::StorageUSB::m_shouldPrint

protected

Definition at line 56 of file StorageUSB.h.

Referenced by findMountDeviceBylsblk(), getHighCapacityPartition(), getPartitions(), getStorageInfo(), insertCheck(), mountDevice(), mountDeviceNode(), mountUSBDevice(), mountWithoutPrivilege(), mountWithPrivilege(), unMountWithoutPrivilege(), and unMountWithPrivilege().

m_skipMount

bool apra::StorageUSB::m_skipMount

protected

Definition at line 61 of file StorageUSB.h.

Referenced by mountDevice().

m_state

STORAGE_STATE apra::StorageUSB::m_state

protected

Definition at line 62 of file StorageUSB.h.

Referenced by checkDeviceNode(), ejectDevice(), getMountPath(), getStatus(), insertCheck(), isUnsafeEject(), and mountDevice().

m_supportedTypes

std::vector<STORAGE_TYPE> apra::StorageUSB::m_supportedTypes

protected

Definition at line 57 of file StorageUSB.h.

Referenced by mountDevice(), and StorageUSB().

---

The documentation for this class was generated from the following files:

• includes/utils/StorageUSB.h
• src/utils/StorageUSB.cpp