====== OSA : OS_Flag_Wait_On_TO ======
<color blue>**OS_Flag_Wait_On_TO (flags, mask, timeout)**</color>\\ 
=== ===

{{osa:ref:attr_call_task.png|Allowed only in task}}{{osa:ref:attr_call_ct_sw.png|Switches context}}{{osa:ref:attr_call_to.png|Uses timer}}

Wait for any //mask// bits in //flags// to be set. If timeout expires before event occurs, then stop waiting with Timeout flag set (see ##[[en:osa:ref:allservices:OS_IsTimeout|OS_IsTimeout]]##)


=== Call allowed: ===
Only in task


=== Parameters: ===
{| class = "fpl"
|-
|//''flags''//
|Variable of ##[[en:osa:ref:description:data types#OST_FLAG|OST_FLAGx]]## (x = 8, 16, 32) type
|-
|//''mask''//
|Bit mask to operate on
|-
|//''timeout''//
|Time of waiting in system ticks - calling ##[[en:osa:ref:allservices:OS_Timer|OS_Timer]]## periods
|}


=== Returns: ===
{| class = "fpl"
|-
|//''timeout''//
|If timeout expired then system service ##[[en:osa:ref:allservices:OS_IsTimeout|OS_IsTimeout]]## will return **true**
|}


=== Example: ===
<code cpp>
OST_FLAG flag;

void Task (void)
{
    for (;;) {
        /*...*/
        OS_Flag_Wait_On_TO (flag, 0x06, 10);  // wait 10 ticks bit 1 or 2 to be set
        if (!OS_IsTimeout()) {
            //
            /*...*/
        }
        /*...*/
    }
}
</code>


=== Old style name ===
<color gray>**OS_WaitAnyFlagTimeout**</color>\\ 


<color gray>**OS_Flag_Wait_On**</color>\\ 





=== See also ===
  * [[en:osa:ref:allservices:OS_Flag_Create|OS_Flag_Create]]
  * [[en:osa:ref:allservices:OS_Flag_Init|OS_Flag_Init]]

  * [[en:osa:ref:allservices:OS_Flag_Set|OS_Flag_Set]]
  * [[en:osa:ref:allservices:OS_Flag_Clear|OS_Flag_Clear]]

  * [[en:osa:ref:allservices:OS_Flag_Check_AllOn|OS_Flag_Check_AllOn]]
  * [[en:osa:ref:allservices:OS_Flag_Check_On|OS_Flag_Check_On]]
  * [[en:osa:ref:allservices:OS_Flag_Check_AllOff|OS_Flag_Check_AllOff]]
  * [[en:osa:ref:allservices:OS_Flag_Check_Off|OS_Flag_Check_Off]]

  * [[en:osa:ref:allservices:OS_Flag_Wait_AllOn|OS_Flag_Wait_AllOn]]
  * [[en:osa:ref:allservices:OS_Flag_Wait_On|OS_Flag_Wait_On]]
  * [[en:osa:ref:allservices:OS_Flag_Wait_AllOff|OS_Flag_Wait_AllOff]]
  * [[en:osa:ref:allservices:OS_Flag_Wait_Off|OS_Flag_Wait_Off]]

  * [[en:osa:ref:allservices:OS_Flag_Wait_AllOn_TO|OS_Flag_Wait_AllOn_TO]]
  * [[en:osa:ref:allservices:OS_Flag_Wait_AllOff_TO|OS_Flag_Wait_AllOff_TO]]
  * [[en:osa:ref:allservices:OS_Flag_Wait_Off_TO|OS_Flag_Wait_Off_TO]]

----
  * [[en:osa:ref:services:alphabetical|Alphabetical]]
  * [[en:osa:ref:services:brieflist|All services]]
~~UP~~