Class CObjectIx

class CObjectIx : public CBase;

Description

Generates handle numbers for reference counting objects.

This is referred to as an object index.

Adding a reference counting object to an object index is the way in which a unique handle number can be generated for that object. A handle number is the way in which an object, which is owned or managed by another thread or process can be identified.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CObjectIx - Generates handle numbers for reference counting objects.

Members

Defined in CObjectIx:

• ActiveCount()constGets the current number of reference counting objects held by this object index.
• AddL(CObject *)Adds the specified reference counting object into this object index and returns ...
• At(TInt)Gets a pointer to the reference counting object with the specified handle number...
• At(TInt,TInt)Gets a pointer to the reference counting object with the specified handle number...
• At(const CObject *)constConstructs and returns the handle number representing the specified reference co...
• AtL(TInt)Gets a pointer to the reference counting object with the specified handle number...
• AtL(TInt,TInt)Gets a pointer to the reference counting object with the specified handle number...
• CObjectIx()Default constructor.
• Count()constGets the number greater then the last slot number used to hold valid CObject poi...
• Count(CObject *)constGets the number of occurrences of the specified reference counting object within...
• ELocalHandleWhen ORed into the handle number, indicates that the handle is a local handle.
• ENoCloseWhen ORd into the handle number, indicates that the reference counting object ca...
• NewL()Creates a new object index.
• Remove(TInt)Removes the reference counting object identified by handle number from this obje...
• anonymous
• operator[](TInt)Gets a pointer to a reference counting object located at the specified offset wi...
• ~CObjectIx()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CObjectIx* NewL();

Description

Creates a new object index.

Return value

IMPORT_C ~CObjectIx();

Description

Destructor.

Frees all resources owned by the object index, prior to its destruction. In particular, it calls Close() on all reference counting objects in the index.

See also:

• CObject::Close()Closes this reference counting object.

protected: IMPORT_C CObjectIx();

Description

Default constructor.

IMPORT_C TInt AddL(CObject *anObj);

Description

Adds the specified reference counting object into this object index and returns the handle number that represents it.

Parameters

Return value

IMPORT_C void Remove(TInt aHandle);

Description

Removes the reference counting object identified by handle number from this object index and closes it.

If the reference counting object cannot be closed, because CObjectIx::ENoClose is ORed into the handle number, then it is neither removed from the object index nor closed.

Parameters

Panic codes

IMPORT_C CObject* At(TInt aHandle, TInt aUniqueID);

Description

Gets a pointer to the reference counting object with the specified handle number and matching unique ID.

Parameters

Return value

IMPORT_C CObject* At(TInt aHandle);

Description

Gets a pointer to the reference counting object with the specified handle number.

Parameters

Return value

IMPORT_C CObject* AtL(TInt aHandle, TInt aUniqueID);

Description

Gets a pointer to the reference counting object with the specified handle number and matching unique ID.

Parameters

Return value

Leave codes

IMPORT_C CObject* AtL(TInt aHandle);

Description

Gets a pointer to the reference counting object with the specified handle number.

Parameters

Return value

Leave codes

IMPORT_C TInt At(const CObject *anObject) const;

Description

Constructs and returns the handle number representing the specified reference counting object within this object index.

Parameters

Return value

IMPORT_C TInt Count(CObject *anObject) const;

Description

Gets the number of occurrences of the specified reference counting object within this object index.

Note that the same reference counting object can be added to an object index more than once.

Parameters

Return value

IMPORT_C CObject* operator[](TInt anIndex);

Description

Gets a pointer to a reference counting object located at the specified offset within the object index.

Parameters

Return value

Panic codes

inline TInt Count() const;

Description

Gets the number greater then the last slot number used to hold valid CObject pointer. The input argument of CObject* CObjectIx::operator[](TInt) must be less then the number returned by this method.

Return value

See also:

• CObjectIx::ActiveCount()constGets the current number of reference counting objects held by this object index.

inline TInt ActiveCount() const;

Description

Gets the current number of reference counting objects held by this object index.

Return value

n/a

Description