jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/Function.h>
30#include <LibCore/Object.h>
31
32namespace Core {
33
34class NetworkJob : public Object {
35 C_OBJECT_ABSTRACT(NetworkJob)
36public:
37 enum class Error {
38 None,
39 ConnectionFailed,
40 TransmissionFailed,
41 ProtocolFailed,
42 Cancelled,
43 };
44 virtual ~NetworkJob() override;
45
46 Function<void(bool success)> on_finish;
47
48 bool is_cancelled() const { return m_error == Error::Cancelled; }
49 bool has_error() const { return m_error != Error::None; }
50 Error error() const { return m_error; }
51 NetworkResponse* response() { return m_response.ptr(); }
52 const NetworkResponse* response() const { return m_response.ptr(); }
53
54 virtual void start() = 0;
55 virtual void shutdown() = 0;
56
57 void cancel()
58 {
59 shutdown();
60 m_error = Error::Cancelled;
61 }
62
63protected:
64 NetworkJob();
65 void did_finish(NonnullRefPtr<NetworkResponse>&&);
66 void did_fail(Error);
67
68private:
69 RefPtr<NetworkResponse> m_response;
70 Error m_error { Error::None };
71};
72
73const char* to_string(NetworkJob::Error);
74
75}