Improving comments on panics generated by CActive::SetActive. Patch slightly altered based on comments by John Imhofe.
authorAdrian Taylor <adrian@macrobug.com>
Tue, 10 Nov 2009 20:10:34 +0000
changeset 13 cb3e90eb7d89
parent 0 a41df078684a
child 14 a9b43c4f7bfe
child 30 9947e075979d
Improving comments on panics generated by CActive::SetActive. Patch slightly altered based on comments by John Imhofe.
kernel/eka/euser/cbase/ub_act.cpp
--- a/kernel/eka/euser/cbase/ub_act.cpp	Mon Oct 19 15:55:17 2009 +0100
+++ b/kernel/eka/euser/cbase/ub_act.cpp	Tue Nov 10 20:10:34 2009 +0000
@@ -137,9 +137,20 @@
 
 2. the active object within the implementation of the Cancel() function.
 
+E32USER-CBase 46 panics may occur if an active object is set active but
+no request is made on its TRequestStatus, or vice-versa. This panic happens
+no earlier than the next time that the active scheduler assesses which
+objects are ready to run, and may happen much later. This panic is termed 
+a 'stray event' because it indicates that some entity has sent an event 
+to this thread, but this thread is not in a state ready to handle it.
+
 @see CActive::IsActive
 @see CActive::RunL
 @see CActive::Cancel
+
+@panic E32USER-CBase 42 if this active object is already active
+@panic E32USER-CBase 49 if this active object has not been added to the active
+       scheduler.
 */
 	{
 	__ASSERT_ALWAYS(!(iStatus.iFlags&TRequestStatus::EActive),Panic(EReqAlreadyActive));