Note: You are viewing documentation for version v0 of Python. View the latest version.

Python - queue()

Creates a new Queue to send and receive asynchronous tasks.

from nitric.resources import queue
from nitric.application import Nitric

batch_queue = queue('batch').allow('sending')

Nitric.run()

Parameters

  • Name
    name
    Required
    Required
    Type
    string
    Description

    The unique name of this Queue within the app. Subsequent calls to queue with the same name will return the same object.

Access

All Nitric resources provide access permissions you can use to specify the level of access your service needs to the resource. See here for details Access Control documentation.

Available permissions:

sending

This permission allows your code to send new tasks to the queue.

receiving

This permission allows your code to receive tasks from the queue.

Notes

In most instances code should either send to or receive from a queue, usually not both.

Examples

Create a Queue

from nitric.resources import queue
from nitric.application import Nitric

batch_queue = queue('batch').allow('sending')

Nitric.run()

Send tasks to a queue

from nitric.resources import queue
from nitric.application import Nitric
from nitric.api import Task

batch_queue = queue('batch').allow('sending')

payload = {}
await batch_queue.send(payload)

Nitric.run()

Receive tasks from a queue

from nitric.resources import queue
from nitric.application import Nitric

payload = {}
batch_queue = queue('batch').allow('receiving')

tasks = await batch_queue.receive(10)

Nitric.run()