Cpl::System::Api Class Reference

This class defines methods for initializing the Colony.Core class library and other startup/init actions. More...

Detailed Description

This class defines methods for initializing the Colony.Core class library and other startup/init actions.

NOTE: The Colony.Core class library MUST BE INITIALIZED before calling any other Colony.Core methods/class/functions!

#include <Api.h>

Static Public Member Functions
static void	initialize (void)
	This function initializes the Colony.Core class library.
static void	enableScheduling (void)
	This function is used to initiate thread scheduling.
static bool	isSchedulingEnabled (void)
	This function returns true if scheduling has enabled using the enableScheduling() functions.
static void	sleep (unsigned long milliseconds) noexcept
	This method causes the current thread to be suspended for n milliseconds.
static void	sleepInRealTime (unsigned long milliseconds) noexcept
	This method is the same as sleep(), EXCEPT that is guaranteed to suspend in 'real time'.
static void	suspendScheduling (void)
	This method is used to temporarily suspend thread scheduling, i.e.
static void	resumeScheduling (void)
	This method is used to resume thread scheduling after a call to suspendScheduling has been made.

Member Function Documentation

enableScheduling()

static void Cpl::System::Api::enableScheduling ( void  )

static

This function is used to initiate thread scheduling.

The semantics of this call is that thread scheduling is guarantied to occur AFTER this call. However thread scheduling could have already begun/started PRIOR to this call. The actual behavior is platform specific.

NOTE: This function MAY or MAY NOT return. The specific behavior is platform specific. It is the application's responsible to properly handle the function's 'return behavior'

initialize()

static void Cpl::System::Api::initialize ( void  )

static

This function initializes the Colony.Core class library.

This function should be called as soon possible on start-up/boot-up of the application.

NOTES:

o This method MUST be called BEFORE any other methods in the
  Colony.Core package is called! The only exception to this rule
  is for internal Colony.Core use only.
o This method should only be called ONCE!

isSchedulingEnabled()

static bool Cpl::System::Api::isSchedulingEnabled ( void  )

static

This function returns true if scheduling has enabled using the enableScheduling() functions.

When this function returns true, the application is guaranteed that current execution context is a CPL thread (assuming the application did not create any threads outside of the CPL Threading interface).

resumeScheduling()

static void Cpl::System::Api::resumeScheduling ( void  )

static

This method is used to resume thread scheduling after a call to suspendScheduling has been made.

sleep()

static void Cpl::System::Api::sleep ( unsigned long  milliseconds )

staticnoexcept

This method causes the current thread to be suspended for n milliseconds.

sleepInRealTime()

static void Cpl::System::Api::sleepInRealTime ( unsigned long  milliseconds )

staticnoexcept

This method is the same as sleep(), EXCEPT that is guaranteed to suspend in 'real time'.

Typically an application NEVER needs to call this method. See the SimTick interface for additional details about Simulated Time.

suspendScheduling()

static void Cpl::System::Api::suspendScheduling ( void  )

static

This method is used to temporarily suspend thread scheduling, i.e.

no thread context switch will occur until resumeScheduling() is called. For every call to suspendScheduling() there must be a matching call to resumeScheduling(). Whether or not the calls to resumeScheduling() can be nested is platform specific.

NOTES: o The application MUST be very careful when using this method, i.e. it should NOT make an Cpl::System calls when scheduling has been suspended.
o The time between suspending and resuming scheduling should be kept as SMALL AS POSSIBLE. o The details of what happens is VERY platform specific, i.e. Windows and POSIX do not natively provide this functionality. Typically, this type of semantic only has meaning/is-useful when using an RTOS. OR said another - use of the suspend|resume methods are NOT portable with respect to guaranteed behavior across platforms.

---

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

• Cpl/System/Api.h