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 "http_client.hpp" 21 #include "http_response.hpp" 22 #include "metric_report.hpp" 23 #include "server_sent_event.hpp" 24 25 #include <boost/asio/io_context.hpp> 26 #include <boost/asio/steady_timer.hpp> 27 #include <boost/url/url_view_base.hpp> 28 29 #include <cstdint> 30 #include <functional> 31 #include <memory> 32 #include <optional> 33 #include <string> 34 #include <vector> 35 36 namespace redfish 37 { 38 39 static constexpr const char* subscriptionTypeSSE = "SSE"; 40 41 static constexpr const uint8_t maxNoOfSubscriptions = 20; 42 static constexpr const uint8_t maxNoOfSSESubscriptions = 10; 43 struct TestEvent 44 { 45 std::optional<int64_t> eventGroupId; 46 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; 53 }; 54 55 class 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 72 void resHandler(const crow::Response& res); 73 74 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 80 bool sendEventToSubscriber(uint64_t eventId, std::string&& msg); 81 82 void filterAndSendEventLogs( 83 uint64_t eventId, const std::vector<EventLogObjectsType>& eventRecords); 84 85 void filterAndSendReports(uint64_t eventId, const std::string& reportId, 86 const telemetry::TimestampReadings& var); 87 88 void updateRetryConfig(uint32_t retryAttempts, 89 uint32_t retryTimeoutInterval); 90 91 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: 101 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; 106 boost::asio::steady_timer hbTimer; 107 108 public: 109 std::optional<filter_ast::LogicalAnd> filter; 110 }; 111 112 } // namespace redfish 113