![[Index]](../../../../_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../_stock/btn_next_wt.gif){kind=small}
|
|
|
|
|
|
||
Location:
e32std.h
Link against: euser.lib
class User : public UserHeap;
Set of static user functions.
These functions are related to a number of System component APIs.
The majority of the functions are related to either the current thread, or its heap. Examples in this category include User::Exit(), which causes the thread to terminate, and User::Alloc(), which allocates memory from the current thread's heap.
Some of these functions are equivalent to functions in the RThread or RHeap classes. In these cases, the User function is a convenient way to access the function without first having to get a handle to the current thread.
Functions are also provided to support debugging of memory leaks. These function calls can be written explicitly or can be generated using a corresponding macro - the advantage of using a macro is that the function call is only generated for debug builds.
A final category of functions, which includes User::BinarySearch() and User::QuickSort(), are just useful functions which have no other natural home.
UserHeap - A set of static functions for constructing fixed length heaps and local or global heapsUser - Set of static user functionsDefined in User:
After(), AfterHighRes(), Alloc(), AllocL(), AllocLC(), AllocLen(), AllocSize(), AllocZ(), AllocZL(), Allocator(), At(), Available(), Beep(), BinarySearch(), Check(), Collate(), CommandLine(), CommandLineLength(), CompressAllHeaps(), CountAllocCells(), CountAllocCells(), CreatorHasCapability(), CreatorHasCapability(), CreatorIdentity(), CreatorSecureId(), CreatorVendorId(), Critical(), Critical(), EAllThreadsCritical, ENotCritical, EProcessCritical, EProcessPermanent, ERealtimeStateOff, ERealtimeStateOn, ERealtimeStateWarn, ESystemCritical, ESystemPermanent, ExceptionHandler(), Exit(), FastCounter(), Fold(), Fold(), Free(), FreeLogicalDevice(), FreePhysicalDevice(), FreeZ(), GetDesParameter(), GetDesParameter(), GetTIntParameter(), Heap(), IMB_Range(), Identity(), InactivityTime(), InfoPrint(), Invariant(), IsExceptionHandled(), IsRomAddress(), JustInTime(), Language(), Leave(), LeaveIfError(), LeaveIfNull(), LeaveNoMemory(), LoadLogicalDevice(), LoadPhysicalDevice(), LockPeriod(), LockedDec(), LockedInc(), LowerCase(), MachineConfiguration(), ModifyExceptionMask(), NTickCount(), Panic(), ParameterLength(), PriorityControl(), ProcessCritical(), ProcessCritical(), QueryVersionSupported(), QuickSort(), RaiseException(), ReAlloc(), ReAllocL(), RenameProcess(), RenameThread(), RequestComplete(), ResetInactivityTime(), SafeDec(), SafeInc(), SetCritical(), SetCurrencySymbol(), SetDebugMask(), SetDebugMask(), SetExceptionHandler(), SetFloatingPointMode(), SetHomeTime(), SetJustInTime(), SetMachineConfiguration(), SetPriorityControl(), SetProcessCritical(), SetTrapHandler(), SetUTCOffset(), SetUTCTime(), SetUTCTimeAndOffset(), StringLength(), StringLength(), SwitchAllocator(), SwitchHeap(), TCritical, TRealtimeState, TickCount(), TitleCase(), TrapHandler(), UTCOffset(), UpperCase(), ValidateName(), Version(), WaitForAnyRequest(), WaitForNRequest(), WaitForRequest(), WaitForRequest(), __DbgMarkCheck(), __DbgMarkEnd(), __DbgMarkStart(), __DbgSetAllocFail()
Inherited from UserHeap:
ChunkHeap(),
EChunkHeapDuplicate,
EChunkHeapSwitchTo,
FixedHeap(),
OffsetChunkHeap(),
TChunkHeapCreateMode
static IMPORT_C void Exit(TInt aReason);
Terminates the current thread, specifying a reason. All child threads are terminated and all resources are cleaned up.
If the current thread is the main thread in a process, the process is also terminated.
|
static IMPORT_C void Panic(const TDesC &aCategory, TInt aReason);
Panics the current thread, specifying a category name and panic number.
Keep the length of the category name small; a length of 16 is ideal.
|
static IMPORT_C void Leave(TInt aReason);
Leaves the currently executing function, unwinds the call stack, and returns from the most recently entered trap harness.
|
static IMPORT_C void LeaveNoMemory();
Leaves with the specific reason code KErrNoMemory.
static IMPORT_C TInt LeaveIfError(TInt aReason);
Leaves or returns with a specified reason code.
If the reason code is negative the function leaves, and the reason code is returned through the trap harness.
If the reason code is zero or positive, the function simply returns with the reason value.
|
|
static IMPORT_C TAny *LeaveIfNull(TAny *aPtr);
Leaves with the reason code KErrNoMemory, if the specified pointer is NULL.
If the pointer is not NULL, the function simply returns with the value of the pointer.
|
|
static IMPORT_C TTrapHandler *SetTrapHandler(TTrapHandler *aHandler);
Sets the current thread's trap handler and returns a pointer to any pre-existing trap handler.
Pass a NULL pointer to this function to clear the trap handler.
The trap handler works with the TRAP mechanism to handle the effects of a leave.
Note that TTrapHandler is an abstract base class; a trap handler must be implemented as a derived class.
|
|
static IMPORT_C TTrapHandler *TrapHandler();
Gets a pointer to the current thread's trap handler.
Note that TTrapHandler is an abstract base class; a trap handler must be implemented as a derived class.
|
static IMPORT_C TInt InfoPrint(const TDesC &aDes);
Invokes the notifier server to display a text message on the screen for a short time.
|
|
static IMPORT_C void RequestComplete(TRequestStatus *&aStatus, TInt aReason);
Signals the current thread that the asynchronous request associated with the specified request status object is complete.
This function is used to complete an asynchronous request originating in the same thread as the code that is currently executing. If a request originates in another thread, then executing code must use RThread::RequestComplete() to signal the completion of that request.
The request is completed with the completion code passed in aReason. This value is copied into the request status, pointed to by aStatus, before signalling the current thread's request semaphore.
The meaning of the completion code passed in aReason is a matter of convention to be decided between the service requester and the service provider.
|
static IMPORT_C void WaitForAnyRequest();
Waits for any asynchronous request to complete.
The current thread waits on its request semaphore.
The function completes, and control returns to the caller when the current thread's request semaphore is signalled by any of the service providers which handle these asynchronous requests.
The request status of all outstanding asynchronous requests must be examined to determine which request is complete.
static IMPORT_C void WaitForRequest(TRequestStatus &aStatus);
Waits for a specific asynchronous request to complete.
The current thread waits on its request semaphore.
The function completes and control returns to the caller when the current thread's request semaphore is signalled by the service provider handling the request associated with aStatus. Before signalling, the service provider sets an appropriate value in aStatus, other than KRequestPending.
Note that if other asynchronous requests complete before the one associated with aStatus, the request semaphore is adjusted so that knowledge of their completion is not lost. In this a case, a subsequent call to User::WaitForAnyRequest() or User::WaitForRequest() will complete and return immediately.
|
static IMPORT_C void WaitForRequest(TRequestStatus &aStatus1, TRequestStatus &aStatus2);
Waits for either of two specific asynchronous requests to complete.
The current thread waits on its request semaphore.
The function completes and control returns to the caller when the current thread's request semaphore is signalled by either the service provider handling the request associated with aStatus1 or the service provider handling the request associated with aStatus2. Before signalling, the completing service provider sets an appropriate value in the status object, other than KRequestPending.
Note that if other asynchronous requests complete before the ones associated with aStatus1 and aStatus2, the request semaphore is adjusted so that knowledge of their completion is not lost. In this a case, a subsequent call to User::WaitForAnyRequest() or User::WaitForRequest() will complete and return immediately.
|
static IMPORT_C void WaitForNRequest(TRequestStatus *aStatusArray[], TInt aNum);
Waits for any one of specific asynchronous requests to complete.
The current thread waits on its request semaphore.
The function completes and control returns to the caller when the current thread's request semaphore is signalled by either the service provider handling the request associated with aStatus1 or the service provider handling the request associated with aStatus2. Before signalling, the completing service provider sets an appropriate value in the status object, other than KRequestPending.
Note that if other asynchronous requests complete before the ones associated with aStatusArray the request semaphore is adjusted so that knowledge of their completion is not lost. In this a case, a subsequent call to User::WaitForAnyRequest() or User::WaitForRequest() will complete and return immediately.
|
static IMPORT_C TInt AllocLen(const TAny *aCell);
Gets the length of the specified allocated heap cell.
The cell is assumed to be in the current thread's heap.
|
|
static IMPORT_C TAny *Alloc(TInt aSize);
Allocates a cell of specified size from the current thread's heap.
If there is insufficient memory available on the heap from which to allocate a cell of the required size, the function returns NULL.
The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.
|
|
|
static IMPORT_C TAny *AllocL(TInt aSize);
Allocates a cell of specified size from the current thread's heap, and leaves if there is insufficient memory in the heap.
The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.
|
|
|
static IMPORT_C TAny *AllocLC(TInt aSize);
Allocates a cell of specified size from the current thread's default heap, and, if successful, places a pointer to the cell onto the cleanup stack.
The function leaves if there is insufficient memory in the heap.
The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.
|
|
|
static IMPORT_C TAny *AllocZ(TInt aSize);
Allocates a cell of specified size from the current thread's default heap, and clears it to binary zeroes.
If there is insufficient memory available on the heap from which to allocate a cell of the required size, the function returns NULL.
The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.
|
|
|
static IMPORT_C TAny *AllocZL(TInt aSize);
Allocates a cell of specified size from the current thread's default heap, clears it to binary zeroes, and leaves if there is insufficient memory in the heap.
The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.
|
|
|
static IMPORT_C TInt AllocSize(TInt &aTotalAllocSize);
Gets the total number of cells allocated on the current thread's default heap, and the total space allocated to them.
|
|
static IMPORT_C TInt Available(TInt &aBiggestBlock);
Gets the total free space currently available on the current thread's default heap, and the space available in the largest free block.
The space available represents the total space which can be allocated.
Note that compressing the heap may reduce the total free space available and the space available in the largest free block.
|
|
static IMPORT_C TInt CountAllocCells();
Gets the total number of cells allocated on the current thread's default heap.
|
static IMPORT_C TInt CountAllocCells(TInt &aFreeCount);
Gets the the total number of cells allocated, and the number of free cells, on the current thread's default heap.
|
|
static IMPORT_C void Free(TAny *aCell);
Frees the specified cell and returns it to the current thread's default heap.
|
|
static IMPORT_C void FreeZ(TAny *&aCell);
Frees the specified cell, returns it to the current thread's default heap, and resets the pointer to NULL.
|
|
static IMPORT_C RAllocator &Allocator();
Gets the current thread's default current heap.
|
static inline RHeap &Heap();
Gets a reference to the handle to the current thread's heap.
|
static IMPORT_C TAny *ReAlloc(TAny *aCell, TInt aSize, TInt aMode=0);
Increases or decreases the size of an existing cell in the current thread's heap.
If the cell is being decreased in size, then it is guaranteed not to move, and the function returns the pointer originally passed in aCell. Note that the length of the cell will be the same if the difference between the old size and the new size is smaller than the minimum cell size.
If the cell is being increased in size, i.e. aSize is bigger than its current size, then the function tries to grow the cell in place. If successful, then the function returns the pointer originally passed in aCell. If unsuccessful, then:
if the cell cannot be moved, i.e. aMode has the ENeverMove bit set, then the function returns NULL.
if the cell can be moved, i.e. aMode does not have the ENeverMove bit set, then the function tries to allocate a new replacement cell, and, if successful, returns a pointer to the new cell; if unsuccessful, it returns NULL.
Note that in debug mode, the function returns NULL if the cell cannot be grown in place, regardless of whether the ENeverMove bit is set.
If the reallocated cell is at a different location from the original cell, then the content of the original cell is copied to the reallocated cell.
If the supplied pointer, aCell is NULL, then the function attempts to allocate a new cell, but only if the cell can be moved, i.e. aMode does not have the ENeverMove bit set.
Note the following general points:
If reallocation fails, the content of the original cell is preserved.
The resulting size of the re-allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.
|
|
|
static IMPORT_C TAny *ReAllocL(TAny *aCell, TInt aSize, TInt aMode=0);
Increases or decreases the size of an existing cell, and leaves if there is insufficient memory in the current thread's default heap.
If the cell is being decreased in size, then it is guaranteed not to move, and the function returns the pointer originally passed in aCell. Note that the length of the cell will be the same if the difference between the old size and the new size is smaller than the minimum cell size.
If the cell is being increased in size, i.e. aSize is bigger than its current size, then the function tries to grow the cell in place. If successful, then the function returns the pointer originally passed in aCell. If unsuccessful, then:
if the cell cannot be moved, i.e. aMode has the ENeverMove bit set, then the function leaves.
if the cell can be moved, i.e. aMode does not have the ENeverMove bit set, then the function tries to allocate a new replacement cell, and, if successful, returns a pointer to the new cell; if unsuccessful, it leaves.
Note that in debug mode, the function leaves if the cell cannot be grown in place, regardless of whether the ENeverMove bit is set.
If the reallocated cell is at a different location from the original cell, then the content of the original cell is copied to the reallocated cell.
If the supplied pointer, aCell is NULL, then the function attempts to allocate a new cell, but only if the cell can be moved, i.e. aMode does not have the ENeverMove bit set.
Note the following general points:
If reallocation fails, the content of the original cell is preserved.
The resulting size of the re-allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.
|
|
|
static IMPORT_C RAllocator *SwitchAllocator(RAllocator *aAllocator);
Changes the current thread's heap.
|
|
static inline RHeap *SwitchHeap(RAllocator *aHeap);
Changes the current thread's heap.
|
|
static IMPORT_C TInt CompressAllHeaps();
Compresses all the chunks containing heaps.
|
static IMPORT_C void After(TTimeIntervalMicroSeconds32 aInterval);
Suspends the current thread until a specified time interval has expired.
The resolution of the timer depends on the hardware, but is normally 1 Symbian OS tick (approximately 1/64 second).
|
|
static IMPORT_C TInt At(const TTime &aTime);
Suspends the current thread until the specified absolute time.
If the machine is off at that time, the machine will be turned on again.
KErrNone - suspension of the current thread completed normally at the requested time.
KErrAbort - suspension of the current thread was aborted because the system time changed.
KErrUnderflow - the requested completion time is in the past.
KErrOverFlow - the requested completion time is too far in the future.
|
|
static IMPORT_C void AfterHighRes(TTimeIntervalMicroSeconds32 aInterval);
Suspends the current thread until a specified time interval has expired to a resolution of 1ms .
|
|
| Capability: | WriteDeviceData |
static IMPORT_C TInt SetHomeTime(const TTime &aTime);
Sets the home time to a specified time value.
|
|
| Capability: | WriteDeviceData |
static IMPORT_C TInt SetUTCTime(const TTime &aUTCTime);
Sets the UTC time to a specified time value.
|
|
static IMPORT_C TTimeIntervalSeconds UTCOffset();
Gets the UTC offset - the difference between UTC and the current local time due to any time zones and daylight savings time that may be in effect. A positive offset indicates a time ahead of UTC, a negative offset indicates a time behind UTC.
|
| Capability: | WriteDeviceData |
static IMPORT_C void SetUTCOffset(TTimeIntervalSeconds aOffset);
Sets the UTC offset to the given number of seconds. This should include both time zone differences and the effect of any applicable daylight savings time. A positive offset indicates a time ahead of UTC, a negative offset indicates a time behind UTC.
|
| Capability: | WriteDeviceData |
static IMPORT_C TInt SetUTCTimeAndOffset(const TTime &aUTCTime, TTimeIntervalSeconds aOffset);
Sets the UTC time and UTC offset to the specified values, atomically. This is equivalent to calling both SetUTCTime and SetUTCOffset, but without the possibility of an incorrect time being observed between the two calls. If the operation is not successful, an error code will be returned and both the time and offset will be left unchanged.
|
|
| Capability: | WriteDeviceData |
static IMPORT_C TInt SetCurrencySymbol(const TDesC &aSymbol);
Sets the system wide currency symbol.
On successful return from this function, a call to the Set() member function of a TCurrencySymbol object fetches the new currency symbol.
|
|
|
static IMPORT_C TInt SetFloatingPointMode(TFloatingPointMode aMode, TFloatingPointRoundingMode aRoundingMode=EFpRoundToNearest);
Sets the hardware floating point mode for the current thread. This does not affect software floating point calculations. The rounding mode can also be set. New threads created by this thread will inherit the mode, thus to set the mode for a whole process, call this method before you create any new threads.
|
|
static IMPORT_C TUint TickCount();
Gets the current tick count.
The period between ticks is usually 1/64 second, but may be hardware dependent.
|
static IMPORT_C TUint32 NTickCount();
Gets the nanokernel tick count.
This is the current value of the machine's millisecond tick counter.
On the emulator the resolution defaults to 5 milliseconds; however you can change it to N milliseconds when you launch the emulator from the command line by specifying -Dtimerresolution=N as a parameter to epoc.exe, for example:
epoc.exe -Dtimerresolution=3
On most hardware the resolution is about 1 millisecond.
You can get the nanokernel tick period in microseconds by calling into the Hardware Abstraction Layer:
TInt nanokernel_tick_period;
HAL::Get(HAL::ENanoTickPeriod, nanokernel_tick_period);
|
static IMPORT_C TTimerLockSpec LockPeriod();
Returns which of the periods the clock is currently in.
|
static IMPORT_C TTimeIntervalSeconds InactivityTime();
Gets the time since the last user activity.
|
static IMPORT_C TUint32 FastCounter();
Gets the fast counter.
This is the current value of the machine's high resolution timer. If a high resolution timer is not available, it uses the millisecond timer instead.
The freqency of this counter can be determined by reading the HAL attribute EFastCounterFrequency.
|
static IMPORT_C TInt LockedInc(TInt &aValue);
Increments a TInt value by 1 when the current thread is locked to prevent re-entrancy.
The increment to aValue is done while the current thread is locked; i.e. no other thread is permitted to run until the sequence of instructions which increment aValue have completed. Hence the function gives controlled access to a TInt variable which may be in a memory location accessible to more than one thread.
As an example of its use, the function is used in the implementation of critical sections.
|
|
static IMPORT_C TInt LockedDec(TInt &aValue);
Decrements a TInt value by 1 when the current thread is locked to prevent re-entrancy.
The decrement from aValue is done while the current thread is locked; i.e. no other thread is permitted to run until the sequence of instructions which decrement aValue have completed. Hence the function gives controlled access to a TInt variable which may be in a memory location accessible to more than one thread.
As an example of its use, the function is used in the implementation of critical sections.
|
|
static IMPORT_C TInt SafeInc(TInt &aValue);
Atomically increments the specified value by 1, if the value is > 0.
|
|
static IMPORT_C TInt SafeDec(TInt &aValue);
Atomically decrements the specified value by 1, if the value is > 0.
|
|
static IMPORT_C TInt Beep(TInt aFrequency, TTimeIntervalMicroSeconds32 aDuration);
Makes a beep tone with a specified frequency and duration.
This function should not be used. It exists to maintain compatibility with older versions of Symban OS.
|
|
static IMPORT_C TInt IsRomAddress(TBool &aBool, TAny *aPtr);
Tests whether the specified address is in the ROM.
|
|
static IMPORT_C TInt BinarySearch(TInt aCount, const TKey &aKey, TInt &aPos);
Performs a binary search for an array element containing a specified key.
It can be used on any kind of array where elements can be identified by key. It is used by the standard Symbian OS arrays having CArrayFix, CArrayVar or CArrayPak in their class hierarchy in the implementation of the various functions for inserting, deleting and finding elements by key. The function can be used by other arrays.
The function returns a zero value if the search is successful and a non-zero value otherwise.
If the search is successful, the function puts the position (i.e. the index) of the element into aPos. If the search is unsuccessful, then the function puts into aPos the position of the first element in the array whose key is greater than the search key.
If the array is empty, i.e. aCount is zero, then the search is unsuccessful and aPos is not defined.
|
|
|
static IMPORT_C TInt QuickSort(TInt aCount, const TKey &aKey, const TSwap &aSwap);
Quick sorts array elements.
It is used by the standard Symbian OS arrays having CArrayFixBase, CArrayVarBase or CArrayPakBase in their class hierarchy in the implementation of their sort functions. The function can be used by other arrays.
The function returns KErrNone if the operation is successful otherwise it returns KErrGeneral.
|