1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*
* Author: Sven Gothel <sgothel@jausoft.com>
* Copyright (c) 2021 Gothel Software e.K.
* Copyright (c) 2021 ZAFENA AB
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef JAU_IO_UTIL_HPP_
#define JAU_IO_UTIL_HPP_
#include <string>
#include <cstdint>
#include <functional>
#include <thread>
#include <vector>
#include <jau/basic_types.hpp>
#include <jau/ringbuffer.hpp>
// Include Botan header files before this one to be integrated w/ Botan!
// #include <botan_all.h>
#include <jau/byte_stream.hpp>
namespace jau::io {
/**
* Stream consumer function
* - `bool consumer(secure_vector<uint8_t>& data, bool is_final)`
*
* Returns true to signal continuation, false to end streaming.
*/
typedef std::function<bool (secure_vector<uint8_t>& /* data */, bool /* is_final */)> StreamConsumerFunc;
/**
*
* @param input_file
* @param exp_size if > 0 it is additionally used to determine EOF, otherwise the underlying EOF mechanism is being used only.
* @param buf_size
* @param consumer_fn
* @return total bytes read or 0 if error
*/
uint64_t read_file(const std::string& input_file, const uint64_t exp_size,
secure_vector<uint8_t>& buffer,
StreamConsumerFunc consumer_fn);
/**
* @param in
* @param exp_size if > 0 it is additionally used to determine EOF, otherwise the underlying EOF mechanism is being used only.
* @param buf_size
* @param consumer_fn
* @return total bytes read
*/
uint64_t read_stream(ByteStream& in, const uint64_t exp_size,
secure_vector<uint8_t>& buffer,
StreamConsumerFunc consumer_fn);
/**
*
* @param url
* @param exp_size if > 0 it is additionally used to determine EOF, otherwise the underlying EOF mechanism is being used only.
* @param buffer
* @param consumer_fn
* @return total bytes read or 0 if error
*/
uint64_t read_url_stream(const std::string& url, const uint64_t exp_size,
secure_vector<uint8_t>& buffer,
StreamConsumerFunc consumer_fn);
/**
* Asynchronous URL read content using a byte jau::ringbuffer,
* allowing parallel reading.
*
* @param url the URL of the content to read
* @param exp_size if > 0 it is additionally used to determine EOF, otherwise the underlying EOF mechanism is being used only.
* @param buffer the ringbuffer destination to write into
* @param has_content_length indicating whether content_length is known from server
* @param content_length tracking the content_length
* @param total_read tracking the total_read
* @param result tracking the result_t
* @return the url background reading thread
*/
std::thread read_url_stream(const std::string& url, const uint64_t& exp_size,
ByteRingbuffer& buffer,
jau::relaxed_atomic_bool& has_content_length,
jau::relaxed_atomic_uint64& content_length,
jau::relaxed_atomic_uint64& total_read,
relaxed_atomic_result_t& result) noexcept;
void print_stats(const std::string& prefix, const uint64_t& out_bytes_total, const jau::fraction_i64& td) noexcept;
} // namespace elevator::io
#endif /* JAU_IO_UTIL_HPP_ */
|
