====== OSA : OS_Squeue_Wait_TO ======
<color blue>**OS_Squeue_Wait_TO (squeue, os_smsg_type_var, timeout)**</color>\\ 
=== ===

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

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

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


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


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


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


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

void Task (void)
{
    OST_SMSG data;
    for (;;) {
        /*...*/
        // В течение 100 системных тиков ждем короткое сообщение
        OS_Squeue_Wait_TO (squeue, data, 100);
        if (!OS_IsTimeout()) {
            // Приняли сообщение, обрабатываем его
            switch (data) {
            /*...*/
            }
        }
        /*...*/
    }
}
</code>


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










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

  * [[osa:ref:allservices:OS_Squeue_Send|OS_Squeue_Send]]
  * [[osa:ref:allservices:OS_Squeue_Send_TO|OS_Squeue_Send_TO]]
  * [[osa:ref:allservices:OS_Squeue_Send_Now|OS_Squeue_Send_Now]]


  * [[osa:ref:allservices:OS_Squeue_Check|OS_Squeue_Check]]
  * [[osa:ref:allservices:OS_Squeue_IsFull|OS_Squeue_IsFull]]

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

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