Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
Loading...
Searching...
No Matches
RUndertaker Class Reference

Handle to a thread death notifier. More...

#include <e32std.h>

Inheritance diagram for RUndertaker:
RHandleBase

Public Member Functions

IMPORT_C TInt Create ()
 Creates a thread-death notifier, and opens this handle to that thread-death notifier.
 
IMPORT_C TInt Logon (TRequestStatus &aStatus, TInt &aThreadHandle) const
 Issues a request for notification of the death of a thread.
 
IMPORT_C TInt LogonCancel () const
 Cancels an outstanding notification request to the thread-death notifier.
 
- Public Member Functions inherited from RHandleBase
 RHandleBase ()
 Default constructor.
 
TInt Handle () const
 Retrieves the handle-number of the object associated with this handle.
 
void SetHandle (TInt aHandle)
 Sets the handle-number of this handle to the specified value.
 
TInt SetReturnedHandle (TInt aHandleOrError)
 Sets the handle-number of this handle to the specified value.
 
IMPORT_C void Close ()
 Closes the handle.
 
IMPORT_C TName Name () const
 Gets the name of the handle.
 
IMPORT_C TFullName FullName () const
 Gets the full name of the handle.
 
IMPORT_C void FullName (TDes &aName) const
 Gets the full name of the handle.
 
IMPORT_C void SetHandleNC (TInt aHandle)
 Sets the handle-number of this handle to the specified value, and marks it as not closable.
 
IMPORT_C TInt Duplicate (const RThread &aSrc, TOwnerType aType=EOwnerProcess)
 Creates a valid handle to the kernel object for which the specified thread already has a handle.
 
IMPORT_C void HandleInfo (THandleInfo *anInfo)
 Gets information about the handle.
 
IMPORT_C TUint Attributes () const
 
IMPORT_C TInt BTraceId () const
 Returns a unique object identifier for use with BTrace.
 
IMPORT_C void NotifyDestruction (TRequestStatus &aStatus)
 Internal technology API.
 

Additional Inherited Members

- Public Types inherited from RHandleBase
enum  TAttributes { EReadAccess =0x1 , EWriteAccess =0x2 , EDirectReadAccess =0x4 , EDirectWriteAccess =0x8 }
 Read/Write attributes for the handle. More...
 
- Static Public Member Functions inherited from RHandleBase
static void DoExtendedClose ()
 
- Protected Member Functions inherited from RHandleBase
 RHandleBase (TInt aHandle)
 Copy constructor.
 
IMPORT_C TInt Open (const TFindHandleBase &aHandle, TOwnerType aType)
 Opens a handle to a kernel side object found using a find-handle object.
 
TInt OpenByName (const TDesC &aName, TOwnerType aOwnerType, TInt aObjectType)
 Implementation for RXxxxx::Open/OpenGlocbal(const TDesC &aName,,TOwnerType aType) functions.
 
- Static Protected Member Functions inherited from RHandleBase
static TInt SetReturnedHandle (TInt aHandleOrError, RHandleBase &aHandle)
 
- Protected Attributes inherited from RHandleBase
TInt iHandle
 

Detailed Description

Handle to a thread death notifier.

The notifier allows threads to be notified of the death of another thread.

The thread-death notifier itself is a kernel object.

API status
Published to all clients. Released API.

Definition at line 4851 of file e32std.h.

Member Function Documentation

◆ Create()

IMPORT_C TInt RUndertaker::Create ( )

Creates a thread-death notifier, and opens this handle to that thread-death notifier.

Ownership of this thread-death notifier is vested in the current process.

(generated from Symbian Developer Library)

◆ Logon()

IMPORT_C TInt RUndertaker::Logon ( TRequestStatus &  aStatus,
TInt &  aThreadHandle 
) const

Issues a request for notification of the death of a thread.

When another thread dies, the request completes and the TRequestStatus object contains the value KErrDied; in addition, aThreadHandle contains the handle-number of the dying thread.

The requesting thread can construct a proper handle for the dying thread using the code:

{
r.SetHandle(aThreadHandle);
... r.Close();
}
void SetHandle(TInt aHandle)
Sets the handle-number of this handle to the specified value.
IMPORT_C void Close()
Closes the handle.
A handle to a thread.
Definition e32std.h:4091

Alternatively, if an outstanding request is cancelled by a call to LogonCancel(), then the request completes with the value KErrCancel.

Note that if a request completes normally, i.e. not as a result of a LogonCancel(), then the handle to the dying thread must be closed when there is no further interest in it.

RUndertaker::LogonCancel()

Parameters
aStatusA reference to the request status object.
aThreadHandleThe handle-number representing the dying thread.

(generated from Symbian Developer Library)

◆ LogonCancel()

IMPORT_C TInt RUndertaker::LogonCancel ( ) const

Cancels an outstanding notification request to the thread-death notifier.

RUndertaker::Logon()

(generated from Symbian Developer Library)


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