xrpld
Loading...
Searching...
No Matches
Classes | Typedefs | Enumerations | Functions | Variables
xrpl::resource Namespace Reference

Classes

class  Charge
 A consumption charge. More...
class  Consumer
 An endpoint that consumes resources. More...
struct  Entry
struct  Import
 A set of imported consumer data from a gossip origin. More...
struct  Key
class  Logic
struct  Gossip
 Data format for exchanging consumption information across peers. More...
class  Manager
 Tracks load and resource consumption. More...
class  ManagerImp
class  ResourceManagerTest

Typedefs

using clock_type = beast::AbstractClock<std::chrono::steady_clock>

Enumerations

enum class  Kind { Inbound , Outbound , Unlimited }
 Kind of consumer. More...
enum class  Disposition { Ok , Warn , Drop }
 The disposition of a consumer after applying a load charge. More...

Functions

std::ostream & operator<< (std::ostream &os, Charge const &v)
std::ostream & operator<< (std::ostream &os, Consumer const &v)
std::ostream & operator<< (std::ostream &os, Entry const &v)
std::unique_ptr< Manager > makeManager (beast::insight::Collector::ptr const &collector, beast::Journal journal)
Charge const kFeeMalformedRequest (200, "malformed request")
Charge const kFeeRequestNoReply (10, "unsatisfiable request")
Charge const kFeeInvalidSignature (2000, "invalid signature")
Charge const kFeeUselessData (150, "useless data")
Charge const kFeeInvalidData (400, "invalid data")
Charge const kFeeMalformedData (2000, "malformed data")
Charge const kFeeMalformedRpc (100, "malformed RPC")
Charge const kFeeReferenceRpc (20, "reference RPC")
Charge const kFeeExceptionRpc (100, "exceptioned RPC")
Charge const kFeeMediumBurdenRpc (400, "medium RPC")
Charge const kFeeHeavyBurdenRpc (3000, "heavy RPC")
Charge const kFeeTrivialPeer (1, "trivial peer request")
Charge const kFeeModerateBurdenPeer (250, "moderate peer request")
Charge const kFeeHeavyBurdenPeer (2000, "heavy peer request")
Charge const kFeeWarning (4000, "received warning")
Charge const kFeeDrop (6000, "dropped")
 TEST_F (ResourceManagerTest, limited_warn_drop)
 TEST_F (ResourceManagerTest, unlimited_warn_drop)
 TEST_F (ResourceManagerTest, charges)
 TEST_F (ResourceManagerTest, imports)
 TEST_F (ResourceManagerTest, import)

Variables

static constexpr auto kWarningThreshold = 5000
 Tunable constants.
static constexpr auto kDropThreshold = 25000
static constexpr auto kDecayWindowSeconds = 32
static constexpr auto kMinimumGossipBalance = 1000
static constexpr std::chrono::seconds kSecondsUntilExpiration {300}
static constexpr std::chrono::seconds kGossipExpirationSeconds {30}
Charge const kFeeMalformedRequest
 Schedule of fees charged for imposing load on the server.
Charge const kFeeRequestNoReply
Charge const kFeeInvalidSignature
Charge const kFeeUselessData
Charge const kFeeInvalidData
Charge const kFeeMalformedData
Charge const kFeeMalformedRpc
Charge const kFeeReferenceRpc
Charge const kFeeExceptionRpc
Charge const kFeeMediumBurdenRpc
Charge const kFeeHeavyBurdenRpc
Charge const kFeeTrivialPeer
Charge const kFeeModerateBurdenPeer
Charge const kFeeHeavyBurdenPeer
Charge const kFeeWarning
Charge const kFeeDrop

Typedef Documentation

◆ clock_type

using xrpl::resource::clock_type = beast::AbstractClock<std::chrono::steady_clock>

Definition at line 17 of file Entry.h.

Enumeration Type Documentation

◆ Kind

enum class xrpl::resource::Kind
strong

Kind of consumer.

kindInbound: Inbound connection. kindOutbound: Outbound connection. kindUnlimited: Inbound connection with no resource limits, but could be subjected to administrative restrictions, such as use of some RPC commands like "stop".

Enumerator
Inbound 
Outbound 
Unlimited 

Definition at line 13 of file Kind.h.

◆ Disposition

enum class xrpl::resource::Disposition
strong

The disposition of a consumer after applying a load charge.

Enumerator
Ok 

No action required.

Consumer should be warned that consumption is high.

Warn 

Consumer should be disconnected for excess consumption.

Drop 

Definition at line 8 of file Disposition.h.

Function Documentation

◆ operator<<() [1/3]

std::ostream & xrpl::resource::operator<< ( std::ostream & os,
Charge const & v )

Definition at line 35 of file Charge.cpp.

◆ operator<<() [2/3]

std::ostream & xrpl::resource::operator<< ( std::ostream & os,
Consumer const & v )

Definition at line 138 of file Consumer.cpp.

◆ operator<<() [3/3]

std::ostream & xrpl::resource::operator<< ( std::ostream & os,
Entry const & v )

Definition at line 87 of file Entry.h.

◆ makeManager()

std::unique_ptr< Manager > xrpl::resource::makeManager ( beast::insight::Collector::ptr const & collector,
beast::Journal journal )

Definition at line 162 of file ResourceManager.cpp.

◆ kFeeMalformedRequest()

Charge const xrpl::resource::kFeeMalformedRequest ( 200 ,
"malformed request"  )

◆ kFeeRequestNoReply()

Charge const xrpl::resource::kFeeRequestNoReply ( 10 ,
"unsatisfiable request"  )

◆ kFeeInvalidSignature()

Charge const xrpl::resource::kFeeInvalidSignature ( 2000 ,
"invalid signature"  )

◆ kFeeUselessData()

Charge const xrpl::resource::kFeeUselessData ( 150 ,
"useless data"  )

◆ kFeeInvalidData()

Charge const xrpl::resource::kFeeInvalidData ( 400 ,
"invalid data"  )

◆ kFeeMalformedData()

Charge const xrpl::resource::kFeeMalformedData ( 2000 ,
"malformed data"  )

◆ kFeeMalformedRpc()

Charge const xrpl::resource::kFeeMalformedRpc ( 100 ,
"malformed RPC"  )

◆ kFeeReferenceRpc()

Charge const xrpl::resource::kFeeReferenceRpc ( 20 ,
"reference RPC"  )

◆ kFeeExceptionRpc()

Charge const xrpl::resource::kFeeExceptionRpc ( 100 ,
"exceptioned RPC"  )

◆ kFeeMediumBurdenRpc()

Charge const xrpl::resource::kFeeMediumBurdenRpc ( 400 ,
"medium RPC"  )

◆ kFeeHeavyBurdenRpc()

Charge const xrpl::resource::kFeeHeavyBurdenRpc ( 3000 ,
"heavy RPC"  )

◆ kFeeTrivialPeer()

Charge const xrpl::resource::kFeeTrivialPeer ( 1 ,
"trivial peer request"  )

◆ kFeeModerateBurdenPeer()

Charge const xrpl::resource::kFeeModerateBurdenPeer ( 250 ,
"moderate peer request"  )

◆ kFeeHeavyBurdenPeer()

Charge const xrpl::resource::kFeeHeavyBurdenPeer ( 2000 ,
"heavy peer request"  )

◆ kFeeWarning()

Charge const xrpl::resource::kFeeWarning ( 4000 ,
"received warning"  )

◆ kFeeDrop()

Charge const xrpl::resource::kFeeDrop ( 6000 ,
"dropped"  )

◆ TEST_F() [1/5]

xrpl::resource::TEST_F ( ResourceManagerTest ,
limited_warn_drop  )

Definition at line 84 of file Logic.cpp.

◆ TEST_F() [2/5]

xrpl::resource::TEST_F ( ResourceManagerTest ,
unlimited_warn_drop  )

Definition at line 156 of file Logic.cpp.

◆ TEST_F() [3/5]

xrpl::resource::TEST_F ( ResourceManagerTest ,
charges  )

Definition at line 181 of file Logic.cpp.

◆ TEST_F() [4/5]

xrpl::resource::TEST_F ( ResourceManagerTest ,
imports  )

Definition at line 216 of file Logic.cpp.

◆ TEST_F() [5/5]

xrpl::resource::TEST_F ( ResourceManagerTest ,
import  )

Definition at line 226 of file Logic.cpp.

Variable Documentation

◆ kWarningThreshold

auto xrpl::resource::kWarningThreshold = 5000
staticconstexpr

Tunable constants.

Definition at line 12 of file include/xrpl/resource/detail/Tuning.h.

◆ kDropThreshold

auto xrpl::resource::kDropThreshold = 25000
staticconstexpr

Definition at line 15 of file include/xrpl/resource/detail/Tuning.h.

◆ kDecayWindowSeconds

auto xrpl::resource::kDecayWindowSeconds = 32
staticconstexpr

Definition at line 18 of file include/xrpl/resource/detail/Tuning.h.

◆ kMinimumGossipBalance

auto xrpl::resource::kMinimumGossipBalance = 1000
staticconstexpr

Definition at line 21 of file include/xrpl/resource/detail/Tuning.h.

◆ kSecondsUntilExpiration

std::chrono::seconds xrpl::resource::kSecondsUntilExpiration {300}
staticconstexpr

Definition at line 24 of file include/xrpl/resource/detail/Tuning.h.

◆ kGossipExpirationSeconds

std::chrono::seconds xrpl::resource::kGossipExpirationSeconds {30}
staticconstexpr

Definition at line 27 of file include/xrpl/resource/detail/Tuning.h.

◆ kFeeMalformedRequest

Charge const xrpl::resource::kFeeMalformedRequest(200, "malformed request")

Schedule of fees charged for imposing load on the server.

◆ kFeeRequestNoReply

Charge const xrpl::resource::kFeeRequestNoReply(10, "unsatisfiable request")

◆ kFeeInvalidSignature

Charge const xrpl::resource::kFeeInvalidSignature(2000, "invalid signature")

◆ kFeeUselessData

Charge const xrpl::resource::kFeeUselessData(150, "useless data")

◆ kFeeInvalidData

Charge const xrpl::resource::kFeeInvalidData(400, "invalid data")

◆ kFeeMalformedData

Charge const xrpl::resource::kFeeMalformedData(2000, "malformed data")

◆ kFeeMalformedRpc

Charge const xrpl::resource::kFeeMalformedRpc(100, "malformed RPC")

◆ kFeeReferenceRpc

Charge const xrpl::resource::kFeeReferenceRpc(20, "reference RPC")

◆ kFeeExceptionRpc

Charge const xrpl::resource::kFeeExceptionRpc(100, "exceptioned RPC")

◆ kFeeMediumBurdenRpc

Charge const xrpl::resource::kFeeMediumBurdenRpc(400, "medium RPC")

◆ kFeeHeavyBurdenRpc

Charge const xrpl::resource::kFeeHeavyBurdenRpc(3000, "heavy RPC")

◆ kFeeTrivialPeer

Charge const xrpl::resource::kFeeTrivialPeer(1, "trivial peer request")

◆ kFeeModerateBurdenPeer

Charge const xrpl::resource::kFeeModerateBurdenPeer(250, "moderate peer request")

◆ kFeeHeavyBurdenPeer

Charge const xrpl::resource::kFeeHeavyBurdenPeer(2000, "heavy peer request")

◆ kFeeWarning

Charge const xrpl::resource::kFeeWarning(4000, "received warning")

◆ kFeeDrop

Charge const xrpl::resource::kFeeDrop(6000, "dropped")
Generated by doxygen 1.16.1