140 lines
16 KiB
HTML
140 lines
16 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>read_at</title>
|
|
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
|
<link rel="home" href="../../index.html" title="Asio">
|
|
<link rel="up" href="../reference.html" title="Reference">
|
|
<link rel="prev" href="read/overload16.html" title="read (16 of 16 overloads)">
|
|
<link rel="next" href="read_at/overload1.html" title="read_at (1 of 8 overloads)">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="read/overload16.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="read_at/overload1.html"><img src="../../next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h3 class="title">
|
|
<a name="asio.reference.read_at"></a><a class="link" href="read_at.html" title="read_at">read_at</a>
|
|
</h3></div></div></div>
|
|
<p>
|
|
<a class="indexterm" name="asio.indexterm.read_at"></a>
|
|
</p>
|
|
<p>
|
|
The <code class="computeroutput"><span class="identifier">read_at</span></code> function is a
|
|
composed operation that reads a certain amount of data at the specified offset
|
|
before returning.
|
|
</p>
|
|
<p>
|
|
Attempt to read a certain amount of data at the specified offset before returning.
|
|
</p>
|
|
<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
|
|
<span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
|
|
<span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">></span>
|
|
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload1.html" title="read_at (1 of 8 overloads)">read_at</a><span class="special">(</span>
|
|
<span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&</span> <span class="identifier">d</span><span class="special">,</span>
|
|
<span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
|
|
<span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">);</span>
|
|
<span class="emphasis"><em>» <a class="link" href="read_at/overload1.html" title="read_at (1 of 8 overloads)">more...</a></em></span>
|
|
|
|
<span class="keyword">template</span><span class="special"><</span>
|
|
<span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
|
|
<span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">></span>
|
|
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload2.html" title="read_at (2 of 8 overloads)">read_at</a><span class="special">(</span>
|
|
<span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&</span> <span class="identifier">d</span><span class="special">,</span>
|
|
<span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
|
|
<span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span>
|
|
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span>
|
|
<span class="emphasis"><em>» <a class="link" href="read_at/overload2.html" title="read_at (2 of 8 overloads)">more...</a></em></span>
|
|
|
|
<span class="keyword">template</span><span class="special"><</span>
|
|
<span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
|
|
<span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">,</span>
|
|
<span class="keyword">typename</span> <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a><span class="special">></span>
|
|
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload3.html" title="read_at (3 of 8 overloads)">read_at</a><span class="special">(</span>
|
|
<span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&</span> <span class="identifier">d</span><span class="special">,</span>
|
|
<span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
|
|
<span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span>
|
|
<span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">);</span>
|
|
<span class="emphasis"><em>» <a class="link" href="read_at/overload3.html" title="read_at (3 of 8 overloads)">more...</a></em></span>
|
|
|
|
<span class="keyword">template</span><span class="special"><</span>
|
|
<span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
|
|
<span class="keyword">typename</span> <a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a><span class="special">,</span>
|
|
<span class="keyword">typename</span> <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a><span class="special">></span>
|
|
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload4.html" title="read_at (4 of 8 overloads)">read_at</a><span class="special">(</span>
|
|
<span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&</span> <span class="identifier">d</span><span class="special">,</span>
|
|
<span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
|
|
<span class="keyword">const</span> <span class="identifier">MutableBufferSequence</span> <span class="special">&</span> <span class="identifier">buffers</span><span class="special">,</span>
|
|
<span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">,</span>
|
|
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span>
|
|
<span class="emphasis"><em>» <a class="link" href="read_at/overload4.html" title="read_at (4 of 8 overloads)">more...</a></em></span>
|
|
|
|
<span class="keyword">template</span><span class="special"><</span>
|
|
<span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
|
|
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">></span>
|
|
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload5.html" title="read_at (5 of 8 overloads)">read_at</a><span class="special">(</span>
|
|
<span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&</span> <span class="identifier">d</span><span class="special">,</span>
|
|
<span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
|
|
<span class="identifier">basic_streambuf</span><span class="special"><</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="special">&</span> <span class="identifier">b</span><span class="special">);</span>
|
|
<span class="emphasis"><em>» <a class="link" href="read_at/overload5.html" title="read_at (5 of 8 overloads)">more...</a></em></span>
|
|
|
|
<span class="keyword">template</span><span class="special"><</span>
|
|
<span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
|
|
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">></span>
|
|
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload6.html" title="read_at (6 of 8 overloads)">read_at</a><span class="special">(</span>
|
|
<span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&</span> <span class="identifier">d</span><span class="special">,</span>
|
|
<span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
|
|
<span class="identifier">basic_streambuf</span><span class="special"><</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="special">&</span> <span class="identifier">b</span><span class="special">,</span>
|
|
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span>
|
|
<span class="emphasis"><em>» <a class="link" href="read_at/overload6.html" title="read_at (6 of 8 overloads)">more...</a></em></span>
|
|
|
|
<span class="keyword">template</span><span class="special"><</span>
|
|
<span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
|
|
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
|
|
<span class="keyword">typename</span> <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a><span class="special">></span>
|
|
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload7.html" title="read_at (7 of 8 overloads)">read_at</a><span class="special">(</span>
|
|
<span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&</span> <span class="identifier">d</span><span class="special">,</span>
|
|
<span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
|
|
<span class="identifier">basic_streambuf</span><span class="special"><</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="special">&</span> <span class="identifier">b</span><span class="special">,</span>
|
|
<span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">);</span>
|
|
<span class="emphasis"><em>» <a class="link" href="read_at/overload7.html" title="read_at (7 of 8 overloads)">more...</a></em></span>
|
|
|
|
<span class="keyword">template</span><span class="special"><</span>
|
|
<span class="keyword">typename</span> <a class="link" href="SyncRandomAccessReadDevice.html" title="Buffer-oriented synchronous random-access read device requirements">SyncRandomAccessReadDevice</a><span class="special">,</span>
|
|
<span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
|
|
<span class="keyword">typename</span> <a class="link" href="CompletionCondition.html" title="Completion condition requirements">CompletionCondition</a><span class="special">></span>
|
|
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="read_at/overload8.html" title="read_at (8 of 8 overloads)">read_at</a><span class="special">(</span>
|
|
<span class="identifier">SyncRandomAccessReadDevice</span> <span class="special">&</span> <span class="identifier">d</span><span class="special">,</span>
|
|
<span class="identifier">uint64_t</span> <span class="identifier">offset</span><span class="special">,</span>
|
|
<span class="identifier">basic_streambuf</span><span class="special"><</span> <span class="identifier">Allocator</span> <span class="special">></span> <span class="special">&</span> <span class="identifier">b</span><span class="special">,</span>
|
|
<span class="identifier">CompletionCondition</span> <span class="identifier">completion_condition</span><span class="special">,</span>
|
|
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span>
|
|
<span class="emphasis"><em>» <a class="link" href="read_at/overload8.html" title="read_at (8 of 8 overloads)">more...</a></em></span>
|
|
</pre>
|
|
<h5>
|
|
<a name="asio.reference.read_at.h0"></a>
|
|
<span><a name="asio.reference.read_at.requirements"></a></span><a class="link" href="read_at.html#asio.reference.read_at.requirements">Requirements</a>
|
|
</h5>
|
|
<p>
|
|
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/read_at.hpp</code>
|
|
</p>
|
|
<p>
|
|
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
|
|
</p>
|
|
</div>
|
|
<div class="copyright-footer">Copyright © 2003-2023 Christopher M. Kohlhoff<p>
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="read/overload16.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="read_at/overload1.html"><img src="../../next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|