1 /* 2 Copyright (c) 2020 Intel Corporation 3 4 Licensed under the Apache License, Version 2.0 (the "License"); 5 you may not use this file except in compliance with the License. 6 You may obtain a copy of the License at 7 8 http://www.apache.org/licenses/LICENSE-2.0 9 10 Unless required by applicable law or agreed to in writing, software 11 distributed under the License is distributed on an "AS IS" BASIS, 12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 See the License for the specific language governing permissions and 14 limitations 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" 20 #include "metric_report.hpp" 21 #include "server_sent_event.hpp" 22 23 #include <boost/asio/io_context.hpp> 24 #include <boost/url/url_view_base.hpp> 25 26 #include <memory> 27 #include <string> 28 29 namespace redfish 30 { 31 32 static constexpr const char* subscriptionTypeSSE = "SSE"; 33 34 static constexpr const uint8_t maxNoOfSubscriptions = 20; 35 static constexpr const uint8_t maxNoOfSSESubscriptions = 10; 36 struct TestEvent 37 { 38 std::optional<int64_t> eventGroupId; 39 std::optional<std::string> eventId; 40 std::optional<std::string> eventTimestamp; 41 std::optional<std::string> message; 42 std::optional<std::vector<std::string>> messageArgs; 43 std::optional<std::string> messageId; 44 std::optional<std::string> originOfCondition; 45 std::optional<std::string> resolution; 46 std::optional<std::string> severity; 47 // default constructor 48 TestEvent() = default; 49 // default assignment operator 50 TestEvent& operator=(const TestEvent&) = default; 51 // default copy constructor 52 TestEvent(const TestEvent&) = default; 53 // default move constructor 54 TestEvent(TestEvent&&) = default; 55 // default move assignment operator 56 TestEvent& operator=(TestEvent&&) = default; 57 // default destructor 58 ~TestEvent() = default; 59 }; 60 61 class Subscription : public std::enable_shared_from_this<Subscription> 62 { 63 public: 64 Subscription(const Subscription&) = delete; 65 Subscription& operator=(const Subscription&) = delete; 66 Subscription(Subscription&&) = delete; 67 Subscription& operator=(Subscription&&) = delete; 68 69 Subscription(std::shared_ptr<persistent_data::UserSubscription> userSubIn, 70 const boost::urls::url_view_base& url, 71 boost::asio::io_context& ioc); 72 73 explicit Subscription(crow::sse_socket::Connection& connIn); 74 75 ~Subscription() = default; 76 77 // callback for subscription sendData 78 void resHandler(const std::shared_ptr<Subscription>& /*unused*/, 79 const crow::Response& res); 80 81 void sendHeartbeatEvent(); 82 void scheduleNextHeartbeatEvent(); 83 void heartbeatParametersChanged(); 84 void onHbTimeout(const std::weak_ptr<Subscription>& weakSelf, 85 const boost::system::error_code& ec); 86 87 bool sendEventToSubscriber(std::string&& msg); 88 89 bool sendTestEventLog(TestEvent& testEvent); 90 91 void filterAndSendEventLogs( 92 const std::vector<EventLogObjectsType>& eventRecords); 93 94 void filterAndSendReports(const std::string& reportId, 95 const telemetry::TimestampReadings& var); 96 97 void updateRetryConfig(uint32_t retryAttempts, 98 uint32_t retryTimeoutInterval); 99 100 uint64_t getEventSeqNum() const; 101 102 bool matchSseId(const crow::sse_socket::Connection& thisConn); 103 104 // Check used to indicate what response codes are valid as part of our retry 105 // policy. 2XX is considered acceptable 106 static boost::system::error_code retryRespHandler(unsigned int respCode); 107 108 std::shared_ptr<persistent_data::UserSubscription> userSub; 109 std::function<void()> deleter; 110 111 private: 112 uint64_t eventSeqNum = 1; 113 boost::urls::url host; 114 std::shared_ptr<crow::ConnectionPolicy> policy; 115 crow::sse_socket::Connection* sseConn = nullptr; 116 117 std::optional<crow::HttpClient> client; 118 boost::asio::steady_timer hbTimer; 119 120 public: 121 std::optional<filter_ast::LogicalAnd> filter; 122 }; 123 124 } // namespace redfish 125