nn::os Namespace

Description

Namespace for the operating system API.

Namespaces

nn::os::ARM Namespace for functions specific to the ARM processor (the ::ARM portion may be omitted).
nn::os::CTR Namespace for functions specific to the CTR platform (the ::CTR portion can be omitted).

Classes

nn::os::Alarm Class for handling alarms.
nn::os::BlockingQueue Class for handling blocking queues.
nn::os::SafeBlockingQueue Class for handling blocking queues.
nn::os::CriticalSection Class for handling critical sections. Critical sections are synchronization objects used for providing mutual exclusion.
nn::os::EventBase Class that is used internally by the library. Do not use this class directly.
nn::os::Event Class for handling events. Events are synchronization objects that send notification that an event has occurred.
nn::os::HandleObject Abstract base class that represents an object managed by the OS.
nn::os::LightBarrier Synchronization mechanism that waits for the arrival of multiple threads.
nn::os::LightEvent Synchronization mechanism for communicating flags between threads.
nn::os::LightSemaphore Synchronization mechanism for mutual exclusion of the number of resources between threads.
nn::os::MemoryBlock Class allocating memory from the specified region in the heap.
nn::os::MemoryBlockBase Base class for classes handling contiguous memory regions.
nn::os::Mutex Class for handling mutexes. Mutexes are synchronization objects used for providing mutual exclusion.
nn::os::Semaphore Class for handling semaphores. Semaphores are synchronization objects that have counters.
nn::os::StackMemory Class that partitions a specified memory region for use as a stack.
nn::os::StackMemoryBlock Class allocating stack memory from the heap in the specified region.
nn::os::WaitObject Base class for objects that are able to wait.
nn::os::InterruptEvent Abstract class used internally by the library. Do not use it directly.
nn::os::Thread Class for representing threads.
nn::os::StackBuffer Class template used for placing the thread stack in locations such as within a static region or a structure.
nn::os::ThreadLocalStorage Class that represents thread-local storage with the same size as the uptr type.
nn::os::Tick Class for handling system ticks.
nn::os::Timer Class for representing timers.

Structures

nn::os::LockPolicy Container class used for operations related to lock policies.

typedef Definitions

AlarmHandler Type representing handlers that are run for alarms.

Constants

NN_ATTRIBUTE_DEPRECATED const size_t DEVICE_MEMORY_SIZE This constant will be eliminated in the future.
ALLOCATE_OPTION_LINEAR const int Option passed to the AllocateMemoryBlock function. This allocates a contiguous block of physical memory.
WAIT_INFINITE const s64 The function continues running until a result is obtained. (Used by applet library functions that specify a time.)

Functions

InitializeAlarmSystem Initializes the alarm system.
GetAppMemorySize Gets the maximum total amount of memory that the application can use.
GetUsingMemorySize Gets the total size of memory currently allocated to the program.
InitializeDeviceMemory This function will be eliminated in the future.
SetupHeapForMemoryBlock This function sets up the OS to emulate the same memory environment that was used in CTR-SDK 0.9 and prior versions.
GetDeviceMemoryAddress Gets the starting address of the device memory.
SetDeviceMemorySize Changes the size of the device memory.
GetDeviceMemorySize Gets the size of the device memory.
GetHeapAddress Gets the starting address of the heap.
SetHeapSize Changes the size of the heap.
GetHeapSize Gets the size of the heap.
InitializeMemoryBlock Allows use of the MemoryBlock and StackMemoryBlock classes.

Revision History

2010/01/07
Initial version.

CONFIDENTIAL