> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XTaskQueueDispatch

> XTaskQueueDispatch

# XTaskQueueDispatch

Processa um item na fila de tarefas para a porta especificada.

## Sintaxe

```cpp theme={null}
bool XTaskQueueDispatch(  
         XTaskQueueHandle queue,  
         XTaskQueuePort port,  
         uint32_t timeoutInMs  
)  
```

### Parâmetros

*queue*   \_In\_\
Tipo: XTaskQueueHandle

A fila na qual o trabalho será expedido.

*port*   \_In\_\
Tipo: [XTaskQueuePort](/pt-BR/reference/system/xtaskqueue/enums/xtaskqueueport)

A porta a ser expedida.

*timeoutInMs*   \_In\_\
Tipo: uint32\_t

O número de milissegundos a aguardar a chegada de trabalho antes de retornar false. Você pode passar **INFINITE** para aguardar indefinidamente.

### Valor retornado

Tipo: bool

Retorna true se esta função expediu uma chamada ou false caso contrário. Esta função também retornará false se a fila for encerrada, mesmo que **INFINITE** seja passado como tempo limite.

## Comentários

Você pode passar um tempo limite, o que fará com que **XTaskQueueDispatch** aguarde a chegada de algo na fila.

Se uma porta da fila de tarefas tiver sido criada com os modos de expedição [XTaskQueueDispatchMode::ThreadPool](/pt-BR/reference/system/xtaskqueue/enums/xtaskqueuedispatchmode), [XTaskQueueDispatchMode::SerializedThreadPool](/pt-BR/reference/system/xtaskqueue/enums/xtaskqueuedispatchmode) ou [XTaskQueueDispatchMode::Immediate](/pt-BR/reference/system/xtaskqueue/enums/xtaskqueuedispatchmode), ela expedirá os retornos de chamada automaticamente. Para portas de expedição manual, você precisa chamar **XTaskQueueDispatch**. **XTaskQueueDispatch** pode ser chamado para qualquer modo de expedição, mas observe que uma chamada é sempre expedida no thread que chama **XTaskQueueDispatch**.

<img src="https://mintcdn.com/microsoft-4404708b/gzrdvT5kpqAXKEQt/images/gdk/reference/note.gif?s=6c1a4c009b25ad5315c45ce51bc83983" alt="alert" width="10" height="10" data-path="images/gdk/reference/note.gif" /> **Observação de desempenho:**\
Adicionar um item a uma fila precisa ser livre de bloqueios e de esperas para atender aos requisitos de desempenho do código upstream. As seguintes APIs são livres de bloqueios:

* [XTaskQueueSubmitCallback](/pt-BR/reference/system/xtaskqueue/functions/xtaskqueuesubmitcallback)
* [XTaskQueueSubmitDelayedCallback](/pt-BR/reference/system/xtaskqueue/functions/xtaskqueuesubmitdelayedcallback)
* [XTaskQueueDispatch](/pt-BR/reference/system/xtaskqueue/functions/xtaskqueuedispatch), desde que 0 seja passado para *timeoutInMs*

<img src="https://mintcdn.com/microsoft-4404708b/gzrdvT5kpqAXKEQt/images/gdk/reference/note.gif?s=6c1a4c009b25ad5315c45ce51bc83983" alt="alert" width="10" height="10" data-path="images/gdk/reference/note.gif" /> **Observação de desempenho:**\
O tempo gasto por [XTaskQueueDispatch](/pt-BR/reference/system/xtaskqueue/functions/xtaskqueuedispatch) ao processar um item da porta de trabalho é variável e depende do trabalho que está sendo executado.
Em alguns casos, o thread de chamada pode ficar bloqueado aguardando a conclusão de outro trabalho do sistema.

O exemplo a seguir mostra como usar a função **XTaskQueueDispatch** para processar itens na fila de tarefas.

<Note>**SubmitCallback** é uma função auxiliar definida no exemplo de código da função [XTaskQueueSubmitCallback](/pt-BR/reference/system/xtaskqueue/functions/xtaskqueuesubmitcallback).</Note>

```cpp theme={null}
void CreatingTaskQueueWithManualThreads()
{
    // Create a manual task queue
    XTaskQueueHandle queue;
    HRESULT hr = XTaskQueueCreate(XTaskQueueDispatchMode::Manual, XTaskQueueDispatchMode::Manual, &queue);
    if (FAILED(hr))
    {
        printf("Creating queue failed: 0x%x\r\n", hr);
        return;
    }

    // We create threads to pump the queue: one for the work port
    // and one for the completion port.
    std::thread workThread([queue]
    {
        while (XTaskQueueDispatch(queue, XTaskQueuePort::Work, INFINITE));
    });

    std::thread completionThread([queue]
    {
        while (XTaskQueueDispatch(queue, XTaskQueuePort::Completion, INFINITE));
    });

    SubmitCallbacks(queue);

    // Wait a while for the callbacks to run
    Sleep(1000);

    // Terminating the queue will cause a waiting DispatchTaskQueue to return
    // false.  
    XTaskQueueTerminate(queue, true, nullptr, nullptr);

    workThread.join();
    completionThread.join();
}
```

## Requisitos

**Cabeçalho:** XTaskQueue.h

**Biblioteca:** xgameruntime.lib

**Plataformas compatíveis:** Windows, consoles da família XBOX One e consoles XBOX Series

## Documentação conceitual

* [Limpar a fila de tarefas](/pt-BR/build/core-features/common/async/async-libraries/async-library-xtaskqueue-example-cleanup-task-queue)
* [Expedir a fila de tarefas](/pt-BR/build/core-features/common/async/async-libraries/async-library-xtaskqueue-example-dispatch-task-queue)
* [Visão geral da biblioteca XTaskQueue](/pt-BR/build/core-features/common/async/async-libraries/async-library-xtaskqueue)
* [Modelo de programação assíncrona](/pt-BR/build/core-features/common/async/async-programming-model)
* [Metas de design e melhorias da programação assíncrona](/pt-BR/build/core-features/common/async/async-whitepaper)

## Confira também

[Membros de XTaskQueue](/pt-BR/reference/system/xtaskqueue/xtaskqueue_members)\
[Modelo de programação assíncrona](/pt-BR/build/core-features/common/async/async-programming-model)\
[Design da fila de tarefas assíncrona](/pt-BR/build/core-features/common/async/async-task-queue-design)


## Related topics

- [XTaskQueueDispatch](/reference/system/xtaskqueue/functions/xtaskqueuedispatch.md)
- [XTaskQueueDispatchMode](/reference/system/xtaskqueue/enums/xtaskqueuedispatchmode.md)