The C# .NET SDK currently only supports legacy versions of Nitric prior to v1. This version is maintained for compatibility with existing projects and not recommended for new projects. New projects should be started using a supported SDK (presented automatically using the `nitric new` command) orget in touch to request an update to the latest version.

.NET - Queue()

Creates a new Queue to send and receive asynchronous tasks.

using Nitric.Sdk;
using Nitric.Sdk.Queue;

class UserRequest
{
    public string UserId { get; set; }
    public string Message { get; set; }
}

var batchQueue = Nitric.Queue<UserRequest>("batchQueue").With(QueuePermission.Writing);

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 code needs to the resource. See here for details Access Control documentation.

Available permissions:

QueuePermission.Sending

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

QueuePermission.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

using Nitric.Sdk;
using Nitric.Sdk.Queue;

class UserRequest
{
    public string UserId { get; set; }
    public string Message { get; set; }
}

var batchQueue = Nitric.Queue<UserRequest>("batchQueue");

Nitric.Run();

Receive tasks from a queue

using Nitric.Sdk;
using Nitric.Sdk.Queue;

class UserRequest
{
    public string UserId { get; set; }
    public string Message { get; set; }
}

var batchQueue = Nitric.Queue<UserRequest>("batchQueue").With(QueuePermission.Reading);

var tasks = batchQueue.Receive();

Nitric.Run();

See also