ipc::shm::stat Namespace Reference

Stats-related sub-namespace, for ADL segregation and general organization. More...

Classes
struct	Borrower_obj_stats
	Flow-IPC SHM-module: SHM-provider-agnostic stats about borrowing objects, typically across a process boundary, from a SHM arena. More...
struct	Lender_obj_stats
	Flow-IPC SHM-module: SHM-provider-agnostic stats about an arena if viewed as being capable or lending to (sharing with) other process(es); otherwise like Owner_obj_stats. More...
struct	Live_obj_stats
	Stats struct thematically relevant to gauging outstanding (not-yet-garbage-collected) first-class objects in a given in-SHM arena. More...
struct	Owner_obj_stats
	Flow-IPC SHM-module: SHM-provider-agnostic stats about an arena object if viewed as solely a memory-manager or heap, at the construct()ed a/k/a first-class object level. More...
struct	Shared_arena_obj_stats
	Stats struct tracking quantities applicable only to the arena-sharing SHM-provider type (at least SHM-classic) but otherwise thematically similar to Owner_obj_stats, Lender_obj_stats, Borrower_obj_stats. More...

Functions
template<typename Visitor >
void	declare_stats (const flow::util::stat::Stat_name &name_prefix, const Owner_obj_stats *src_stats, Owner_obj_stats *target_stats, Visitor &&visitor)
	Declares the stats for Owner_obj_stats. More...
template<typename Visitor >
void	declare_stats (const flow::util::stat::Stat_name &name_prefix, const Lender_obj_stats *src_stats, Lender_obj_stats *target_stats, Visitor &&visitor)
	Declares the stats for Lender_obj_stats. More...
template<typename Visitor >
void	declare_stats (const flow::util::stat::Stat_name &name_prefix, const Borrower_obj_stats *src_stats, Borrower_obj_stats *target_stats, Visitor &&visitor)
	Declares the stats for Borrower_obj_stats. More...
template<typename Visitor >
void	declare_stats (const flow::util::stat::Stat_name &name_prefix, const Live_obj_stats *src_stats, Live_obj_stats *target_stats, Visitor &&visitor)
	Declares the stats for Live_obj_stats. More...
template<typename Visitor >
void	declare_stats (const flow::util::stat::Stat_name &name_prefix, const Shared_arena_obj_stats *src_stats, Shared_arena_obj_stats *target_stats, Visitor &&visitor)
	Declares the stats for Shared_arena_obj_stats. More...

Detailed Description

Stats-related sub-namespace, for ADL segregation and general organization.

Function Documentation

declare_stats() [1/5]

template<typename Visitor >

void ipc::shm::stat::declare_stats	(	const flow::util::stat::Stat_name &	name_prefix,
		const Borrower_obj_stats *	src_stats,
		Borrower_obj_stats *	target_stats,
		Visitor &&	visitor
	)

Declares the stats for Borrower_obj_stats.

Not invoked directly except by flow::util::stat internals, or when composing this stat-set into another.

See also

flow::util::stat namespace doc header for background on the declare/visit mechanism.

Template Parameters

Visitor

See above.

Parameters

name_prefix	See above.
src_stats	See above.
target_stats	See above.
visitor	See above.

Definition at line 524 of file shm_stats.hpp.

declare_stats() [2/5]

template<typename Visitor >

void ipc::shm::stat::declare_stats	(	const flow::util::stat::Stat_name &	name_prefix,
		const Lender_obj_stats *	src_stats,
		Lender_obj_stats *	target_stats,
		Visitor &&	visitor
	)

Declares the stats for Lender_obj_stats.

Not invoked directly except by flow::util::stat internals, or when composing this stat-set into another.

See also

flow::util::stat namespace doc header for background on the declare/visit mechanism.

Template Parameters

Visitor

See above.

Parameters

name_prefix	See above.
src_stats	See above.
target_stats	See above.
visitor	See above.

Definition at line 516 of file shm_stats.hpp.

declare_stats() [3/5]

template<typename Visitor >

void ipc::shm::stat::declare_stats	(	const flow::util::stat::Stat_name &	name_prefix,
		const Live_obj_stats *	src_stats,
		Live_obj_stats *	target_stats,
		Visitor &&	visitor
	)

Declares the stats for Live_obj_stats.

Not invoked directly except by flow::util::stat internals, or when composing this stat-set into another.

See also

flow::util::stat namespace doc header for background on the declare/visit mechanism.

Template Parameters

Visitor

See above.

Parameters

name_prefix	See above.
src_stats	See above.
target_stats	See above.
visitor	See above.

Definition at line 535 of file shm_stats.hpp.

declare_stats() [4/5]

template<typename Visitor >

void ipc::shm::stat::declare_stats	(	const flow::util::stat::Stat_name &	name_prefix,
		const Owner_obj_stats *	src_stats,
		Owner_obj_stats *	target_stats,
		Visitor &&	visitor
	)

Declares the stats for Owner_obj_stats.

Not invoked directly except by flow::util::stat internals, or when composing this stat-set into another.

See also

flow::util::stat namespace doc header for background on the declare/visit mechanism.

Template Parameters

Visitor

See above.

Parameters

name_prefix	See above.
src_stats	See above.
target_stats	See above.
visitor	See above.

Definition at line 501 of file shm_stats.hpp.

declare_stats() [5/5]

template<typename Visitor >

void ipc::shm::stat::declare_stats	(	const flow::util::stat::Stat_name &	name_prefix,
		const Shared_arena_obj_stats *	src_stats,
		Shared_arena_obj_stats *	target_stats,
		Visitor &&	visitor
	)

Declares the stats for Shared_arena_obj_stats.

Not invoked directly except by flow::util::stat internals, or when composing this stat-set into another.

See also

flow::util::stat namespace doc header for background on the declare/visit mechanism.

Template Parameters

Visitor

See above.

Parameters

name_prefix	See above.
src_stats	See above.
target_stats	See above.
visitor	See above.

Definition at line 546 of file shm_stats.hpp.