ublk-cpp/handler_8hpp_source.html

#pragma once


#include "ublk/detail/execution.hpp"

#include "ublk/ublk_cmd.h"

#include <concepts>

#include <condy.hpp>

#include <cstddef>

#include <cstdint>


namespace ublk {


struct IoData {

    uint16_t q_id;

    uint16_t tag;

    const ublksrv_io_desc *iod;

    void *buf;

};


template <typename T>


concept IoHandler = requires(T &t, const IoData &io_data) {

    { t.handle_io(io_data) } noexcept -> detail::ex::sender;

};


template <typename T>


concept QueueHandler = requires(T &t, uint16_t q_id) {

    { t.init_queue(q_id) } noexcept -> detail::ex::sender;

    { t.destroy_queue(q_id) } noexcept -> std::same_as<void>;

};


template <typename T>


concept ShmHandler = requires(T &t, int32_t index, void *base, size_t size) {

    { t.handle_reg_shm(index, base, size) } noexcept -> detail::ex::sender;

    { t.handle_unreg_shm(index) } noexcept -> std::same_as<void>;

};


} // namespace ublk

ublk::IoHandler
Concept of an async handler with handle_io(const IoData&).
Definition handler.hpp:33

ublk::QueueHandler
Concept of a handler with per-queue init/destroy callbacks.
Definition handler.hpp:39

ublk::ShmHandler
Concept of a handler notified of shared memory buffer registration.
Definition handler.hpp:47

execution.hpp
The std::execution backend namespace used by ublk-cpp.

ublk
The main namespace of the ublk-cpp library.
Definition ublk.hpp:21

ublk::IoData
Context of a single I/O request delivered to a handler.
Definition handler.hpp:20

ublk::IoData::tag
uint16_t tag
Tag of the request.
Definition handler.hpp:24

ublk::IoData::buf
void * buf
Buffer for the request data.
Definition handler.hpp:28

ublk::IoData::iod
const ublksrv_io_desc * iod
I/O descriptor of the request in shared memory.
Definition handler.hpp:26

ublk::IoData::q_id
uint16_t q_id
Queue ID of the request.
Definition handler.hpp:22