|
WaitSetWait Method (ICollectionCondition, Duration)
|
This operation allows an application thread to wait for the occurrence of certain conditions. If none of the conditions attached
to the
WaitSet have a
TriggerValue of
, the wait operation will block suspending the calling thread.
Namespace:
OpenDDSharp.DDS
Assembly:
OpenDDSharp (in OpenDDSharp.dll) Version: 0.5.0.0
Syntax public ReturnCode Wait(
ICollection<Condition> activeConditions,
Duration timeout
)
Public Function Wait (
activeConditions As ICollection(Of Condition),
timeout As Duration
) As ReturnCode
public:
ReturnCode Wait(
ICollection<Condition^>^ activeConditions,
Duration timeout
)
member Wait :
activeConditions : ICollection<Condition> *
timeout : Duration -> ReturnCode
Parameters
- activeConditions
- Type: System.Collections.GenericICollectionCondition
The collection of Conditions with the TriggerValue equals when the thread is unblocked.
- timeout
- Type: OpenDDSharp.DDSDuration
Maximum duration for the wait.
Return Value
Type:
ReturnCodeThe
ReturnCode that indicates the operation result.
Remarks It is not allowed for more than one application thread to be waiting on the same WaitSet. If the wait operation is invoked on a
WaitSet that already has a thread blocking on it, the operation will return immediately with the value PreconditionNotMet.
The wait operation takes a timeout argument that specifies the maximum duration for the wait. It this duration is exceeded and
none of the attached Condition objects is , wait will return with the return code Timeout.
See Also