transaction.h

Go to the documentation of this file.

#pragma once

 
#include "fl/stl/limits.h"
#include "fl/stl/stdint.h"
#include "fl/stl/unique_ptr.h"
#include "fl/stl/result.h"
#include "fl/stl/optional.h"
#include "fl/task/promise.h"  // for fl::task::Error
#include "fl/stl/noexcept.h"
 
namespace fl {
 
// Forward declaration for SPIError
enum class SPIError : u8;
 
namespace spi {
 
// Forward declaration
class Device;
 
// Type alias for SPI-specific Result type (matches spi.h)
template<typename T>
using Result = fl::result<T, SPIError>;
 
// ============================================================================
// Transaction Class (Async Operations)
// ============================================================================

class Transaction {
public:
    bool wait(u32 timeout_ms = (fl::numeric_limits<u32>::max)()) FL_NO_EXCEPT;

    bool isDone() const FL_NO_EXCEPT;

    bool isPending() const FL_NO_EXCEPT;

    bool cancel() FL_NO_EXCEPT;

    fl::optional<fl::task::Error> getResult() const FL_NO_EXCEPT;

    ~Transaction();
 
    // Move semantics
    Transaction(Transaction&& other) FL_NO_EXCEPT;
    Transaction& operator=(Transaction&& other) FL_NO_EXCEPT;
 
private:
    friend class Device;
 
    // Private constructor for Device to create transactions
    Transaction() FL_NO_EXCEPT;
 
    struct Impl;
    fl::unique_ptr<Impl> pImpl;
 
    // Non-copyable
    Transaction(const Transaction&) FL_NO_EXCEPT = delete;
    Transaction& operator=(const Transaction&) FL_NO_EXCEPT = delete;
};
 
} // namespace spi
} // namespace fl