Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Search  

uclean.h File Reference

#include "unicode/utypes.h"

Go to the source code of this file.

Typedefs

typedef void * UMTX
 An opaque pointer type that represents an ICU mutex. More...

typedef void U_CALLCONV UMtxInitFn (const void *context, UMTX *mutex, UErrorCode *status)
 Function Pointer type for a user supplied mutex initialization function. More...

typedef void U_CALLCONV UMtxFn (const void *context, UMTX *mutex)
 Function Pointer type for a user supplied mutex functions. More...

typedef int32_t U_CALLCONV UMtxAtomicFn (const void *context, int32_t *p)
 Pointer type for a user supplied atomic increment or decrement function. More...

typedef void *U_CALLCONV UMemAllocFn (const void *context, size_t size)
 Pointer type for a user supplied memory allocation function. More...

typedef void *U_CALLCONV UMemReallocFn (const void *context, void *mem, size_t size)
 Pointer type for a user supplied memory re-allocation function. More...

typedef void U_CALLCONV UMemFreeFn (const void *context, void *mem)
 Pointer type for a user supplied memory free function. More...


Functions

void u_init (UErrorCode *status)
 Initialize ICU. More...

void u_cleanup (void)
 Clean up the system resources, such as allocated memory or open files, used in all ICU libraries. More...

void u_setMutexFunctions (const void *context, UMtxInitFn *init, UMtxFn *destroy, UMtxFn *lock, UMtxFn *unlock, UErrorCode *status)
 Set the functions that ICU will use for mutex operations Use of this function is optional; by default (without this function), ICU will directly access system functions for mutex operations This function can only be used when ICU is in an initial, unused state, before u_init() has been called. More...

void u_setAtomicIncDecFunctions (const void *context, UMtxAtomicFn *inc, UMtxAtomicFn *dec, UErrorCode *status)
 Set the functions that ICU will use for atomic increment and decrement of int32_t values. More...

void u_setMemoryFunctions (const void *context, UMemAllocFn *a, UMemReallocFn *r, UMemFreeFn *f, UErrorCode *status)
 Set the functions that ICU will use for memory allocation. More...


Typedef Documentation

typedef void* UMTX
 

An opaque pointer type that represents an ICU mutex.

For user-implemented mutexes, the value will typically point to a struct or object that implements the mutex.

Draft:
This API has been introduced in ICU 2.8 @system. It is still in draft state and may be modified in a future release.

Definition at line 103 of file uclean.h.

typedef void* U_CALLCONV UMemAllocFn(const void *context, size_t size)
 

Pointer type for a user supplied memory allocation function.

Parameters:
context  user supplied value, obtained from from u_setMemoryFunctions().
size  The number of bytes to be allocated
Returns:
Pointer to the newly allocated memory, or NULL if the allocation failed.
Draft:
This API has been introduced in ICU 2.8 @system. It is still in draft state and may be modified in a future release.

Definition at line 197 of file uclean.h.

typedef void U_CALLCONV UMemFreeFn(const void *context, void *mem)
 

Pointer type for a user supplied memory free function.

Behavior should be similar the standard C library free().

Parameters:
context  user supplied value, obtained from from u_setMemoryFunctions().
mem  Pointer to the memory block to be resized
size  The new size for the block
Returns:
Pointer to the resized memory block, or NULL if the resizing failed.
Draft:
This API has been introduced in ICU 2.8 @system. It is still in draft state and may be modified in a future release.

Definition at line 217 of file uclean.h.

typedef void* U_CALLCONV UMemReallocFn(const void *context, void *mem, size_t size)
 

Pointer type for a user supplied memory re-allocation function.

Parameters:
context  user supplied value, obtained from from u_setMemoryFunctions().
size  The number of bytes to be allocated
Returns:
Pointer to the newly allocated memory, or NULL if the allocation failed.
Draft:
This API has been introduced in ICU 2.8 @system. It is still in draft state and may be modified in a future release.

Definition at line 206 of file uclean.h.

typedef int32_t U_CALLCONV UMtxAtomicFn(const void *context, int32_t *p)
 

Pointer type for a user supplied atomic increment or decrement function.

Parameters:
context  user supplied value, obtained from from u_setAtomicIncDecFunctions().
p  Pointer to a 32 bit int to be incremented or decremented
Returns:
The value of the variable after the inc or dec operation.
Draft:
This API has been introduced in ICU 2.8 @system. It is still in draft state and may be modified in a future release.

Definition at line 166 of file uclean.h.

typedef void U_CALLCONV UMtxFn(const void *context, UMTX *mutex)
 

Function Pointer type for a user supplied mutex functions.

One of the user-supplied functions with this signature will be called by ICU whenever ICU needs to lock, unlock, or destroy a mutex.

Parameters:
context  user supplied value, obtained from from u_setMutexFunctions().
mutex  specify the mutex on which to operate.
Draft:
This API has been introduced in ICU 2.8 @system. It is still in draft state and may be modified in a future release.

Definition at line 133 of file uclean.h.

typedef void U_CALLCONV UMtxInitFn(const void *context, UMTX *mutex, UErrorCode* status)
 

Function Pointer type for a user supplied mutex initialization function.

The user-supplied function will be called by ICU whenever ICU needs to create a new mutex. The function implementation should create a mutex, and store a pointer to something that uniquely identifies the mutex into the UMTX that is supplied as a paramter.

Parameters:
context  user supplied value, obtained from from u_setMutexFunctions().
mutex  Receives a pointer that identifies the new mutex. The mutex init function must set the UMTX to a non-null value. Subsequent calls by ICU to lock, unlock, or destroy a mutex will identify the mutex by the UMTX value.
status  Error status. Report errors back to ICU by setting this variable with an error code.
Draft:
This API has been introduced in ICU 2.8 @system. It is still in draft state and may be modified in a future release.

Definition at line 121 of file uclean.h.


Function Documentation

void u_cleanup void   
 

Clean up the system resources, such as allocated memory or open files, used in all ICU libraries.

This will free/delete all memory owned by the ICU libraries, and return them to their original load state. All open ICU items (collators, resource bundles, converters, etc.) must be closed before calling this function, otherwise ICU may not free its allocated memory (e.g. close your converters and resource bundles before calling this function). Generally, this function should be called once just before an application exits. For applications that dynamically load and unload the ICU libraries (relatively uncommon), u_cleanup() should be called just before the library unload.

u_cleanup() is not thread safe. All other threads should stop using ICU before calling this function.

Any open ICU items will be left in an undefined state by u_cleanup(), and any subsequent attempt to use such an item will give unpredictable results.

After calling u_cleanup(), an application may continue to use ICU by calling u_init(). An application must invoke u_init() first from one single thread before allowing other threads call u_init(). All threads existing at the time of the first thread's call to u_init() must also call u_init() themselves before continuing with other ICU operations.

The use of u_cleanup() just before an application terminates is optional, but it should be called only once for performance reasons. The primary benefit is to eliminate reports of memory or resource leaks originating in ICU code from the results generated by heap analysis tools.

Use this function with great care!

Stable:
ICU 2.0
System:

void u_init UErrorCode   status
 

Initialize ICU.

This function loads and initializes data items that are required internally by various ICU functions. Use of this explicit initialization is required in multi-threaded applications; in single threaded apps, use is optional, but incurs little additional cost, and is thus recommended.

In multi-threaded applications, u_init() should be called in the main thread before starting additional threads, or, alternatively it can be called in each individual thread once, before other ICU functions are called in that thread. In this second scenario, the application must guarantee that the first call to u_init() happen without contention, in a single thread only.

If u_setMemoryFunctions() or u_setMutexFunctions are needed (uncommon), they must be called _before_ u_init().

Extra, repeated, or otherwise unneeded calls to u_init() do no harm, other than taking a small amount of time.

Parameters:
pErrorCode  An ICU UErrorCode parameter. It must not be NULL. An Error will be returned if some required part of ICU data can not be loaded or initialized. The function returns immediately if the input error code indicates a failure, as usual.
Draft:
This API has been introduced in ICU 2.6. It is still in draft state and may be modified in a future release.

void u_setAtomicIncDecFunctions const void *    context,
UMtxAtomicFn   inc,
UMtxAtomicFn   dec,
UErrorCode   status
 

Set the functions that ICU will use for atomic increment and decrement of int32_t values.

Use of this function is optional; by default (without this function), ICU will use its own internal implementation of atomic increment/decrement. This function can only be used when ICU is in an initial, unused state, before u_init() has been called.

Parameters:
context  This pointer value will be saved, and then (later) passed as a parameter to the increment and decrement functions each time they are called. This function can only be called
inc  Pointer to a function to do an atomic increment operation. Must be non-null.
dec  Pointer to a function to do an atomic decrement operation. Must be non-null.
status  Receives error values.
Draft:
This API has been introduced in ICU 2.8 @system. It is still in draft state and may be modified in a future release.

void u_setMemoryFunctions const void *    context,
UMemAllocFn   a,
UMemReallocFn   r,
UMemFreeFn   f,
UErrorCode   status
 

Set the functions that ICU will use for memory allocation.

Use of this function is optional; by default (without this function), ICU will use the standard C library malloc() and free() functions. This function can only be used when ICU is in an initial, unused state, before u_init() has been called.

Parameters:
context  This pointer value will be saved, and then (later) passed as a parameter to the memory functions each time they are called.
a  Pointer to a user-supplied malloc function.
r  Pointer to a user-supplied realloc function.
f  Pointer to a user-supplied free function.
status  Receives error values.
Draft:
This API has been introduced in ICU 2.8 @system. It is still in draft state and may be modified in a future release.

void u_setMutexFunctions const void *    context,
UMtxInitFn   init,
UMtxFn   destroy,
UMtxFn   lock,
UMtxFn   unlock,
UErrorCode   status
 

Set the functions that ICU will use for mutex operations Use of this function is optional; by default (without this function), ICU will directly access system functions for mutex operations This function can only be used when ICU is in an initial, unused state, before u_init() has been called.

This function may be used even when ICU has been built without multi-threaded support (see ICU_USE_THREADS pre-processor variable, umutex.h)

Parameters:
context  This pointer value will be saved, and then (later) passed as a parameter to the increment and decrement functions each time they are called. This function can only be called
inc  Pointer to a function to do an atomic increment operation. Must be non-null.
dec  Pointer to a function to do an atomic decrement operation. Must be non-null.
status  Receives error values.
Draft:
This API has been introduced in ICU 2.8 @system. It is still in draft state and may be modified in a future release.


Generated on Mon Nov 24 14:35:54 2003 for ICU 2.8 by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001