An endpoint that consumes resources. More...
#include <Consumer.h>
Public Member Functions | |
| Consumer () | |
| ~Consumer () | |
| Consumer (Consumer const &other) | |
| Consumer & | operator= (Consumer const &other) |
| std::string | to_string () const |
| Return a human readable string uniquely identifying this consumer. | |
| bool | isUnlimited () const |
Returns true if this is a privileged endpoint. | |
| void | elevate (std::string const &name) |
| Raise the Consumer's privilege level to a Named endpoint. | |
| Disposition | disposition () const |
| Returns the current disposition of this consumer. | |
| Disposition | charge (Charge const &fee, std::string const &context={}) |
| Apply a load charge to the consumer. | |
| bool | warn () |
Returns true if the consumer should be warned. | |
| bool | disconnect (beast::Journal const &j) |
Returns true if the consumer should be disconnected. | |
| int | balance () |
| Returns the credit balance representing consumption. | |
| Entry & | entry () |
| void | setPublicKey (PublicKey const &publicKey) |
Private Member Functions | |
| Consumer (Logic &logic, Entry &entry) | |
Private Attributes | |
| Logic * | m_logic |
| Entry * | m_entry |
Friends | |
| class | Logic |
Detailed Description
An endpoint that consumes resources.
Definition at line 35 of file Consumer.h.
Constructor & Destructor Documentation
◆ Consumer() [1/3]
Definition at line 35 of file Consumer.cpp.
◆ Consumer() [2/3]
| ripple::Resource::Consumer::Consumer | ( | ) |
Definition at line 40 of file Consumer.cpp.
◆ ~Consumer()
| ripple::Resource::Consumer::~Consumer | ( | ) |
Definition at line 54 of file Consumer.cpp.
◆ Consumer() [3/3]
| ripple::Resource::Consumer::Consumer | ( | Consumer const & | other | ) |
Definition at line 44 of file Consumer.cpp.
Member Function Documentation
◆ operator=()
Definition at line 61 of file Consumer.cpp.
◆ to_string()
| std::string ripple::Resource::Consumer::to_string | ( | ) | const |
Return a human readable string uniquely identifying this consumer.
Definition at line 78 of file Consumer.cpp.
◆ isUnlimited()
| bool ripple::Resource::Consumer::isUnlimited | ( | ) | const |
Returns true if this is a privileged endpoint.
Definition at line 87 of file Consumer.cpp.
◆ elevate()
| void ripple::Resource::Consumer::elevate | ( | std::string const & | name | ) |
Raise the Consumer's privilege level to a Named endpoint.
The reference to the original endpoint descriptor is released.
◆ disposition()
| Disposition ripple::Resource::Consumer::disposition | ( | ) | const |
Returns the current disposition of this consumer.
This should be checked upon creation to determine if the consumer should be disconnected immediately.
Definition at line 96 of file Consumer.cpp.
◆ charge()
| Disposition ripple::Resource::Consumer::charge | ( | Charge const & | fee, |
| std::string const & | context = {} |
||
| ) |
Apply a load charge to the consumer.
Definition at line 106 of file Consumer.cpp.
◆ warn()
| bool ripple::Resource::Consumer::warn | ( | ) |
Returns true if the consumer should be warned.
This consumes the warning.
Definition at line 117 of file Consumer.cpp.
◆ disconnect()
| bool ripple::Resource::Consumer::disconnect | ( | beast::Journal const & | j | ) |
Returns true if the consumer should be disconnected.
Definition at line 124 of file Consumer.cpp.
◆ balance()
| int ripple::Resource::Consumer::balance | ( | ) |
Returns the credit balance representing consumption.
Definition at line 137 of file Consumer.cpp.
◆ entry()
| Entry & ripple::Resource::Consumer::entry | ( | ) |
Definition at line 145 of file Consumer.cpp.
◆ setPublicKey()
| void ripple::Resource::Consumer::setPublicKey | ( | PublicKey const & | publicKey | ) |
Definition at line 152 of file Consumer.cpp.
Friends And Related Symbol Documentation
◆ Logic
|
friend |
Definition at line 38 of file Consumer.h.
Member Data Documentation
◆ m_logic
|
private |
Definition at line 95 of file Consumer.h.
◆ m_entry
|
private |
Definition at line 96 of file Consumer.h.
