xrpld
Loading...
Searching...
No Matches
Overlay.h
1#pragma once
2
3#include <xrpld/overlay/Peer.h>
4
5#include <xrpl/basics/base_uint.h>
6#include <xrpl/beast/net/IPAddress.h>
7#include <xrpl/beast/net/IPEndpoint.h>
8#include <xrpl/beast/utility/PropertyStream.h>
9#include <xrpl/json/json_value.h>
10#include <xrpl/protocol/PublicKey.h>
11#include <xrpl/server/Handoff.h>
12
13#include <boost/asio/ip/tcp.hpp>
14#include <boost/asio/ssl/context.hpp>
15#include <boost/beast/core/tcp_stream.hpp>
16#include <boost/beast/ssl/ssl_stream.hpp>
17
18#include <xrpl.pb.h>
19
20#include <cstddef>
21#include <cstdint>
22#include <functional>
23#include <memory>
24#include <optional>
25#include <set>
26#include <vector>
27
28namespace boost::asio::ssl {
29class context;
30} // namespace boost::asio::ssl
31
32namespace xrpl {
33
34class STTx;
35
40{
41protected:
42 using SocketType = boost::beast::tcp_stream;
43 using StreamType = boost::beast::ssl_stream<SocketType>;
44
45 // VFALCO NOTE The requirement of this constructor is an
46 // unfortunate problem with the API for
47 // PropertyStream
48 Overlay() : beast::PropertyStream::Source("peers")
49 {
50 }
51
52public:
53 enum class Promote { Automatic, Never, Always };
54
67
69
70 ~Overlay() override = default;
71
72 virtual void
74 {
75 }
76
77 virtual void
79 {
80 }
81
85 virtual Handoff
88 HttpRequestType&& request,
89 boost::asio::ip::tcp::endpoint remoteAddress) = 0;
90
96 virtual void
97 connect(beast::ip::Endpoint const& address) = 0;
98
102 virtual int
103 limit() = 0;
104
110 [[nodiscard]] virtual std::size_t
111 size() const = 0;
112
117 virtual json::Value
118 json() = 0;
119
124 [[nodiscard]] virtual PeerSequence
125 getActivePeers() const = 0;
126
131 virtual void
133
137 [[nodiscard]] virtual std::shared_ptr<Peer>
138 findPeerByShortID(Peer::ID const& id) const = 0;
139
144 findPeerByPublicKey(PublicKey const& pubKey) = 0;
145
149 virtual void
150 broadcast(protocol::TMProposeSet const& m) = 0;
151
155 virtual void
156 broadcast(protocol::TMValidation const& m) = 0;
157
165 virtual std::set<Peer::ID>
166 relay(protocol::TMProposeSet const& m, UInt256 const& uid, PublicKey const& validator) = 0;
167
175 virtual std::set<Peer::ID>
176 relay(protocol::TMValidation const& m, UInt256 const& uid, PublicKey const& validator) = 0;
177
186 virtual void
188 UInt256 const& hash,
190 std::set<Peer::ID> const& toSkip) = 0;
191
200 virtual void
201 relay(STTx const& tx, protocol::TMTransaction const& m, std::set<Peer::ID> const& toSkip) = 0;
202
211 template <class Function>
212 void
213 foreach(Function f) const
214 {
215 for (auto const& p : getActivePeers())
216 f(p);
217 }
218
222 virtual void
224 [[nodiscard]] virtual std::uint64_t
226
231 virtual void
233 [[nodiscard]] virtual std::uint64_t
234 getPeerDisconnect() const = 0;
235 virtual void
237 [[nodiscard]] virtual std::uint64_t
239
249 [[nodiscard]] virtual std::optional<std::uint32_t>
250 networkID() const = 0;
251
256 [[nodiscard]] virtual json::Value
257 txMetrics() const = 0;
258};
259
260} // namespace xrpl
Subclasses can be called to write to a stream and have children.
A version-independent IP address and port combination.
Definition IPEndpoint.h:24
Represents a JSON value.
Definition json_value.h:121
virtual json::Value txMetrics() const =0
Returns tx reduce-relay metrics.
virtual void relay(UInt256 const &hash, std::optional< std::reference_wrapper< protocol::TMTransaction > > m, std::set< Peer::ID > const &toSkip)=0
Relay a transaction.
virtual void start()
Definition Overlay.h:73
virtual std::uint64_t getPeerDisconnect() const =0
boost::beast::tcp_stream SocketType
Definition Overlay.h:42
virtual std::optional< std::uint32_t > networkID() const =0
Returns the ID of the network this server is configured for, if any.
virtual void connect(beast::ip::Endpoint const &address)=0
Establish a peer connection to the specified endpoint.
virtual void relay(STTx const &tx, protocol::TMTransaction const &m, std::set< Peer::ID > const &toSkip)=0
Relay a transaction that the caller has already parsed, so that it is not parsed again.
virtual void broadcast(protocol::TMProposeSet const &m)=0
Broadcast a proposal.
virtual void incPeerDisconnect()=0
Increment and retrieve counters for total peer disconnects, and disconnects we initiate for excessive...
~Overlay() override=default
std::vector< std::shared_ptr< Peer > > PeerSequence
Definition Overlay.h:68
virtual Handoff onHandoff(std::unique_ptr< StreamType > &&bundle, HttpRequestType &&request, boost::asio::ip::tcp::endpoint remoteAddress)=0
Conditionally accept an incoming HTTP request.
virtual void stop()
Definition Overlay.h:78
virtual void checkTracking(std::uint32_t index)=0
Calls the checkTracking function on each peer.
virtual std::uint64_t getPeerDisconnectCharges() const =0
virtual void incJqTransOverflow()=0
Increment and retrieve counter for transaction job queue overflows.
boost::beast::ssl_stream< SocketType > StreamType
Definition Overlay.h:43
virtual int limit()=0
Returns the maximum number of peers we are configured to allow.
virtual PeerSequence getActivePeers() const =0
Returns a sequence representing the current list of peers.
virtual void broadcast(protocol::TMValidation const &m)=0
Broadcast a validation.
virtual std::uint64_t getJqTransOverflow() const =0
virtual json::Value json()=0
Return diagnostics on the status of all peers.
virtual void incPeerDisconnectCharges()=0
virtual std::shared_ptr< Peer > findPeerByShortID(Peer::ID const &id) const =0
Returns the peer with the matching short id, or null.
virtual std::set< Peer::ID > relay(protocol::TMProposeSet const &m, UInt256 const &uid, PublicKey const &validator)=0
Relay a proposal.
virtual std::shared_ptr< Peer > findPeerByPublicKey(PublicKey const &pubKey)=0
Returns the peer with the matching public key, or null.
virtual std::set< Peer::ID > relay(protocol::TMValidation const &m, UInt256 const &uid, PublicKey const &validator)=0
Relay a validation.
virtual std::size_t size() const =0
Returns the number of active peers.
std::uint32_t ID
Uniquely identifies a peer.
A public key.
Definition PublicKey.h:53
boost::asio::ip::address Address
Definition IPAddress.h:20
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:5
BaseUInt< 256 > UInt256
Definition base_uint.h:581
boost::beast::http::request< boost::beast::http::dynamic_body > HttpRequestType
Definition Handoff.h:12
Used to indicate the result of a server connection handoff.
Definition Handoff.h:20
std::uint32_t crawlOptions
Definition Overlay.h:62
std::optional< std::uint32_t > networkID
Definition Overlay.h:63
beast::ip::Address publicIp
Definition Overlay.h:60
std::shared_ptr< boost::asio::ssl::context > context
Definition Overlay.h:59