C++ Essence Library 0.1.0
A Utility Library for Modern C++ Programming
Loading...
Searching...
No Matches
sse_client.hpp
1/*
2 * Copyright (c) 2024 The RefValue Project
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 * THE SOFTWARE.
21 */
22
23#pragma once
24
25#include "../compat.hpp"
26#include "common_types.hpp"
27#include "http_client_config.hpp"
28#include "sse_message.hpp"
29#include "uri.hpp"
30
31#include <memory>
32
33namespace essence::net {
38 class sse_client {
39 public:
40 ES_API(CPPESSENCE) explicit sse_client(const uri& base_uri);
41 ES_API(CPPESSENCE) sse_client(const uri& base_uri, const http_client_config& config);
42 ES_API(CPPESSENCE) sse_client(sse_client&&) noexcept;
43 ES_API(CPPESSENCE) ~sse_client();
44 ES_API(CPPESSENCE) sse_client& operator=(sse_client&&) noexcept;
45
50 ES_API(CPPESSENCE) void connect(const uri& relative_uri) const;
51
55 ES_API(CPPESSENCE) void close() const;
56
61 ES_API(CPPESSENCE) void on_message(const sse_message_handler& handler) const;
62
67 ES_API(CPPESSENCE) void on_error(const error_handler& handler) const;
68
69 private:
70 class impl;
71
72 std::unique_ptr<impl> impl_;
73 };
74} // namespace essence::net
An http client operating on Server-Sent Events.
Definition sse_client.hpp:38
ES_API(CPPESSENCE) void connect(const uri &relative_uri) const
Connects to the SSE service and starts consuming messages.
ES_API(CPPESSENCE) void on_message(const sse_message_handler &handler) const
Registers a message callback.
ES_API(CPPESSENCE) void on_error(const error_handler &handler) const
Registers a error callback.
ES_API(CPPESSENCE) void close() const
Closes the connection.
Definition uri.hpp:37
Definition http_client_config.hpp:37