====== OSA : OS_Queue_Wait_TO ======
<color blue>**OS_Queue_Wait_TO (queue, os_msg_type_var, timeout)**</color>\\ 
=== ===

{{osa:ref:attr_call_task.png|Разрешен вызов только в контексте задачи}}{{osa:ref:attr_call_ct_sw.png|Переключает контекст}}{{osa:ref:attr_call_to.png|Сервис использует таймаут}}

Ожидаем сообщение из очереди втечение заданного времени. Если так и не дождались, то выходим из ожидания по таймауту.

Для использования очередей сообщений в файле ##[[osa:ref:appendix:configuration|OSAcfg.h]]## должна быть определена константа ##[[osa:ref:appendix:configuration#Системные константы|OS_ENABLE_QUEUE]]##.
<note>
Для PIC16 переменная queue может размещаться в памяти только в **bank0** или **bank1**
</note>


=== Разрешен вызов: ===
Только из задачи


=== Параметры функции: ===
{| class = "fpl"
|-
|//''queue''//
|Дескриптор очереди сообщений. Переменная типа ##[[osa:ref:description:data_types|OST_QUEUE]]##.
|-
|//''os_msg_type_var''//
|Переменная типа ##[[osa:ref:description:data_types#OST_MSG|OST_MSG]]##; в нее будет помещен указатель на сообщение
|-
|//''timeout''//
|Время ожидания. Задается в системных тиках - периодах вызова сервиса ##[[osa:ref:allservices:OS_Timer|OS_Timer]]##
|}


=== Возвращаемое значение: ===
{| class = "fpl"
|-
|//''таймаут''//
|Если вышли из ожидания по таймауту, то сервис ##[[osa:ref:allservices:OS_IsTimeout|OS_IsTimeout]]## возвратит **true**
|}


=== Пример вызова: ===
<code cpp>
OST_QUEUE queue;

void Task (void)
{
    char *Data;
    for (;;) {
        /*...*/
        // В течение 100 тиков ждем сообщение из очереди
        OS_Queue_Wait_TO (queue, Data, 100);
        if (!OS_IsTimeout()) {
            // Если дождались, то обрабатываем его
            /*...*/
        }
        /*...*/
    }
}
</code>


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









=== См. также ===
  * [[osa:ref:allservices:OS_Queue_Create|OS_Queue_Create]]

  * [[osa:ref:allservices:OS_Queue_Send|OS_Queue_Send]]
  * [[osa:ref:allservices:OS_Queue_Send_TO|OS_Queue_Send_TO]]
  * [[osa:ref:allservices:OS_Queue_Send_Now|OS_Queue_Send_Now]]


  * [[osa:ref:allservices:OS_Queue_Check|OS_Queue_Check]]
  * [[osa:ref:allservices:OS_Queue_IsFull|OS_Queue_IsFull]]

  * [[osa:ref:allservices:OS_Queue_Wait|OS_Queue_Wait]]

----
  * [[osa:ref:services:alphabetical|Алфавитный указатель]]
  * [[osa:ref:services:brieflist|Все сервисы]]
~~UP~~