mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2024-11-22 07:30:19 +00:00
4a2da10e38
This patchset makes ProtocolServer stream the downloads to its client
(LibProtocol), and as such changes the download API; a possible
download lifecycle could be as such:
notation = client->server:'>', server->client:'<', pipe activity:'*'
```
> StartDownload(GET, url, headers, {})
< Response(0, fd 8)
* {data, 1024b}
< HeadersBecameAvailable(0, response_headers, 200)
< DownloadProgress(0, 4K, 1024)
* {data, 1024b}
* {data, 1024b}
< DownloadProgress(0, 4K, 2048)
* {data, 1024b}
< DownloadProgress(0, 4K, 1024)
< DownloadFinished(0, true, 4K)
```
Since managing the received file descriptor is a pain, LibProtocol
implements `Download::stream_into(OutputStream)`, which can be used to
stream the download into any given output stream (be it a file, or
memory, or writing stuff with a delay, etc.).
Also, as some of the users of this API require all the downloaded data
upfront, LibProtocol also implements `set_should_buffer_all_input()`,
which causes the download instance to buffer all the data until the
download is complete, and to call the `on_buffered_download_finish`
hook.
83 lines
2.9 KiB
C++
83 lines
2.9 KiB
C++
/*
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/Function.h>
|
|
#include <AK/Stream.h>
|
|
#include <LibCore/Object.h>
|
|
|
|
namespace Core {
|
|
|
|
class NetworkJob : public Object {
|
|
C_OBJECT_ABSTRACT(NetworkJob)
|
|
public:
|
|
enum class Error {
|
|
None,
|
|
ConnectionFailed,
|
|
TransmissionFailed,
|
|
ProtocolFailed,
|
|
Cancelled,
|
|
};
|
|
virtual ~NetworkJob() override;
|
|
|
|
// Could fire twice, after Headers and after Trailers!
|
|
Function<void(const HashMap<String, String, CaseInsensitiveStringTraits>& response_headers, Optional<u32> response_code)> on_headers_received;
|
|
Function<void(bool success)> on_finish;
|
|
Function<void(Optional<u32>, u32)> on_progress;
|
|
|
|
bool is_cancelled() const { return m_error == Error::Cancelled; }
|
|
bool has_error() const { return m_error != Error::None; }
|
|
Error error() const { return m_error; }
|
|
NetworkResponse* response() { return m_response.ptr(); }
|
|
const NetworkResponse* response() const { return m_response.ptr(); }
|
|
|
|
virtual void start() = 0;
|
|
virtual void shutdown() = 0;
|
|
|
|
void cancel()
|
|
{
|
|
shutdown();
|
|
m_error = Error::Cancelled;
|
|
}
|
|
|
|
protected:
|
|
NetworkJob(OutputStream&);
|
|
void did_finish(NonnullRefPtr<NetworkResponse>&&);
|
|
void did_fail(Error);
|
|
void did_progress(Optional<u32> total_size, u32 downloaded);
|
|
|
|
size_t do_write(ReadonlyBytes bytes) { return m_output_stream.write(bytes); }
|
|
|
|
private:
|
|
RefPtr<NetworkResponse> m_response;
|
|
OutputStream& m_output_stream;
|
|
Error m_error { Error::None };
|
|
};
|
|
|
|
const char* to_string(NetworkJob::Error);
|
|
|
|
}
|