F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

document the fact that it is impossible to unschedule event scheduled for the "destroy" time

Browse Source
This commit is contained in:
Mathieu Lacage
2006-09-06 14:51:50 +02:00
parent 0364386fa7
commit 501829319e
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/simulator/simulator.h
View File

@@ -556,6 +556,8 @@ public:
* ns3::Simulator::cancel method or the ns3::EventId::cancel method
* but its algorithmic complexity is much higher: it has often
* O(log(n)) complexity, sometimes O(n), sometimes worse.
* Note that it is not possible to remove events which were scheduled
* for the "destroy" time. Doing so will result in a program error (crash).
*
* @param id the event to remove from the list of scheduled events.
*/
@@ -567,12 +569,17 @@ public:
* ns3::Simulator::remove method but its algorithmic complexity is
* much lower: it has O(1) complexity.
* This method has the exact same semantics as ns3::EventId::cancel.
* Note that it is not possible to cancel events which were scheduled
* for the "destroy" time. Doing so will result in a program error (crash).
*
* @param id the event to cancel
*/
static void cancel (EventId id);
/**
* This method has O(1) complexity
* This method has O(1) complexity.
* Note that it is not possible to test for the expiration of
* events which were scheduled for the "destroy" time. Doing so
* will result in a program error (crash).
*
* @param id the event to test for expiration
* @returns true if the event has expired, false otherwise.