Line data Source code
1 : /*
2 : ___________________________________________
3 : | _ ___ _ |
4 : | | | |__ \ | | |
5 : | | |__ ) |__ _ __ _ ___ _ __ | |_ |
6 : | | '_ \ / // _` |/ _` |/ _ \ '_ \| __| | HTTP/2 AGENT FOR MOCK TESTING
7 : | | | | |/ /| (_| | (_| | __/ | | | |_ | Version 0.0.z
8 : | |_| |_|____\__,_|\__, |\___|_| |_|\__| | https://github.com/testillano/h2agent
9 : | __/ | |
10 : | |___/ |
11 : |___________________________________________|
12 :
13 : Licensed under the MIT License <http://opensource.org/licenses/MIT>.
14 : SPDX-License-Identifier: MIT
15 : Copyright (c) 2021 Eduardo Ramos
16 :
17 : Permission is hereby granted, free of charge, to any person obtaining a copy
18 : of this software and associated documentation files (the "Software"), to deal
19 : in the Software without restriction, including without limitation the rights
20 : to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
21 : copies of the Software, and to permit persons to whom the Software is
22 : furnished to do so, subject to the following conditions:
23 :
24 : The above copyright notice and this permission notice shall be included in all
25 : copies or substantial portions of the Software.
26 :
27 : THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28 : IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
29 : FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
30 : AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
31 : LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
32 : OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 : SOFTWARE.
34 : */
35 :
36 : #pragma once
37 :
38 : #include <nlohmann/json.hpp>
39 :
40 : #include <ert/metrics/Metrics.hpp>
41 :
42 : #include <Map.hpp>
43 : #include <SafeSocket.hpp>
44 :
45 :
46 : namespace ert
47 : {
48 : namespace metrics
49 : {
50 : class Metrics;
51 : }
52 : }
53 :
54 : namespace h2agent
55 : {
56 : namespace model
57 : {
58 :
59 : /**
60 : * This class stores a list of safe files.
61 : */
62 : class SocketManager : public Map<std::string, std::shared_ptr<SafeSocket>>
63 : {
64 : mutable mutex_t rw_mutex_{};
65 : boost::asio::io_context *io_context_{};
66 :
67 : // metrics (will be passed to SafeSocket):
68 : ert::metrics::Metrics *metrics_{};
69 :
70 : ert::metrics::counter_t *observed_open_operation_counter_{};
71 : ert::metrics::counter_t *observed_write_operation_counter_{};
72 : ert::metrics::counter_t *observed_delayed_write_operation_counter_{};
73 : ert::metrics::counter_t *observed_instant_write_operation_counter_{};
74 : ert::metrics::counter_t *observed_error_open_operation_counter_{};
75 :
76 : public:
77 : /**
78 : * Socket manager class
79 : *
80 : * @param timersIoContext timers io context needed to schedule delayed write operations.
81 : * If you never schedule write operations (@see write) it may be 'nullptr'.
82 : * @param metrics underlaying reference for SafeSocket in order to compute prometheus metrics
83 : * about I/O operations. It may be 'nullptr' if no metrics are enabled.
84 : *
85 : * @see SafeSocket
86 : */
87 160 : SocketManager(boost::asio::io_context *timersIoContext = nullptr, ert::metrics::Metrics *metrics = nullptr) : io_context_(timersIoContext), metrics_(metrics) {;}
88 158 : ~SocketManager() = default;
89 :
90 : /**
91 : * Set metrics reference
92 : *
93 : * @param metrics Optional metrics object to compute counters
94 : * @param source Source label for prometheus metrics
95 : */
96 : void enableMetrics(ert::metrics::Metrics *metrics, const std::string &source);
97 :
98 :
99 : /** incrementObservedOpenOperationCounter */
100 : void incrementObservedOpenOperationCounter();
101 :
102 : /** incrementObservedWriteOperationCounter */
103 : void incrementObservedWriteOperationCounter();
104 :
105 : /** incrementObservedDelayedWriteOperationCounter */
106 : void incrementObservedDelayedWriteOperationCounter();
107 :
108 : /** incrementObservedInstantWriteOperationCounter */
109 : void incrementObservedInstantWriteOperationCounter();
110 :
111 : /** incrementObservedErrorOpenOperationCounter */
112 : void incrementObservedErrorOpenOperationCounter();
113 :
114 : /**
115 : * Write socket
116 : *
117 : * @param path path file to write. Can be relative (to execution directory) or absolute.
118 : * @param data data string to write.
119 : * @param writeDelayUs delay for write operation.
120 : * Zero value means that no planned write is scheduled, so the socket is written instantly.
121 : */
122 : void write(const std::string &path, const std::string &data, unsigned int writeDelayUs);
123 :
124 : /** Clears list
125 : *
126 : * @return Boolean about success of operation (something removed, nothing removed: already empty)
127 : */
128 : bool clear();
129 :
130 : /**
131 : * Builds json document for class configuration
132 : *
133 : * @return Json object
134 : */
135 : nlohmann::json getConfigurationJson() const;
136 :
137 : /**
138 : * Builds json document for class information
139 : *
140 : * @return Json object
141 : */
142 : nlohmann::json getJson() const;
143 :
144 : /**
145 : * Json string representation for class information (json object)
146 : *
147 : * @return Json string representation ('[]' for empty object).
148 : */
149 : std::string asJsonString() const;
150 : };
151 :
152 : }
153 : }
154 :
|
