Add SendDatagram and SendDatagramAsync to VoiceClient (#373)

* payload -> message for websocket

* Add SendDatagram and SendDatagramAsync to VoiceClient

* Normalize naming

Author: KubaZ2

Hosting/NetCord.Hosting/Gateway/GatewayClientOptions.cs

@@ -31,8 +31,8 @@ internal partial class Validator : IValidateOptions<GatewayClientOptions>
     /// <inheritdoc cref="GatewayClientConfiguration.RateLimiterProvider" />
     public IRateLimiterProvider? RateLimiterProvider { get; set; }
 
-    /// <inheritdoc cref="GatewayClientConfiguration.DefaultPayloadProperties" />
-    public WebSocketPayloadProperties? DefaultPayloadProperties { get; set; }
+    /// <inheritdoc cref="GatewayClientConfiguration.DefaultMessageProperties" />
+    public WebSocketMessageProperties? DefaultMessageProperties { get; set; }
 
     /// <inheritdoc cref="GatewayClientConfiguration.ReconnectStrategy" />
     public IReconnectStrategy? ReconnectStrategy { get; set; }
@@ -74,7 +74,7 @@ internal GatewayClientConfiguration CreateConfiguration(IServiceProvider service
     {
         return GatewayClientConfigurationFactory.Create(WebSocketConnectionProvider,
                                                         RateLimiterProvider,
-                                                        DefaultPayloadProperties,
+                                                        DefaultMessageProperties,
                                                         ReconnectStrategy,
                                                         LatencyTimer,
                                                         Version,

Hosting/NetCord.Hosting/Gateway/ShardedGatewayClientOptions.cs

@@ -34,8 +34,8 @@ internal partial class Validator : IValidateOptions<ShardedGatewayClientOptions>
     /// <inheritdoc cref="ShardedGatewayClientConfiguration.RateLimiterProviderFactory" />
     public Func<Shard, IRateLimiterProvider?>? RateLimiterProviderFactory { get; set; }
 
-    /// <inheritdoc cref="ShardedGatewayClientConfiguration.DefaultPayloadPropertiesFactory" />
-    public Func<Shard, WebSocketPayloadProperties?>? DefaultPayloadPropertiesFactory { get; set; }
+    /// <inheritdoc cref="ShardedGatewayClientConfiguration.DefaultMessagePropertiesFactory" />
+    public Func<Shard, WebSocketMessageProperties?>? DefaultMessagePropertiesFactory { get; set; }
 
     /// <inheritdoc cref="ShardedGatewayClientConfiguration.ReconnectStrategyFactory" />
     public Func<Shard, IReconnectStrategy?>? ReconnectStrategyFactory { get; set; }
@@ -87,8 +87,8 @@ internal partial class Validator : IValidateOptions<ShardedGatewayClientOptions>
     /// <inheritdoc cref="ShardedGatewayClientConfiguration.RateLimiterProviderFactory" />
     public IRateLimiterProvider? RateLimiterProvider { get; set; }
 
-    /// <inheritdoc cref="ShardedGatewayClientConfiguration.DefaultPayloadPropertiesFactory" />
-    public WebSocketPayloadProperties? DefaultPayloadProperties { get; set; }
+    /// <inheritdoc cref="ShardedGatewayClientConfiguration.DefaultMessagePropertiesFactory" />
+    public WebSocketMessageProperties? DefaultMessageProperties { get; set; }
 
     /// <inheritdoc cref="ShardedGatewayClientConfiguration.ReconnectStrategyFactory" />
     public IReconnectStrategy? ReconnectStrategy { get; set; }
@@ -121,7 +121,7 @@ internal ShardedGatewayClientConfiguration CreateConfiguration(IServiceProvider
     {
         return ShardedGatewayClientConfigurationFactory.Create(CreateFactory(WebSocketConnectionProvider, WebSocketConnectionProviderFactory),
                                                                CreateFactory(RateLimiterProvider, RateLimiterProviderFactory),
-                                                               CreateFactory(DefaultPayloadProperties, DefaultPayloadPropertiesFactory),
+                                                               CreateFactory(DefaultMessageProperties, DefaultMessagePropertiesFactory),
                                                                CreateFactory(ReconnectStrategy, ReconnectStrategyFactory),
                                                                CreateFactory(LatencyTimer, LatencyTimerFactory),
                                                                CreateFactory(Version, VersionFactory),

NetCord/Gateway/GatewayClient.cs

@@ -382,7 +382,7 @@ public sealed partial class GatewayClient : WebSocketClient, IEntity
     public partial event Func<GuildUser, ValueTask>? GuildUserUpdate;
 
     /// <summary>
-    /// Sent in response to <see cref="RequestGuildUsersAsync(GuildUsersRequestProperties, WebSocketPayloadProperties, CancellationToken)"/>. You can use the <see cref="GuildUserChunkEventArgs.ChunkIndex"/> and <see cref="GuildUserChunkEventArgs.ChunkCount"/> to calculate how many chunks are left for your request.<br/>
+    /// Sent in response to <see cref="RequestGuildUsersAsync(GuildUsersRequestProperties, WebSocketMessageProperties, CancellationToken)"/>. You can use the <see cref="GuildUserChunkEventArgs.ChunkIndex"/> and <see cref="GuildUserChunkEventArgs.ChunkCount"/> to calculate how many chunks are left for your request.<br/>
     /// </summary>
     /// <remarks>
     /// <br/> Required Intents: None
@@ -896,7 +896,7 @@ private protected override void OnConnected()
 
     private ValueTask SendIdentifyAsync(ConnectionState connectionState, PresenceProperties? presence = null, CancellationToken cancellationToken = default)
     {
-        GatewayPayloadProperties<GatewayIdentifyProperties> payload = new(GatewayOpcode.Identify, new(Token.RawToken)
+        GatewayMessageProperties<GatewayIdentifyProperties> message = new(GatewayOpcode.Identify, new(Token.RawToken)
         {
             ConnectionProperties = _connectionProperties,
             LargeThreshold = _largeThreshold,
@@ -907,7 +907,7 @@ private ValueTask SendIdentifyAsync(ConnectionState connectionState, PresencePro
 
         _latencyTimer.Start();
 
-        return SendConnectionObjectAsync(connectionState, payload, Serialization.Default.GatewayPayloadPropertiesGatewayIdentifyProperties, _internalTextPayloadProperties, cancellationToken);
+        return SendConnectionObjectAsync(connectionState, message, Serialization.Default.GatewayMessagePropertiesGatewayIdentifyProperties, _internalTextMessageProperties, cancellationToken);
     }
 
     /// <summary>
@@ -926,7 +926,7 @@ public async ValueTask StartAsync(PresenceProperties? presence = null, Cancellat
     /// Resumes the session specified by <paramref name="sessionId"/>.
     /// </summary>
     /// <param name="sessionId">The session to resume.</param>
-    /// <param name="sequenceNumber">The sequence number of the payload to resume from.</param>
+    /// <param name="sequenceNumber">The sequence number of the message to resume from.</param>
     /// <param name="cancellationToken">The cancellation token to cancel the operation.</param>
     /// <returns></returns>
     public async ValueTask ResumeAsync(string sessionId, int sequenceNumber, CancellationToken cancellationToken = default)
@@ -950,48 +950,48 @@ private protected override ValueTask TryResumeAsync(ConnectionState connectionSt
 
     private ValueTask TryResumeAsync(ConnectionState connectionState, string sessionId, int sequenceNumber, CancellationToken cancellationToken = default)
     {
-        GatewayPayloadProperties<GatewayResumeProperties> payload = new(GatewayOpcode.Resume, new(Token.RawToken, sessionId, sequenceNumber));
+        GatewayMessageProperties<GatewayResumeProperties> message = new(GatewayOpcode.Resume, new(Token.RawToken, sessionId, sequenceNumber));
 
         _latencyTimer.Start();
 
-        return SendConnectionObjectAsync(connectionState, payload, Serialization.Default.GatewayPayloadPropertiesGatewayResumeProperties, _internalTextPayloadProperties, cancellationToken);
+        return SendConnectionObjectAsync(connectionState, message, Serialization.Default.GatewayMessagePropertiesGatewayResumeProperties, _internalTextMessageProperties, cancellationToken);
     }
 
     private protected override ValueTask HeartbeatAsync(ConnectionState connectionState, CancellationToken cancellationToken = default)
     {
-        GatewayPayloadProperties<int> payload = new(GatewayOpcode.Heartbeat, SequenceNumber);
+        GatewayMessageProperties<int> message = new(GatewayOpcode.Heartbeat, SequenceNumber);
 
         _latencyTimer.Start();
 
-        return SendConnectionObjectAsync(connectionState, payload, Serialization.Default.GatewayPayloadPropertiesInt32, _internalTextPayloadProperties, cancellationToken);
+        return SendConnectionObjectAsync(connectionState, message, Serialization.Default.GatewayMessagePropertiesInt32, _internalTextMessageProperties, cancellationToken);
     }
 
-    private protected override ValueTask ProcessPayloadAsync(State state, ConnectionState connectionState, WebSocketMessageType messageType, ReadOnlySpan<byte> payload)
+    private protected override ValueTask ProcessMessageAsync(State state, ConnectionState connectionState, WebSocketMessageType messageType, ReadOnlySpan<byte> message)
     {
-        var rawPayload = _compression.Decompress(payload);
-        var jsonPayload = JsonSerializer.Deserialize(rawPayload, Serialization.Default.JsonGatewayPayload)!;
-        return HandlePayloadAsync(state, connectionState, jsonPayload);
+        var rawMessage = _compression.Decompress(message);
+        var jsonMessage = JsonSerializer.Deserialize(rawMessage, Serialization.Default.JsonGatewayMessage)!;
+        return HandleMessageAsync(state, connectionState, jsonMessage);
     }
 
-    private async ValueTask HandlePayloadAsync(State state, ConnectionState connectionState, JsonGatewayPayload payload)
+    private async ValueTask HandleMessageAsync(State state, ConnectionState connectionState, JsonGatewayMessage message)
     {
-        switch (payload.Opcode)
+        switch (message.Opcode)
         {
             case GatewayOpcode.Dispatch:
-                SequenceNumber = payload.SequenceNumber.GetValueOrDefault();
+                SequenceNumber = message.SequenceNumber.GetValueOrDefault();
 
-                Log(LogLevel.Debug, payload, null, static (s, e) =>
+                Log(LogLevel.Debug, message, null, static (s, e) =>
                 {
                     return $"'{s.Event}' event received.";
                 });
 
                 try
                 {
-                    await ProcessEventAsync(state, connectionState, payload).ConfigureAwait(false);
+                    await ProcessEventAsync(state, connectionState, message).ConfigureAwait(false);
                 }
                 catch (Exception ex)
                 {
-                    Log(LogLevel.Error, payload, ex, static (s, e) =>
+                    Log(LogLevel.Error, message, ex, static (s, e) =>
                     {
                         return $"An error occurred while processing '{s.Event}' event.{Environment.NewLine}{e}";
                     });
@@ -1015,14 +1015,14 @@ private async ValueTask HandlePayloadAsync(State state, ConnectionState connecti
                 {
                     Log<object?>(LogLevel.Error, null, ex, static (s, e) =>
                     {
-                        return $"An error occurred while sending the identify payload.{Environment.NewLine}{e}";
+                        return $"An error occurred while sending the identify message.{Environment.NewLine}{e}";
                     });
                 }
                 break;
             case GatewayOpcode.Hello:
                 Log<object?>(LogLevel.Debug, null, null, static (s, e) => "Hello received.");
 
-                StartHeartbeating(connectionState, payload.Data.GetValueOrDefault().ToObject(Serialization.Default.JsonHello).HeartbeatInterval);
+                StartHeartbeating(connectionState, message.Data.GetValueOrDefault().ToObject(Serialization.Default.JsonHello).HeartbeatInterval);
                 break;
             case GatewayOpcode.HeartbeatACK:
                 var latency = _latencyTimer.Elapsed;
@@ -1040,11 +1040,11 @@ private async ValueTask HandlePayloadAsync(State state, ConnectionState connecti
     /// <summary>
     /// Joins, moves, or disconnects the app from a voice channel.
     /// </summary>
-    public ValueTask UpdateVoiceStateAsync(VoiceStateProperties voiceState, WebSocketPayloadProperties? properties = null, CancellationToken cancellationToken = default)
+    public ValueTask UpdateVoiceStateAsync(VoiceStateProperties voiceState, WebSocketMessageProperties? properties = null, CancellationToken cancellationToken = default)
     {
-        GatewayPayloadProperties<VoiceStateProperties> payload = new(GatewayOpcode.VoiceStateUpdate, voiceState);
+        GatewayMessageProperties<VoiceStateProperties> message = new(GatewayOpcode.VoiceStateUpdate, voiceState);
 
-        return SendObjectAsync(payload, Serialization.Default.GatewayPayloadPropertiesVoiceStateProperties, properties, cancellationToken);
+        return SendObjectAsync(message, Serialization.Default.GatewayMessagePropertiesVoiceStateProperties, properties, cancellationToken);
     }
 
     /// <summary>
@@ -1053,27 +1053,27 @@ public ValueTask UpdateVoiceStateAsync(VoiceStateProperties voiceState, WebSocke
     /// <param name="presence">The presence to set.</param>
     /// <param name="properties"></param>
     /// <param name="cancellationToken">The cancellation token to cancel the operation.</param>
-    public ValueTask UpdatePresenceAsync(PresenceProperties presence, WebSocketPayloadProperties? properties = null, CancellationToken cancellationToken = default)
+    public ValueTask UpdatePresenceAsync(PresenceProperties presence, WebSocketMessageProperties? properties = null, CancellationToken cancellationToken = default)
     {
-        GatewayPayloadProperties<PresenceProperties> payload = new(GatewayOpcode.PresenceUpdate, presence);
+        GatewayMessageProperties<PresenceProperties> message = new(GatewayOpcode.PresenceUpdate, presence);
 
-        return SendObjectAsync(payload, Serialization.Default.GatewayPayloadPropertiesPresenceProperties, properties, cancellationToken);
+        return SendObjectAsync(message, Serialization.Default.GatewayMessagePropertiesPresenceProperties, properties, cancellationToken);
     }
 
     /// <summary>
     /// Requests users for a guild.
     /// </summary>
-    public ValueTask RequestGuildUsersAsync(GuildUsersRequestProperties requestProperties, WebSocketPayloadProperties? properties = null, CancellationToken cancellationToken = default)
+    public ValueTask RequestGuildUsersAsync(GuildUsersRequestProperties requestProperties, WebSocketMessageProperties? properties = null, CancellationToken cancellationToken = default)
     {
-        GatewayPayloadProperties<GuildUsersRequestProperties> payload = new(GatewayOpcode.RequestGuildUsers, requestProperties);
+        GatewayMessageProperties<GuildUsersRequestProperties> message = new(GatewayOpcode.RequestGuildUsers, requestProperties);
 
-        return SendObjectAsync(payload, Serialization.Default.GatewayPayloadPropertiesGuildUsersRequestProperties, properties, cancellationToken);
+        return SendObjectAsync(message, Serialization.Default.GatewayMessagePropertiesGuildUsersRequestProperties, properties, cancellationToken);
     }
 
-    private async Task ProcessEventAsync(State state, ConnectionState connectionState, JsonGatewayPayload payload)
+    private async Task ProcessEventAsync(State state, ConnectionState connectionState, JsonGatewayMessage message)
     {
-        var data = payload.Data.GetValueOrDefault();
-        var name = payload.Event!;
+        var data = message.Data.GetValueOrDefault();
+        var name = message.Event!;
         switch (name)
         {
             case "READY":

NetCord/Gateway/GatewayClientConfiguration.cs

@@ -20,7 +20,7 @@ public class GatewayClientConfiguration : IWebSocketClientConfiguration, IRestCl
     public IRateLimiterProvider? RateLimiterProvider { get; init; }
 
     /// <inheritdoc/>
-    public WebSocketPayloadProperties? DefaultPayloadProperties { get; init; }
+    public WebSocketMessageProperties? DefaultMessageProperties { get; init; }
 
     /// <inheritdoc/>
     public IReconnectStrategy? ReconnectStrategy { get; init; }

NetCord/Gateway/GatewayClientConfigurationFactory.cs

@@ -11,7 +11,7 @@ internal static class GatewayClientConfigurationFactory
 {
     public static GatewayClientConfiguration Create(IWebSocketConnectionProvider? webSocketConnectionProvider,
                                                     IRateLimiterProvider? rateLimiterProvider,
-                                                    WebSocketPayloadProperties? defaultPayloadProperties,
+                                                    WebSocketMessageProperties? defaultMessageProperties,
                                                     IReconnectStrategy? reconnectStrategy,
                                                     ILatencyTimer? latencyTimer,
                                                     ApiVersion? version,
@@ -30,7 +30,7 @@ public static GatewayClientConfiguration Create(IWebSocketConnectionProvider? we
         {
             WebSocketConnectionProvider = webSocketConnectionProvider,
             RateLimiterProvider = rateLimiterProvider,
-            DefaultPayloadProperties = defaultPayloadProperties,
+            DefaultMessageProperties = defaultMessageProperties,
             ReconnectStrategy = reconnectStrategy,
             LatencyTimer = latencyTimer,
             Version = version,

…Cord/Gateway/GatewayPayloadProperties.cs …Cord/Gateway/GatewayMessageProperties.csNetCord/Gateway/GatewayPayloadProperties.cs renamed to NetCord/Gateway/GatewayMessageProperties.cs NetCord/Gateway/GatewayPayloadProperties.cs renamed to NetCord/Gateway/GatewayMessageProperties.cs

@@ -2,7 +2,7 @@
 
 namespace NetCord.Gateway;
 
-internal class GatewayPayloadProperties<T>(GatewayOpcode opcode, T d)
+internal class GatewayMessageProperties<T>(GatewayOpcode opcode, T d)
 {
     [JsonPropertyName("op")]
     public GatewayOpcode Opcode { get; set; } = opcode;

NetCord/Gateway/IWebSocketClientConfiguration.cs

@@ -28,9 +28,9 @@ internal interface IWebSocketClientConfiguration
     public IRateLimiterProvider? RateLimiterProvider { get; }
 
     /// <summary>
-    /// The default payload properties for WebSocket payloads. Defaults to <see langword="null"/>.
+    /// The default properties for WebSocket messages. Defaults to <see langword="null"/>.
     /// </summary>
-    public WebSocketPayloadProperties? DefaultPayloadProperties { get; }
+    public WebSocketMessageProperties? DefaultMessageProperties { get; }
 
     /// <summary>
     /// The logger for the <see cref="WebSocketClient"/>. Defaults to <see cref="NullLogger"/>.

…Gateway/JsonModels/JsonGatewayPayload.cs …Gateway/JsonModels/JsonGatewayMessage.csNetCord/Gateway/JsonModels/JsonGatewayPayload.cs renamed to NetCord/Gateway/JsonModels/JsonGatewayMessage.cs NetCord/Gateway/JsonModels/JsonGatewayPayload.cs renamed to NetCord/Gateway/JsonModels/JsonGatewayMessage.cs

@@ -3,7 +3,7 @@
 
 namespace NetCord.Gateway.JsonModels;
 
-internal class JsonGatewayPayload
+internal class JsonGatewayMessage
 {
     [JsonPropertyName("op")]
     public GatewayOpcode Opcode { get; set; }

NetCord/Gateway/ShardedGatewayClient.cs

@@ -81,7 +81,7 @@ private static ShardedGatewayClientConfiguration CreateConfiguration(ShardedGate
 
         return ShardedGatewayClientConfigurationFactory.Create(configuration.WebSocketConnectionProviderFactory ?? (_ => null),
                                                                    configuration.RateLimiterProviderFactory ?? (_ => null),
-                                                                   configuration.DefaultPayloadPropertiesFactory ?? (_ => null),
+                                                                   configuration.DefaultMessagePropertiesFactory ?? (_ => null),
                                                                    configuration.ReconnectStrategyFactory ?? (_ => null),
                                                                    configuration.LatencyTimerFactory ?? (_ => null),
                                                                    configuration.VersionFactory ?? (_ => ApiVersion.V10),
@@ -311,7 +311,7 @@ private static GatewayClientConfiguration GetGatewayClientConfiguration(ShardedG
     {
         return GatewayClientConfigurationFactory.Create(configuration.WebSocketConnectionProviderFactory!(shard),
                                                         configuration.RateLimiterProviderFactory!(shard),
-                                                        configuration.DefaultPayloadPropertiesFactory!(shard),
+                                                        configuration.DefaultMessagePropertiesFactory!(shard),
                                                         configuration.ReconnectStrategyFactory!(shard),
                                                         configuration.LatencyTimerFactory!(shard),
                                                         configuration.VersionFactory!(shard),