diff --git a/d1/d1b/trace_8h_source.html b/d1/d1b/trace_8h_source.html index b9e8dbe51..8f7ebf239 100644 --- a/d1/d1b/trace_8h_source.html +++ b/d1/d1b/trace_8h_source.html @@ -159,7 +159,7 @@
Data structures and functions used and defined in federate.c.
@@ -902,29 +900,6 @@
-
|
- -extern | -
Condition variable for blocking on tag advance in
- -Wait until physical time matches or exceeds the specified logical time, unless -fast is given. For decentralized coordination, this function will add the STA offset to the wait time.
-If an event is put on the event queue during the wait, then the wait is interrupted and this function returns false. It also returns false if the timeout time is reached before the wait has completed. Note this this could return true even if the a new event was placed on the queue if that event time matches or exceeds the specified time.
+ +Wait until physical time matches or exceeds the time of the specified tag.
+If -fast is given, there will be no wait.
+If an event is put on the event queue during the wait, then the wait is interrupted and this function returns false. It also returns false if the timeout time is reached before the wait has completed. Note this this could return true even if the a new event was placed on the queue. This will occur if that event time matches or exceeds the specified time.
The mutex lock associated with the condition argument is assumed to be held by the calling thread. This mutex is released while waiting. If the wait time is too small to actually wait (less than MIN_SLEEP_DURATION), then this function immediately returns true and the mutex is not released.
env | Environment within which we are executing. |
logical_time | Logical time to wait until physical time matches it. |
wait_until_time | The time to wait until physical time matches it. |
condition | A condition variable that can interrupt the wait. The mutex associated with this condition variable will be released during the wait. |
Wait until physical time matches or exceeds the specified logical time, unless -fast is given. For decentralized coordination, this function will add the STA offset to the wait time.
-If an event is put on the event queue during the wait, then the wait is interrupted and this function returns false. It also returns false if the timeout time is reached before the wait has completed. Note this this could return true even if the a new event was placed on the queue if that event time matches or exceeds the specified time.
+ +Wait until physical time matches or exceeds the time of the specified tag.
+If -fast is given, there will be no wait.
+If an event is put on the event queue during the wait, then the wait is interrupted and this function returns false. It also returns false if the timeout time is reached before the wait has completed. Note this this could return true even if the a new event was placed on the queue. This will occur if that event time matches or exceeds the specified time.
The mutex lock associated with the condition argument is assumed to be held by the calling thread. This mutex is released while waiting. If the wait time is too small to actually wait (less than MIN_SLEEP_DURATION), then this function immediately returns true and the mutex is not released.
env | Environment within which we are executing. |
logical_time | Logical time to wait until physical time matches it. |
wait_until_time | The time to wait until physical time matches it. |
condition | A condition variable that can interrupt the wait. The mutex associated with this condition variable will be released during the wait. |
where bigger_tag > smaller_tag
. This function is primarily used for network communication (which is assumed to be in order).
This function assumes the caller holds the mutex lock.
where bigger_tag > smaller_tag
. This function is primarily used for network communication (which is assumed to be in order).
This function assumes the caller holds the mutex lock.