A namespace descriptor. More...

Collaboration diagram for catapult::mongo::plugins::NamespaceDescriptor:

[legend]

Public Member Functions
	NamespaceDescriptor (const state::Namespace::Path &path, const state::NamespaceAlias &alias, const std::shared_ptr< const state::RootNamespace > &pRootNamespace, const Address &ownerAddress, uint32_t index, bool isActive)
	Creates a namespace descriptor around path, alias, pRootNamespace, ownerAddress, index and isActive. More...

bool	IsRoot () const
	Returns `true` if the described namespace is a root namespace. More...

Public Attributes
const state::Namespace::Path	Path
	Namespace path. More...

const state::NamespaceAlias	Alias
	Namespace alias. More...

const std::shared_ptr< const state::RootNamespace >	pRoot
	Associated root namespace. More...

Address	OwnerAddress

uint32_t	Index
	Index in the root namespace history. More...

bool	IsActive
	Flag indicating whether or not the namespace is active. More...

Detailed Description

A namespace descriptor.

Constructor & Destructor Documentation

◆ NamespaceDescriptor()

catapult::mongo::plugins::NamespaceDescriptor::NamespaceDescriptor	(	const state::Namespace::Path &	path,
		const state::NamespaceAlias &	alias,
		const std::shared_ptr< const state::RootNamespace > &	pRootNamespace,
		const Address &	ownerAddress,
		uint32_t	index,
		bool	isActive
	)

inline

Creates a namespace descriptor around path, alias, pRootNamespace, ownerAddress, index and isActive.

Member Function Documentation

◆ IsRoot()

bool catapult::mongo::plugins::NamespaceDescriptor::IsRoot ( ) const

inline

Returns true if the described namespace is a root namespace.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ Alias

const state::NamespaceAlias catapult::mongo::plugins::NamespaceDescriptor::Alias

Namespace alias.

◆ Index

uint32_t catapult::mongo::plugins::NamespaceDescriptor::Index

Index in the root namespace history.

◆ IsActive

bool catapult::mongo::plugins::NamespaceDescriptor::IsActive

Flag indicating whether or not the namespace is active.

◆ OwnerAddress

Address catapult::mongo::plugins::NamespaceDescriptor::OwnerAddress

Owner address.

Note: Address is stored to minimize number of conversions.

◆ Path

const state::Namespace::Path catapult::mongo::plugins::NamespaceDescriptor::Path

Namespace path.

◆ pRoot

const std::shared_ptr<const state::RootNamespace> catapult::mongo::plugins::NamespaceDescriptor::pRoot

Associated root namespace.

The documentation for this struct was generated from the following file:

NamespaceDescriptor.h

Public Member Functions

Public Attributes