blob: 704d07abbbb459b7755a162381bf9129ef76f324 [file] [log] [blame]
Alexander Hansen02c1e292024-11-15 14:30:40 +01001/*
2Copyright (c) 2020 Intel Corporation
3
4Licensed under the Apache License, Version 2.0 (the "License");
5you may not use this file except in compliance with the License.
6You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10Unless required by applicable law or agreed to in writing, software
11distributed under the License is distributed on an "AS IS" BASIS,
12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13See the License for the specific language governing permissions and
14limitations under the License.
15*/
16#pragma once
17#include "event_logs_object_type.hpp"
18#include "event_service_store.hpp"
19#include "filter_expr_parser_ast.hpp"
Ed Tanousd7857202025-01-28 15:32:26 -080020#include "http_client.hpp"
21#include "http_response.hpp"
Alexander Hansen02c1e292024-11-15 14:30:40 +010022#include "metric_report.hpp"
23#include "server_sent_event.hpp"
24
25#include <boost/asio/io_context.hpp>
Ed Tanousd7857202025-01-28 15:32:26 -080026#include <boost/asio/steady_timer.hpp>
Alexander Hansen02c1e292024-11-15 14:30:40 +010027#include <boost/url/url_view_base.hpp>
28
Ed Tanousd7857202025-01-28 15:32:26 -080029#include <cstdint>
30#include <functional>
Alexander Hansen02c1e292024-11-15 14:30:40 +010031#include <memory>
Ed Tanousd7857202025-01-28 15:32:26 -080032#include <optional>
Alexander Hansen02c1e292024-11-15 14:30:40 +010033#include <string>
Ed Tanousd7857202025-01-28 15:32:26 -080034#include <vector>
Alexander Hansen02c1e292024-11-15 14:30:40 +010035
36namespace redfish
37{
38
39static constexpr const char* subscriptionTypeSSE = "SSE";
40
41static constexpr const uint8_t maxNoOfSubscriptions = 20;
42static constexpr const uint8_t maxNoOfSSESubscriptions = 10;
Chandramohan Harkude81ee0e72024-12-20 19:22:12 +053043struct TestEvent
44{
45 std::optional<int64_t> eventGroupId;
Chandramohan Harkude81ee0e72024-12-20 19:22:12 +053046 std::optional<std::string> eventTimestamp;
47 std::optional<std::string> message;
48 std::optional<std::vector<std::string>> messageArgs;
49 std::optional<std::string> messageId;
50 std::optional<std::string> originOfCondition;
51 std::optional<std::string> resolution;
52 std::optional<std::string> severity;
Chandramohan Harkude81ee0e72024-12-20 19:22:12 +053053};
Alexander Hansen02c1e292024-11-15 14:30:40 +010054
55class Subscription : public std::enable_shared_from_this<Subscription>
56{
57 public:
58 Subscription(const Subscription&) = delete;
59 Subscription& operator=(const Subscription&) = delete;
60 Subscription(Subscription&&) = delete;
61 Subscription& operator=(Subscription&&) = delete;
62
63 Subscription(std::shared_ptr<persistent_data::UserSubscription> userSubIn,
64 const boost::urls::url_view_base& url,
65 boost::asio::io_context& ioc);
66
67 explicit Subscription(crow::sse_socket::Connection& connIn);
68
69 ~Subscription() = default;
70
71 // callback for subscription sendData
Alexander Hansenf2656d12025-01-13 15:14:29 +010072 void resHandler(const crow::Response& res);
Alexander Hansen02c1e292024-11-15 14:30:40 +010073
Myung Baefb546102024-10-29 10:21:26 -050074 void sendHeartbeatEvent();
75 void scheduleNextHeartbeatEvent();
76 void heartbeatParametersChanged();
77 void onHbTimeout(const std::weak_ptr<Subscription>& weakSelf,
78 const boost::system::error_code& ec);
79
Ed Tanous4a19a7b2025-01-27 10:44:15 -080080 bool sendEventToSubscriber(uint64_t eventId, std::string&& msg);
Alexander Hansen02c1e292024-11-15 14:30:40 +010081
82 void filterAndSendEventLogs(
Ed Tanous4a19a7b2025-01-27 10:44:15 -080083 uint64_t eventId, const std::vector<EventLogObjectsType>& eventRecords);
Alexander Hansen02c1e292024-11-15 14:30:40 +010084
Ed Tanous4a19a7b2025-01-27 10:44:15 -080085 void filterAndSendReports(uint64_t eventId, const std::string& reportId,
Alexander Hansen02c1e292024-11-15 14:30:40 +010086 const telemetry::TimestampReadings& var);
87
88 void updateRetryConfig(uint32_t retryAttempts,
89 uint32_t retryTimeoutInterval);
90
Alexander Hansen02c1e292024-11-15 14:30:40 +010091 bool matchSseId(const crow::sse_socket::Connection& thisConn);
92
93 // Check used to indicate what response codes are valid as part of our retry
94 // policy. 2XX is considered acceptable
95 static boost::system::error_code retryRespHandler(unsigned int respCode);
96
97 std::shared_ptr<persistent_data::UserSubscription> userSub;
98 std::function<void()> deleter;
99
100 private:
Alexander Hansen02c1e292024-11-15 14:30:40 +0100101 boost::urls::url host;
102 std::shared_ptr<crow::ConnectionPolicy> policy;
103 crow::sse_socket::Connection* sseConn = nullptr;
104
105 std::optional<crow::HttpClient> client;
Myung Baefb546102024-10-29 10:21:26 -0500106 boost::asio::steady_timer hbTimer;
Alexander Hansen02c1e292024-11-15 14:30:40 +0100107
108 public:
109 std::optional<filter_ast::LogicalAnd> filter;
110};
111
112} // namespace redfish