Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

file: document length-limits for dma_read/write funcs taking vector<iovec> #2663

Closed
wants to merge 1 commit into from
Closed

file: document length-limits for dma_read/write funcs taking vector<iovec> #2663

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions include/seastar/core/file.hh
View file
Open in desktop
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