Class that represents an abstraction of the Resource Group. More...

#include <resource_group.h>

Public Member Functions
	Resource_group (const std::string &name, const Type type, bool enabled)
	Construct a Resource_group object. More...

const std::string &	name () const

Type	type () const

bool	enabled () const

void	set_type (Type type)

void	set_enabled (bool enabled)

bool	is_defunct () const
	Method to check if resource group is defunct. More...

void	set_defunct ()
	Method to mark resource group defunct. More...

Thread_resource_control *	controller ()

const Thread_resource_control *	controller () const

bool	is_bound_to_threads ()
	Check if resource group is associated with threads. More...

bool	is_pfs_thread_id_exists (const ulonglong pfs_thread_id)
	Is pfs thread id already exists in the set. More...

void	add_pfs_thread_id (const ulonglong pfs_thread_id)
	Add thread_id to the thread id set associated with this resource group. More...

void	remove_pfs_thread_id (const ulonglong pfs_thread_id)
	Remove the PFS thread id. More...

void	clear ()
	Clear the thread id set associated with this resource group. More...

void	apply_control_func (std::function< void(ulonglong)> control_func)
	Apply a control function on threads associated with this resource group. More...

std::atomic< ulonglong > &	reference_count ()

uint &	version ()

	~Resource_group ()=default

Private Member Functions
	Resource_group (const Resource_group &)=delete
	Disable copy construction and assignment. More...

void	operator= (const Resource_group &)=delete

Private Attributes
std::string	m_name
	Name of the resource group. More...

Type	m_type
	Type whether it is user or system resource group. More...

bool	m_enabled
	bool flag whether resource is enabled or disabled. More...

bool	m_defunct {false}
	Whether resource group is defunct or operative. More...

Thread_resource_control	m_thread_resource_control
	Thread resource controller object. More...

std::set< ulonglong >	m_pfs_thread_id_set
	Threads associated with this resource group. More...

std::mutex	m_set_mutex
	Mutex protecting the resource group set. More...

std::atomic< ulonglong >	m_reference_count {0}
	Count of threads referencing resource group. More...

uint	m_version {0}
	Version number of a Resource group in-memory instance. More...

Detailed Description

Class that represents an abstraction of the Resource Group.

It has generic attributes of Resource group name, type, active or inactive, a pointer to a Resource control object.

Constructor & Destructor Documentation

◆ Resource_group() [1/2]

resourcegroups::Resource_group::Resource_group	(	const std::string &	name,
		const Type	type,
		bool	enabled
	)

inline

Construct a Resource_group object.

Parameters

name	name of the Resource_group.
type	type of the Resource_group.
enabled	Check if Resource_group is enabled or not.

◆ ~Resource_group()

resourcegroups::Resource_group::~Resource_group ( )

default

◆ Resource_group() [2/2]

resourcegroups::Resource_group::Resource_group ( const Resource_group & )

privatedelete

Disable copy construction and assignment.

Member Function Documentation

◆ add_pfs_thread_id()

void resourcegroups::Resource_group::add_pfs_thread_id ( const ulonglong pfs_thread_id )

inline

Add thread_id to the thread id set associated with this resource group.

Parameters

pfs_thread_id PFS thread id.

◆ apply_control_func()

void resourcegroups::Resource_group::apply_control_func ( std::function< void(ulonglong)> control_func )

inline

Apply a control function on threads associated with this resource group.

Parameters

control_func pointer to Control function.

◆ clear()

void resourcegroups::Resource_group::clear ( )

inline

Clear the thread id set associated with this resource group.

◆ controller() [1/2]

Thread_resource_control * resourcegroups::Resource_group::controller ( )

inline

◆ controller() [2/2]

const Thread_resource_control * resourcegroups::Resource_group::controller ( ) const

inline

◆ enabled()

bool resourcegroups::Resource_group::enabled ( ) const

inline

◆ is_bound_to_threads()

bool resourcegroups::Resource_group::is_bound_to_threads ( )

inline

Check if resource group is associated with threads.

Returns: true if some threads are mapped with this resource group else false.

◆ is_defunct()

bool resourcegroups::Resource_group::is_defunct ( ) const

inline

Method to check if resource group is defunct.

Returns: true if resource group is defunct else false.

◆ is_pfs_thread_id_exists()

bool resourcegroups::Resource_group::is_pfs_thread_id_exists ( const ulonglong pfs_thread_id )

inline

Is pfs thread id already exists in the set.

Parameters

pfs_thread_id PFS thread id.

Returns: true if thread id exists in the set else false.

◆ name()

const std::string & resourcegroups::Resource_group::name ( ) const

inline

◆ operator=()

void resourcegroups::Resource_group::operator= ( const Resource_group & )

privatedelete

◆ reference_count()

std::atomic< ulonglong > & resourcegroups::Resource_group::reference_count ( )

inline

◆ remove_pfs_thread_id()

void resourcegroups::Resource_group::remove_pfs_thread_id ( const ulonglong pfs_thread_id )

inline

Remove the PFS thread id.

Parameters

pfs_thread_id Remove pfs thread id.

◆ set_defunct()

void resourcegroups::Resource_group::set_defunct ( )

inline

Method to mark resource group defunct.

◆ set_enabled()

void resourcegroups::Resource_group::set_enabled ( bool enabled )

inline

◆ set_type()

void resourcegroups::Resource_group::set_type ( Type type )

inline

◆ type()

Type resourcegroups::Resource_group::type ( ) const

inline

◆ version()

uint & resourcegroups::Resource_group::version ( )

inline

Member Data Documentation

◆ m_defunct

bool resourcegroups::Resource_group::m_defunct {false}

private

Whether resource group is defunct or operative.

◆ m_enabled

bool resourcegroups::Resource_group::m_enabled

private

bool flag whether resource is enabled or disabled.

◆ m_name

std::string resourcegroups::Resource_group::m_name

private

Name of the resource group.

◆ m_pfs_thread_id_set

std::set<ulonglong> resourcegroups::Resource_group::m_pfs_thread_id_set

private

Threads associated with this resource group.

◆ m_reference_count

std::atomic<ulonglong> resourcegroups::Resource_group::m_reference_count {0}

private

Count of threads referencing resource group.

Count includes threads associated with this resource group (i.e. threads in m_pfs_thread_id_set) and other threads referencing this resource group (Only system threads internally switched to refer user resource group to execute user queries in some cases. User resource group maintains counter of even such references.)

◆ m_set_mutex

std::mutex resourcegroups::Resource_group::m_set_mutex

private

Mutex protecting the resource group set.

◆ m_thread_resource_control

Thread_resource_control resourcegroups::Resource_group::m_thread_resource_control

private

Thread resource controller object.

◆ m_type

Type resourcegroups::Resource_group::m_type

private

Type whether it is user or system resource group.

◆ m_version

uint resourcegroups::Resource_group::m_version {0}

private

Version number of a Resource group in-memory instance.

Version number is incremented on thread resource controls alter. If other threads (only system threads internally switched to refer user resource group to execute user queries for now) references this resource group, then resource group is re-applied by threads on version number mismatch.

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

sql/resourcegroups/resource_group.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Resource_group() [1/2]

◆ ~Resource_group()

◆ Resource_group() [2/2]

Member Function Documentation

◆ add_pfs_thread_id()

◆ apply_control_func()

◆ clear()

◆ controller() [1/2]

◆ controller() [2/2]

◆ enabled()

◆ is_bound_to_threads()

◆ is_defunct()

◆ is_pfs_thread_id_exists()

◆ name()

◆ operator=()

◆ reference_count()

◆ remove_pfs_thread_id()

◆ set_defunct()

◆ set_enabled()

◆ set_type()

◆ type()

◆ version()

Member Data Documentation

◆ m_defunct

◆ m_enabled

◆ m_name

◆ m_pfs_thread_id_set

◆ m_reference_count

◆ m_set_mutex

◆ m_thread_resource_control

◆ m_type

◆ m_version