Skip to content

File include/brisk/core/System.hpp


OsVersion class

OsVersion

Structure representing the operating system version.

major variable (OsVersion::major)

uint16_t major = 0

Major version of the operating system.

minor variable (OsVersion::minor)

uint16_t minor = 0

Minor version of the operating system.

build variable (OsVersion::build)

uint32_t build = 0

Build number of the operating system.

operator<=> function (OsVersion::operator<=>)

constexpr auto
operator<=>(const OsVersion &) const noexcept = default

Default comparison operator.

reflection variable (OsVersion::reflection)

constexpr static std::tuple reflection

Reflection data for the fields of OsVersion.


OsUname class

OsUname

Structure representing OS uname information.

sysname variable (OsUname::sysname)

std::string sysname

System name.

release variable (OsUname::release)

std::string release

Release name.

version variable (OsUname::version)

std::string version

Version of the system.

machine variable (OsUname::machine)

std::string machine

Machine hardware name.

operator== function (OsUname::operator==)

constexpr bool
operator==(const OsUname &) const noexcept = default

Default comparison operator.

reflection variable (OsUname::reflection)

constexpr static std::tuple reflection

Reflection data for the fields of OsUname.


osVersion function

OsVersion osVersion()

Retrieves the operating system version.
Returns The OsVersion structure containing the operating system version.


osName function

std::string osName()

Retrieves the operating system name.
Returns The name of the operating system as a string.


osUname function

OsUname osUname()

Retrieves the system uname information.
Returns The OsUname structure containing the uname information.


CpuInfo class

CpuInfo

Structure representing CPU information.

model variable (CpuInfo::model)

std::string model

CPU model name.

speed variable (CpuInfo::speed)

int speed

CPU speed in MHz.

reflection variable (CpuInfo::reflection)

constexpr static std::tuple reflection

Reflection data for the fields of CpuInfo.


cpuInfo function

CpuInfo cpuInfo()

Retrieves the CPU information.
Returns The CpuInfo structure containing CPU model and speed.


CpuUsage class

CpuUsage

CpuUsageRepresents CPU usage data for multiple cores.

Core class (CpuUsage::Core)

Core

CoreRepresents CPU usage metrics for a single core.

user variable (CpuUsage::Core::user)

double user

Time spent in user mode.

sys variable (CpuUsage::Core::sys)

double sys

Time spent in system mode.

idle variable (CpuUsage::Core::idle)

double idle

Time spent idle.

sum function (CpuUsage::Core::sum)

double sum() const

Calculates the total CPU time for the core.
Returns Sum of user, sys, and idle times.

reflection variable (CpuUsage::Core::reflection)

constexpr static std::tuple reflection

Reflection metadata for serialization.

usage variable (CpuUsage::usage)

SmallVector<Core, 16> usage

Array of core usage data.


cpuUsage function

CpuUsage cpuUsage()

Retrieves current CPU usage data.
Returns A CpuUsage struct containing usage data for all cores.


MemoryInfo class

MemoryInfo

MemoryInfoRepresents memory usage statistics.

maxrss variable (MemoryInfo::maxrss)

uint64_t maxrss

Maximum resident set size, in kilobytes.

majflt variable (MemoryInfo::majflt)

uint64_t majflt

Number of major page faults (hard page faults).

inblock variable (MemoryInfo::inblock)

uint64_t inblock

Number of block input operations.

oublock variable (MemoryInfo::oublock)

uint64_t oublock

Number of block output operations.


memoryInfo function

MemoryInfo memoryInfo()

Retrieves current memory usage information.
Returns A MemoryInfo struct containing memory statistics.


isOsWindows function

constexpr bool isOsWindows()

Checks if the current OS is Windows.
Returns Always false for non-Windows systems.


constexpr bool isOsWindows(unsigned int major,
                           unsigned int minor,
                           unsigned int build)

Dummy function for non-Windows systems.
Param major Major version number (unused).
Param minor Minor version number (unused).
Param build Build number (unused).
Returns Always false for non-Windows systems.


Auto-generated from sources, Revision , https://github.com/brisklib/brisk/blob//include/brisk/