mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-04 11:15:56 +00:00
ed5d6f3e22
To protect the identity of UNL validators, the IP addresses are redacted from the log messages sent to the common Grafana instance. However, without such identifying information it is challenging to debug issues. This change adds a node's public key to logs to improve our ability to debug issues. Co-authored-by: Bart Thomee <11445373+bthomee@users.noreply.github.com>
106 lines
2.9 KiB
C++
106 lines
2.9 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of rippled: https://github.com/ripple/rippled
|
|
Copyright (c) 2012, 2013 Ripple Labs Inc.
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef RIPPLE_RESOURCE_CONSUMER_H_INCLUDED
|
|
#define RIPPLE_RESOURCE_CONSUMER_H_INCLUDED
|
|
|
|
#include <xrpl/basics/Log.h>
|
|
#include <xrpl/protocol/PublicKey.h>
|
|
#include <xrpl/resource/Charge.h>
|
|
#include <xrpl/resource/Disposition.h>
|
|
|
|
namespace ripple {
|
|
namespace Resource {
|
|
|
|
struct Entry;
|
|
class Logic;
|
|
|
|
/** An endpoint that consumes resources. */
|
|
class Consumer
|
|
{
|
|
private:
|
|
friend class Logic;
|
|
Consumer(Logic& logic, Entry& entry);
|
|
|
|
public:
|
|
Consumer();
|
|
~Consumer();
|
|
Consumer(Consumer const& other);
|
|
Consumer&
|
|
operator=(Consumer const& other);
|
|
|
|
/** Return a human readable string uniquely identifying this consumer. */
|
|
std::string
|
|
to_string() const;
|
|
|
|
/** Returns `true` if this is a privileged endpoint. */
|
|
bool
|
|
isUnlimited() const;
|
|
|
|
/** Raise the Consumer's privilege level to a Named endpoint.
|
|
The reference to the original endpoint descriptor is released.
|
|
*/
|
|
void
|
|
elevate(std::string const& name);
|
|
|
|
/** Returns the current disposition of this consumer.
|
|
This should be checked upon creation to determine if the consumer
|
|
should be disconnected immediately.
|
|
*/
|
|
Disposition
|
|
disposition() const;
|
|
|
|
/** Apply a load charge to the consumer. */
|
|
Disposition
|
|
charge(Charge const& fee, std::string const& context = {});
|
|
|
|
/** Returns `true` if the consumer should be warned.
|
|
This consumes the warning.
|
|
*/
|
|
bool
|
|
warn();
|
|
|
|
/** Returns `true` if the consumer should be disconnected. */
|
|
bool
|
|
disconnect(beast::Journal const& j);
|
|
|
|
/** Returns the credit balance representing consumption. */
|
|
int
|
|
balance();
|
|
|
|
// Private: Retrieve the entry associated with the consumer
|
|
Entry&
|
|
entry();
|
|
|
|
void
|
|
setPublicKey(PublicKey const& publicKey);
|
|
|
|
private:
|
|
Logic* m_logic;
|
|
Entry* m_entry;
|
|
};
|
|
|
|
std::ostream&
|
|
operator<<(std::ostream& os, Consumer const& v);
|
|
|
|
} // namespace Resource
|
|
} // namespace ripple
|
|
|
|
#endif
|