ladybird/Userland/Libraries/LibCore/SOCKSProxyClient.h
Sam Atkins 3b1e063d30 LibCore+Everywhere: Make Core::Stream::read() return Bytes
A mistake I've repeatedly made is along these lines:
```c++
auto nread = TRY(source_file->read(buffer));
TRY(destination_file->write(buffer));
```

It's a little clunky to have to create a Bytes or StringView from the
buffer's data pointer and the nread, and easy to forget and just use
the buffer. So, this patch changes the read() function to return a
Bytes of the data that were just read.

The other read_foo() methods will be modified in the same way in
subsequent commits.

Fixes #13687
2022-04-16 13:27:51 -04:00

64 lines
2.4 KiB
C++

/*
* Copyright (c) 2022, Ali Mohammad Pur <mpfard@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/OwnPtr.h>
#include <LibCore/Proxy.h>
#include <LibCore/Stream.h>
namespace Core {
class SOCKSProxyClient final : public Stream::Socket {
public:
enum class Version : u8 {
V4 = 0x04,
V5 = 0x05,
};
struct UsernamePasswordAuthenticationData {
String username;
String password;
};
enum class Command : u8 {
Connect = 0x01,
Bind = 0x02,
UDPAssociate = 0x03,
};
using HostOrIPV4 = Variant<String, u32>;
static ErrorOr<NonnullOwnPtr<SOCKSProxyClient>> connect(Socket& underlying, Version, HostOrIPV4 const& target, int target_port, Variant<UsernamePasswordAuthenticationData, Empty> const& auth_data = {}, Command = Command::Connect);
static ErrorOr<NonnullOwnPtr<SOCKSProxyClient>> connect(HostOrIPV4 const& server, int server_port, Version, HostOrIPV4 const& target, int target_port, Variant<UsernamePasswordAuthenticationData, Empty> const& auth_data = {}, Command = Command::Connect);
virtual ~SOCKSProxyClient() override;
// ^Stream::Stream
virtual ErrorOr<Bytes> read(Bytes bytes) override { return m_socket.read(bytes); }
virtual ErrorOr<size_t> write(ReadonlyBytes bytes) override { return m_socket.write(bytes); }
virtual bool is_eof() const override { return m_socket.is_eof(); }
virtual bool is_open() const override { return m_socket.is_open(); }
virtual void close() override { m_socket.close(); }
// ^Stream::Socket
virtual ErrorOr<size_t> pending_bytes() const override { return m_socket.pending_bytes(); }
virtual ErrorOr<bool> can_read_without_blocking(int timeout = 0) const override { return m_socket.can_read_without_blocking(timeout); }
virtual ErrorOr<void> set_blocking(bool enabled) override { return m_socket.set_blocking(enabled); }
virtual ErrorOr<void> set_close_on_exec(bool enabled) override { return m_socket.set_close_on_exec(enabled); }
virtual void set_notifications_enabled(bool enabled) override { m_socket.set_notifications_enabled(enabled); }
private:
SOCKSProxyClient(Socket& socket, OwnPtr<Socket> own_socket)
: m_socket(socket)
, m_own_underlying_socket(move(own_socket))
{
m_socket.on_ready_to_read = [this] { on_ready_to_read(); };
}
Socket& m_socket;
OwnPtr<Socket> m_own_underlying_socket;
};
}