
The current ProtocolServer was really only used for requests, and with the recent introduction of the WebSocket service, long-lasting connections with another server are not part of it. To better reflect this, this commit renames it to RequestServer. This commit also changes the existing 'protocol' portal to 'request', the existing 'protocol' user and group to 'request', and most mentions of the 'download' aspect of the request to 'request' when relevant, to make everything consistent across the system. Note that LibProtocol still exists as-is, but the more generic Client class and the more specific Download class have both been renamed to a more accurate RequestClient and Request to match the new names. This commit only change names, not behaviors.
61 lines
1.9 KiB
C++
61 lines
1.9 KiB
C++
/*
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/FileStream.h>
|
|
#include <AK/HashMap.h>
|
|
#include <AK/NonnullOwnPtr.h>
|
|
#include <AK/Optional.h>
|
|
#include <AK/RefCounted.h>
|
|
#include <AK/URL.h>
|
|
#include <RequestServer/Forward.h>
|
|
|
|
namespace RequestServer {
|
|
|
|
class Request {
|
|
public:
|
|
virtual ~Request();
|
|
|
|
i32 id() const { return m_id; }
|
|
URL url() const { return m_url; }
|
|
|
|
Optional<u32> status_code() const { return m_status_code; }
|
|
Optional<u32> total_size() const { return m_total_size; }
|
|
size_t downloaded_size() const { return m_downloaded_size; }
|
|
const HashMap<String, String, CaseInsensitiveStringTraits>& response_headers() const { return m_response_headers; }
|
|
|
|
void stop();
|
|
virtual void set_certificate(String, String);
|
|
|
|
// FIXME: Want Badge<Protocol>, but can't make one from HttpProtocol, etc.
|
|
void set_request_fd(int fd) { m_request_fd = fd; }
|
|
int request_fd() const { return m_request_fd; }
|
|
|
|
void did_finish(bool success);
|
|
void did_progress(Optional<u32> total_size, u32 downloaded_size);
|
|
void set_status_code(u32 status_code) { m_status_code = status_code; }
|
|
void did_request_certificates();
|
|
void set_response_headers(const HashMap<String, String, CaseInsensitiveStringTraits>&);
|
|
void set_downloaded_size(size_t size) { m_downloaded_size = size; }
|
|
const OutputFileStream& output_stream() const { return *m_output_stream; }
|
|
|
|
protected:
|
|
explicit Request(ClientConnection&, NonnullOwnPtr<OutputFileStream>&&);
|
|
|
|
private:
|
|
ClientConnection& m_client;
|
|
i32 m_id { 0 };
|
|
int m_request_fd { -1 }; // Passed to client.
|
|
URL m_url;
|
|
Optional<u32> m_status_code;
|
|
Optional<u32> m_total_size {};
|
|
size_t m_downloaded_size { 0 };
|
|
NonnullOwnPtr<OutputFileStream> m_output_stream;
|
|
HashMap<String, String, CaseInsensitiveStringTraits> m_response_headers;
|
|
};
|
|
|
|
}
|