rippled
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
beast::PropertyStream::Source Class Reference

Subclasses can be called to write to a stream and have children. More...

Inheritance diagram for beast::PropertyStream::Source:
Inheritance graph
[legend]
Collaboration diagram for beast::PropertyStream::Source:
Collaboration graph
[legend]

Public Member Functions

 Source (std::string const &name)
 
virtual ~Source ()
 
 Source (Source const &)=delete
 
Sourceoperator= (Source const &)=delete
 
std::string const & name () const
 Returns the name of this source. More...
 
void add (Source &source)
 Add a child source. More...
 
template<class Derived >
Derived * add (Derived *child)
 Add a child source by pointer. More...
 
void remove (Source &child)
 Remove a child source from this Source. More...
 
void removeAll ()
 Remove all child sources from this Source. More...
 
void write_one (PropertyStream &stream)
 Write only this Source to the stream. More...
 
void write (PropertyStream &stream)
 write this source and all its children recursively to the stream. More...
 
void write (PropertyStream &stream, std::string const &path)
 Parse the path and write the corresponding Source and optional children. More...
 
std::pair< Source *, bool > find (std::string path)
 Parse the dot-delimited Source path and return the result. More...
 
Sourcefind_one_deep (std::string const &name)
 
PropertyStream::Sourcefind_path (std::string path)
 
PropertyStream::Sourcefind_one (std::string const &name)
 
virtual void onWrite (Map &)
 Subclass override. More...
 

Static Public Member Functions

static bool peel_leading_slash (std::string *path)
 
static bool peel_trailing_slashstar (std::string *path)
 
static std::string peel_name (std::string *path)
 

Private Attributes

const std::string m_name
 
std::recursive_mutex lock_
 
Item item_
 
Sourceparent_
 
List< Itemchildren_
 

Detailed Description

Subclasses can be called to write to a stream and have children.

Definition at line 330 of file PropertyStream.h.

Constructor & Destructor Documentation

◆ Source() [1/2]

beast::PropertyStream::Source::Source ( std::string const &  name)
explicit

Definition at line 176 of file beast_PropertyStream.cpp.

◆ ~Source()

beast::PropertyStream::Source::~Source ( )
virtual

Definition at line 181 of file beast_PropertyStream.cpp.

◆ Source() [2/2]

beast::PropertyStream::Source::Source ( Source const &  )
delete

Member Function Documentation

◆ operator=()

Source& beast::PropertyStream::Source::operator= ( Source const &  )
delete

◆ name()

std::string const & beast::PropertyStream::Source::name ( ) const

Returns the name of this source.

Definition at line 190 of file beast_PropertyStream.cpp.

◆ add() [1/2]

void beast::PropertyStream::Source::add ( Source source)

Add a child source.

Definition at line 196 of file beast_PropertyStream.cpp.

◆ add() [2/2]

template<class Derived >
Derived* beast::PropertyStream::Source::add ( Derived *  child)

Add a child source by pointer.

The source pointer is returned so it can be used in ctor-initializers.

Definition at line 360 of file PropertyStream.h.

◆ remove()

void beast::PropertyStream::Source::remove ( Source child)

Remove a child source from this Source.

Definition at line 208 of file beast_PropertyStream.cpp.

◆ removeAll()

void beast::PropertyStream::Source::removeAll ( )

Remove all child sources from this Source.

Definition at line 220 of file beast_PropertyStream.cpp.

◆ write_one()

void beast::PropertyStream::Source::write_one ( PropertyStream stream)

Write only this Source to the stream.

Definition at line 233 of file beast_PropertyStream.cpp.

◆ write() [1/2]

void beast::PropertyStream::Source::write ( PropertyStream stream)

write this source and all its children recursively to the stream.

Definition at line 240 of file beast_PropertyStream.cpp.

◆ write() [2/2]

void beast::PropertyStream::Source::write ( PropertyStream stream,
std::string const &  path 
)

Parse the path and write the corresponding Source and optional children.

If the source is found, it is written. If the wildcard character '*' exists as the last character in the path, then all the children are written recursively.

Definition at line 252 of file beast_PropertyStream.cpp.

◆ find()

std::pair< PropertyStream::Source *, bool > beast::PropertyStream::Source::find ( std::string  path)

Parse the dot-delimited Source path and return the result.

The first value will be a pointer to the Source object corresponding to the given path. If no Source object exists, then the first value will be nullptr and the second value will be undefined. The second value is a boolean indicating whether or not the path string specifies the wildcard character '*' as the last character.

print statement examples "parent.child" prints child and all of its children "parent.child." start at the parent and print down to child "parent.grandchild" prints nothing- grandchild not direct discendent "parent.grandchild." starts at the parent and prints down to grandchild "parent.grandchild.*" starts at parent, print through grandchild children

Definition at line 266 of file beast_PropertyStream.cpp.

◆ find_one_deep()

PropertyStream::Source * beast::PropertyStream::Source::find_one_deep ( std::string const &  name)

Definition at line 333 of file beast_PropertyStream.cpp.

◆ find_path()

PropertyStream::Source * beast::PropertyStream::Source::find_path ( std::string  path)

Definition at line 350 of file beast_PropertyStream.cpp.

◆ find_one()

PropertyStream::Source * beast::PropertyStream::Source::find_one ( std::string const &  name)

Definition at line 368 of file beast_PropertyStream.cpp.

◆ peel_leading_slash()

bool beast::PropertyStream::Source::peel_leading_slash ( std::string path)
static

Definition at line 286 of file beast_PropertyStream.cpp.

◆ peel_trailing_slashstar()

bool beast::PropertyStream::Source::peel_trailing_slashstar ( std::string path)
static

Definition at line 297 of file beast_PropertyStream.cpp.

◆ peel_name()

std::string beast::PropertyStream::Source::peel_name ( std::string path)
static

Definition at line 313 of file beast_PropertyStream.cpp.

◆ onWrite()

void beast::PropertyStream::Source::onWrite ( Map )
virtual

Subclass override.

The default version does nothing.

Reimplemented in ripple::ApplicationImp, ripple::OverlayImpl, ripple::PeerFinder::ManagerImp, ripple::Resource::ManagerImp, and ripple::LedgerCleanerImp.

Definition at line 380 of file beast_PropertyStream.cpp.

Member Data Documentation

◆ m_name

const std::string beast::PropertyStream::Source::m_name
private

Definition at line 333 of file PropertyStream.h.

◆ lock_

std::recursive_mutex beast::PropertyStream::Source::lock_
private

Definition at line 334 of file PropertyStream.h.

◆ item_

Item beast::PropertyStream::Source::item_
private

Definition at line 335 of file PropertyStream.h.

◆ parent_

Source* beast::PropertyStream::Source::parent_
private

Definition at line 336 of file PropertyStream.h.

◆ children_

List<Item> beast::PropertyStream::Source::children_
private

Definition at line 337 of file PropertyStream.h.