Skip to content

Commit

Permalink
file: document max_length-limits for dma_read/write funcs taking vect…
Browse files Browse the repository at this point in the history
…or<iovec>
  • Loading branch information
Niek Bouman committed Feb 25, 2025
1 parent ac47a21 commit 7ec5a5b
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions include/seastar/core/file.hh
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,9 @@ public:
///
/// \return a future representing the number of bytes actually read. A short
/// read may happen due to end-of-file or an I/O error.
///
/// Note that for this overload, \ref disk_read_max_length corresponds to the sum of
/// the iovec sizes.
future<size_t> dma_read(uint64_t pos, std::vector<iovec> iov, io_intent* intent = nullptr) noexcept {
return dma_read_impl(pos, std::move(iov), internal::maybe_priority_class_ref(), intent);
}
Expand Down Expand Up @@ -368,6 +371,9 @@ public:
///
/// \return a future representing the number of bytes actually written. A short
/// write may happen due to an I/O error.
///
/// Note that for this overload, \ref disk_write_max_length corresponds to the sum of
/// the iovec sizes.
future<size_t> dma_write(uint64_t pos, std::vector<iovec> iov, io_intent* intent = nullptr) noexcept {
return dma_write_impl(pos, std::move(iov), internal::maybe_priority_class_ref(), intent);
}
Expand Down

0 comments on commit 7ec5a5b

Please sign in to comment.