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

#include <PropertyStream.h>

Inheritance diagram for beast::PropertyStream::Source:

[legend]

Collaboration diagram for beast::PropertyStream::Source:

[legend]

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

Static Public Member Functions
static bool	peelLeadingSlash (std::string *path)
static bool	peelTrailingSlashstar (std::string *path)
static std::string	peelName (std::string *path)

Private Attributes
std::string const	name_
std::recursive_mutex	lock_
Item	item_
Source *	parent_ {nullptr}
List< Item >	children_

Detailed Description

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

Definition at line 308 of file PropertyStream.h.

Constructor & Destructor Documentation

◆ Source() [1/2]

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

explicit

Definition at line 155 of file beast_PropertyStream.cpp.

◆ ~Source()

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

virtual

Definition at line 159 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

nodiscard

Returns the name of this source.

Definition at line 168 of file beast_PropertyStream.cpp.

◆ add() [1/2]

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

Add a child source.

Definition at line 174 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 338 of file PropertyStream.h.

◆ remove()

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

Remove a child source from this Source.

Definition at line 185 of file beast_PropertyStream.cpp.

◆ removeAll()

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

Remove all child sources from this Source.

Definition at line 196 of file beast_PropertyStream.cpp.

◆ writeOne()

void beast::PropertyStream::Source::writeOne ( PropertyStream & stream )

Write only this Source to the stream.

Definition at line 209 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 216 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 228 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 descendent "parent.grandchild." starts at the parent and prints down to grandchild "parent.grandchild.*" starts at parent, print through grandchild children

Definition at line 246 of file beast_PropertyStream.cpp.

◆ findOneDeep()

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

Definition at line 317 of file beast_PropertyStream.cpp.

◆ findPath()

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

Definition at line 334 of file beast_PropertyStream.cpp.

◆ findOne()

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

Definition at line 352 of file beast_PropertyStream.cpp.

◆ peelLeadingSlash()

bool beast::PropertyStream::Source::peelLeadingSlash ( std::string * path )

static

Definition at line 266 of file beast_PropertyStream.cpp.

◆ peelTrailingSlashstar()

bool beast::PropertyStream::Source::peelTrailingSlashstar ( std::string * path )

static

Definition at line 277 of file beast_PropertyStream.cpp.

◆ peelName()

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

static

Definition at line 293 of file beast_PropertyStream.cpp.

◆ onWrite()

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

virtual

Subclass override.

The default version does nothing.

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

Definition at line 364 of file beast_PropertyStream.cpp.

Member Data Documentation

◆ name_

std::string const beast::PropertyStream::Source::name_

private

Definition at line 311 of file PropertyStream.h.

◆ lock_

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

private

Definition at line 312 of file PropertyStream.h.

◆ item_

Item beast::PropertyStream::Source::item_

private

Definition at line 313 of file PropertyStream.h.

◆ parent_

Source* beast::PropertyStream::Source::parent_ {nullptr}

private

Definition at line 314 of file PropertyStream.h.

◆ children_

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

private

Definition at line 315 of file PropertyStream.h.

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Source() [1/2]

◆ ~Source()

◆ Source() [2/2]

Member Function Documentation

◆ operator=()

◆ name()

◆ add() [1/2]

◆ add() [2/2]

◆ remove()

◆ removeAll()

◆ writeOne()

◆ write() [1/2]

◆ write() [2/2]

◆ find()

◆ findOneDeep()

◆ findPath()

◆ findOne()

◆ peelLeadingSlash()

◆ peelTrailingSlashstar()

◆ peelName()

◆ onWrite()

Member Data Documentation

◆ name_

◆ lock_

◆ item_

◆ parent_

◆ children_