Remora.Discord.Gateway 12.0.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET 6.0 .NET Standard 2.1
dotnet add package Remora.Discord.Gateway --version 12.0.0
NuGet\Install-Package Remora.Discord.Gateway -Version 12.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Remora.Discord.Gateway" Version="12.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Remora.Discord.Gateway --version 12.0.0
#r "nuget: Remora.Discord.Gateway, 12.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Remora.Discord.Gateway as a Cake Addin
#addin nuget:?package=Remora.Discord.Gateway&version=12.0.0

// Install Remora.Discord.Gateway as a Cake Tool
#tool nuget:?package=Remora.Discord.Gateway&version=12.0.0

Remora.Discord.Gateway

This package provides a fully-featured implementation of a Discord gateway client, complete with resume capabilities and user-facing events.

Structure

The package consists of two main parts - the client itself, and the event dispatch system. The latter will be familiar to users of the mediator pattern, wherein an intermediate type handles communication between separate objects; in Remora.Discord.Gateway's case, all incoming Discord events are dispatched and executed concurrently with each other, and the user may register responders to handle these events.

Provided you yourself do not inject services with a shared mutable state, all responders are thread-safe and do not require additional synchronization through semaphores or mutexes.

The client is a singleton service by design.

Usage

First and foremost, the gateway client must be registered with your dependency injection container.

services.AddDiscordGateway(serviceProvider => GetTokenFromSomewhere(serviceProvider));

Two things to note:

  • You are not required to call any other methods from dependency libraries (such as Remora.Discord.API) - this call takes care of all transitive dependencies itself.
  • You must, at this point, provide a way to access your bot's token in plain text. This access only happens after the container is constructed, and an API instance is requested, so you have access to the built container.

After this point, you may inject the gateway client into your own services. In order to connect and start dispatching events, you must call RunAsync somewhere, and subsequently either await the task directly or store it for later use. This task represents the entire lifetime of the gateway client, and will run until you explicitly request its termination via the cancellation token passed to this method.

If you wish to explicitly send a gateway command (for example, to update presence information), you may do so via the SubmitCommand method on the client. Note that no validations are performed on this command, so you can cause unexpected termination of your session if the data is malformed or inappropriate for the current state of the client.

Responders - the types which react to and handle incoming events - are created by declaring a class that implements one or more instances of the IResponder<T> interface, and then registering these types with the service container.

public class MyResponder : IResponder<IMessageCreate>
{
    public async Task<Result> RespondAsync
    (
        IMessageCreate gatewayEvent,
        CancellationToken ct = default
    )
    {
        // ...
    }
}

...

services.AddResponder<MyResponder>();

There are no restrictions placed on how long an individual responder may run, but you should strive to keep it short in order to avoid thread pool exhaustion.

Responders have no guarantees related to sequential execution, but you are able to sort them into one of three "groups", which do run sequentially to one another.

services.AddResponder<MyResponder>(ResponderGroup.Early); // executes before...
services.AddResponder<MyResponder>(ResponderGroup.Normal); // executes before...
services.AddResponder<MyResponder>(ResponderGroup.Late);

This is useful in cases where two responders to the same event depend on each other in some way.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on Remora.Discord.Gateway:

Package Downloads
Remora.Discord.Commands The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Glue code for using Remora.Commands with Remora.Discord

Remora.Discord.Hosting The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Implementation of a hosted Discord gateway service for the .NET Generic Host

Remora.Discord.Interactivity The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Framework for using Discord's interaction-driven message components

Remora.Discord.Caching The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Caching implementations of Remora.Discord's services

Remora.Discord.Extensions The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Utilities and components which extend upon Remora.Discord's base resources

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
12.0.0 2,981 11/14/2023
11.1.0 26,895 7/24/2023
11.0.7 18,211 5/11/2023
11.0.6 1,848 3/20/2023
11.0.5 2,482 1/19/2023
11.0.4 1,839 1/10/2023
11.0.3 2,292 12/28/2022
11.0.2 4,114 12/10/2022
11.0.1 2,671 10/30/2022
11.0.0 19,203 9/2/2022
10.1.7 2,922 8/19/2022
10.1.6 2,797 7/28/2022
10.1.5 2,669 7/26/2022
10.1.4 2,474 7/26/2022
10.1.3 6,111 6/29/2022
10.1.2 2,553 6/27/2022
10.1.1 2,759 6/23/2022
10.1.0 3,438 6/20/2022
10.0.0 2,537 6/19/2022
9.0.0 2,573 6/18/2022
8.1.5 2,598 6/14/2022
8.1.4 2,567 6/8/2022
8.1.3 2,588 6/3/2022
8.1.2 2,590 5/25/2022
8.1.1 2,548 5/23/2022
8.1.0 2,751 5/15/2022
8.0.6 2,591 5/10/2022
8.0.5 4,547 5/3/2022
8.0.4 5,493 4/25/2022
8.0.3 3,243 4/18/2022
8.0.2 2,230 4/2/2022
8.0.1 3,950 4/2/2022
8.0.0 2,780 3/21/2022
7.2.0 2,572 3/17/2022
7.1.0 2,281 3/15/2022
7.0.1 3,574 2/20/2022
7.0.0 2,321 2/19/2022
7.0.0-rc1 543 2/14/2022
6.2.10 2,371 2/14/2022
6.2.9 2,633 1/27/2022
6.2.7 4,357 1/11/2022
6.2.6 34,775 1/2/2022
6.2.5 2,171 12/23/2021
6.2.4 934 12/21/2021
6.2.3 1,169 12/16/2021
6.2.2 1,016 12/11/2021
6.2.1 1,164 12/5/2021
6.2.0 2,773 11/26/2021
6.1.0 6,758 11/24/2021
6.0.0 2,014 11/20/2021
5.0.4 1,748 11/9/2021
5.0.3 1,471 11/6/2021
5.0.2 1,755 10/30/2021
5.0.1 1,222 10/28/2021
5.0.0 3,385 10/15/2021
4.0.15 1,775 10/7/2021
4.0.13 1,317 10/3/2021
4.0.12 1,160 10/2/2021
4.0.11 1,103 9/30/2021
4.0.10 1,661 9/26/2021
4.0.9 1,137 9/24/2021
4.0.8 1,177 9/23/2021
4.0.7 1,164 9/16/2021
4.0.6 1,237 9/15/2021
4.0.5 1,328 9/8/2021
4.0.4 2,471 9/4/2021
4.0.3 2,786 8/21/2021
4.0.2 1,337 8/18/2021
4.0.1 1,944 8/12/2021
4.0.0 975 8/11/2021
3.5.8 1,473 8/11/2021
3.5.7 1,407 8/2/2021
3.5.6 1,587 8/2/2021
3.5.5 1,665 7/31/2021
3.5.4 1,250 7/29/2021
3.5.3 1,172 7/28/2021
3.5.2 1,065 7/28/2021
3.5.1 1,500 7/22/2021
3.5.0 1,218 7/17/2021
3.4.6 1,153 7/14/2021
3.4.5 1,286 7/12/2021
3.4.4 1,205 7/11/2021
3.4.3 1,225 7/5/2021
3.4.2 1,093 7/3/2021
3.4.1 1,089 7/1/2021
3.4.0 1,391 6/14/2021
3.3.1 733 6/10/2021
3.3.1-beta2 583 5/30/2021
3.3.1-beta1 984 5/28/2021
3.3.0 1,070 5/23/2021
3.2.1 1,256 5/20/2021
3.2.0 1,508 5/4/2021
3.1.14 1,221 4/22/2021
3.1.13 1,169 4/15/2021
3.1.12 1,260 4/10/2021
3.1.11 1,362 4/5/2021
3.1.10 1,254 4/4/2021
3.1.9 1,828 3/28/2021
3.1.8 2,012 3/25/2021
3.1.7 1,013 3/25/2021
3.1.6 1,666 3/16/2021
3.1.5 1,182 3/14/2021
3.1.4 1,156 3/13/2021
3.1.3 1,199 3/11/2021
3.1.2 1,439 3/6/2021
3.1.1 1,235 3/1/2021
3.1.0 1,253 3/1/2021
3.0.7 1,319 2/28/2021
3.0.6 1,066 2/23/2021
3.0.5 1,595 2/22/2021
3.0.4 1,163 2/21/2021
3.0.3 919 2/16/2021
3.0.2 1,291 2/13/2021
3.0.1 1,496 2/11/2021
3.0.0 1,228 2/10/2021
2.2.3 1,017 2/6/2021
2.2.2 1,078 2/5/2021
2.2.1 1,027 1/29/2021
2.2.0 1,014 1/27/2021
2.1.1 1,298 1/21/2021
2.1.0 1,176 1/17/2021
2.0.1 1,120 1/10/2021
2.0.0 1,218 1/10/2021
1.1.2 1,144 1/9/2021
1.1.1 1,303 12/31/2020
1.1.0 1,176 12/27/2020
1.0.1 1,638 12/25/2020
1.0.0 1,019 12/25/2020
1.0.0-beta9 545 12/10/2020
1.0.0-beta8 570 11/26/2020
1.0.0-beta7 530 11/15/2020
1.0.0-beta6 553 11/14/2020
1.0.0-beta5 575 11/8/2020
1.0.0-beta4 385 11/8/2020
1.0.0-beta3 322 10/17/2020
1.0.0-beta2 335 10/6/2020
1.0.0-beta11 529 12/23/2020
1.0.0-beta10 544 12/18/2020
1.0.0-beta1 334 10/6/2020
1.0.0-alpha1 322 9/27/2020

Update dependencies.
           BREAKING: Allow storing async tokens.
           perf: Use pooled backing array for JSON Serialization.
           perf: Initialize reasonable starting buffer size.
           perf: Use ValueTask when possible.