RUndertaker Class Reference

#include <e32std.h>

class RUndertaker : public RHandleBase

Inherits from

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.

Member Function Documentation

Create ( )

IMPORT_C TIntCreate()

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.

Return Value
KErrNone, if successful; otherwise one of the other system-wide error codes.

Logon ( TRequestStatus &, TInt & )

IMPORT_C TIntLogon(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:

{
RThread r;
r.SetHandle(aThreadHandle);
...r.Close();
}

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.

See also: RUndertaker::LogonCancel()

Parameters
aStatusA reference to the request status object.
aThreadHandleThe handle-number representing the dying thread.
Return Value
KErrInUse if there is an outstanding request; KErrNone otherwise.

LogonCancel ( )

IMPORT_C TIntLogonCancel()const

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

See also: RUndertaker::Logon()

Return Value
KErrGeneral, if there is no outstanding notification request; KErrNone otherwise.