Kernel::UserProcessScheduler Class Reference

USER_PROCESS scheduler class. The main class which you call to schedule user processes. More...

#include <UserProcessScheduler.h>

Inheritance diagram for Kernel::UserProcessScheduler:

Public Member Functions
	UserProcessScheduler ()=default
	~UserProcessScheduler () override=default
	operator bool ()
	this checks if any process is on the team.
bool	operator! ()
	this checks if no process is on the team.
UserProcessTeam &	TheCurrentTeam ()
	Gets the current scheduled team.
BOOL	SwitchTeam (UserProcessTeam &team)
	Switches the current team.
ProcessID	Spawn (const Char *name, VoidPtr code, VoidPtr image)
	Add process to team.
Void	Remove (ProcessID process_id)
	Remove process from the team.
Bool	IsUser () override
	Is it a user scheduler?
Bool	IsKernel () override
	Is it a kernel scheduler?
Bool	HasMP () override
	Is it a SMP scheduler?
USER_PROCESS_REF &	TheCurrentProcess ()
	Gets current running process.
SizeT	Run ()
	Run User scheduler object.
STATIC UserProcessScheduler &	The ()
	Retrieves the singleton of the process scheduler.
Public Member Functions inherited from Kernel::ISchedulable
	ISchedulable ()=default
virtual	~ISchedulable ()=default
ISchedulable &	operator= (const ISchedulable &)=default
	ISchedulable (const ISchedulable &)=default

Private Attributes
UserProcessTeam	mTeam {}

Friends
class	UserProcessHelper

Detailed Description

USER_PROCESS scheduler class. The main class which you call to schedule user processes.

Constructor & Destructor Documentation

UserProcessScheduler()

Kernel::UserProcessScheduler::UserProcessScheduler ( )

explicitdefault

~UserProcessScheduler()

Kernel::UserProcessScheduler::~UserProcessScheduler ( )

overridedefault

Member Function Documentation

HasMP()

Bool Kernel::UserProcessScheduler::HasMP ( )

overridevirtual

Is it a SMP scheduler?

Reimplemented from Kernel::ISchedulable.

IsKernel()

Bool Kernel::UserProcessScheduler::IsKernel ( )

overridevirtual

Is it a kernel scheduler?

Reimplemented from Kernel::ISchedulable.

IsUser()

Bool Kernel::UserProcessScheduler::IsUser ( )

overridevirtual

Is it a user scheduler?

Reimplemented from Kernel::ISchedulable.

operator bool()

Kernel::UserProcessScheduler::operator bool ( )

explicit

this checks if any process is on the team.

operator!()

Bool Kernel::UserProcessScheduler::operator!

(

)

this checks if no process is on the team.

Remove()

Void Kernel::UserProcessScheduler::Remove

(

ProcessID

process_id

)

Remove process from the team.

Parameters

process_id

process slot inside team.

Return values

true	process was removed.
false	process doesn't exist in team.

Run()

SizeT Kernel::UserProcessScheduler::Run

(

)

Run User scheduler object.

Returns

USER_PROCESS count executed within a team.

we store this guy to tell the scheduler how many things we have scheduled.

Check if the process needs to be run.

Increase the usage time of the process.

Spawn()

ProcessID Kernel::UserProcessScheduler::Spawn	(	const Char *	name,
		VoidPtr	code,
		VoidPtr	image )

Add process to team.

Parameters

process

the process Ref class.

Returns

the process index inside the team.

Todo

File Tree allocation and dispose methods (amlal)

SwitchTeam()

BOOL Kernel::UserProcessScheduler::SwitchTeam

(

UserProcessTeam &

team

)

Switches the current team.

Parameters

team	the new team to switch to.

Return values

true	team was switched.
false	team was not switched.

The()

UserProcessScheduler & Kernel::UserProcessScheduler::The

(

)

Retrieves the singleton of the process scheduler.

TheCurrentProcess()

Ref< USER_PROCESS > & Kernel::UserProcessScheduler::TheCurrentProcess

(

)

Gets current running process.

Returns

TheCurrentTeam()

UserProcessTeam & Kernel::UserProcessScheduler::TheCurrentTeam

(

)

Gets the current scheduled team.

Returns

Friends And Related Symbol Documentation

UserProcessHelper

friend class UserProcessHelper

friend

Member Data Documentation

mTeam

UserProcessTeam Kernel::UserProcessScheduler::mTeam {}

private

---

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

• src/kernel/KernelKit/UserProcessScheduler.h
• src/kernel/src/UserProcessScheduler.cc