libicsneo/include/icsneo/disk/diskreaddriver.h

41 lines
1.1 KiB
C++

#ifndef __DISKREADDRIVER_H__
#define __DISKREADDRIVER_H__
#ifdef __cplusplus
#include "icsneo/platform/optional.h"
#include "icsneo/communication/communication.h"
#include "icsneo/api/eventmanager.h"
#include "icsneo/disk/diskdriver.h"
#include <cstdint>
#include <chrono>
namespace icsneo {
namespace Disk {
/**
* Interface for drivers which read block data from devices
*/
class ReadDriver : public virtual Driver {
public:
virtual optional<uint64_t> readLogicalDisk(Communication& com, device_eventhandler_t report,
uint64_t pos, uint8_t* into, uint64_t amount, std::chrono::milliseconds timeout = DefaultTimeout);
protected:
/**
* Perform a read which the driver can do in one shot.
*
* The `pos` requested must be sector-aligned, and the `amount` must be
* within the block size bounds provided by the driver.
*/
virtual optional<uint64_t> readLogicalDiskAligned(Communication& com, device_eventhandler_t report,
uint64_t pos, uint8_t* into, uint64_t amount, std::chrono::milliseconds timeout) = 0;
};
} // namespace Disk
} // namespace icsneo
#endif // __cplusplus
#endif // __DISKREADDRIVER_H__