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 sockets (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 <sys/socket.h>
39 : #include <sys/un.h>
40 : #include <unistd.h>
41 :
42 : #include <string>
43 :
44 : #include <boost/asio.hpp>
45 : #include <boost/thread.hpp>
46 : #include <nlohmann/json.hpp>
47 :
48 :
49 : namespace h2agent
50 : {
51 : namespace model
52 : {
53 : class SocketManager;
54 :
55 : /**
56 : * This class allows safe writting of udp sockets.
57 : * Write procedure could be planned with a certain delay
58 : */
59 : class SafeSocket {
60 :
61 : std::string path_;
62 : int socket_;
63 : struct sockaddr_un server_addr_;
64 :
65 : boost::asio::io_context *io_context_{};
66 :
67 : SocketManager *socket_manager_{};
68 :
69 : void delayedWrite(unsigned int writeDelayUs, const std::string &data);
70 :
71 : public:
72 :
73 : /**
74 : * Constructor
75 : *
76 : * @param socketManager parent reference to socket manager.
77 : * @param path socket path to write. It could be relative (to execution path) or absolute.
78 : * @param timersIoContext asio io context which will be used to delay write operations.
79 : * By default it is not used (if not provided in constructor), so delay is not performed
80 : * regardless the write delay configured.
81 : */
82 : SafeSocket (SocketManager *socketManager,
83 : const std::string& path,
84 : boost::asio::io_context *timersIoContext = nullptr);
85 :
86 5 : ~SafeSocket() {;}
87 :
88 : /**
89 : * Open the socket for writting
90 : *
91 : * @return Boolean about success operation.
92 : */
93 : bool open();
94 :
95 : /**
96 : * Json representation of the class instance
97 : */
98 : nlohmann::json getJson() const;
99 :
100 : /**
101 : * Write data to the socket.
102 : * Write could be delayed.
103 : *
104 : * @param data data to write
105 : * @param writeDelayUs delay for write operation. By default no delay is configured.
106 : * @param fromDelayed called from delayed write (used to omit instant write count). False by default.
107 : */
108 : void write(const std::string& data, unsigned int writeDelayUs = 0, bool fromDelayed = false);
109 : };
110 :
111 : }
112 : }
113 :
|
