Переименовать LongPool -> LongPoll (#1594)

vknet · Oct 4, 2023 · 3f1ed18 · 3f1ed18
1 parent 9e3b731
commit 3f1ed18
Show file tree

Hide file tree

Showing 16 changed files with 100 additions and 61 deletions.
diff --git a/VkNet/Abstractions/Category/Async/IMessagesCategoryAsync.cs b/VkNet/Abstractions/Category/Async/IMessagesCategoryAsync.cs
@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Threading;
@@ -613,7 +613,7 @@ Task<LongPollServerResponse> GetLongPollServerAsync(bool needPts = false,
 	/// с актуальной версией.
 	/// </summary>
 	/// <param name="params">
-	/// Параметры запроса к LongPool серверу
+	/// Параметры запроса к LongPoll серверу
 	/// MessagesGetLongPollHistoryParams
 	/// </param>
 	/// <param name="token">Токен отмены операции</param>

diff --git a/VkNet/Model/BotsLongPollHistoryResponse.cs b/VkNet/Model/BotsLongPollHistoryResponse.cs
@@ -8,7 +8,7 @@ namespace VkNet.Model;
 /// <br/>
 /// В обобщении можно указать тип JObject для того, чтобы избежать ошибок при десериализации.
 /// <br/>
-/// После чего можно воспользоваться методом GroupLongPoolHelpers.GetGroupUpdatesAndErrors. Он вернёт ошибки, если таковые имеются, но не бросит исключений.
+/// После чего можно воспользоваться методом GroupLongPollHelpers.GetGroupUpdatesAndErrors. Он вернёт ошибки, если таковые имеются, но не бросит исключений.
 /// </summary>
 [Serializable]
 public class BotsLongPollHistoryResponse<TGroupUpdate>

diff --git a/VkNet/Model/LongPollServerResponse.cs b/VkNet/Model/LongPollServerResponse.cs
@@ -31,7 +31,7 @@ public class LongPollServerResponse
 	public ulong Ts { get; set; }
 
 	/// <summary>
-	/// Постоянное событие для работы с методом getLongPoolHistory
+	/// Постоянное событие для работы с методом getLongPollHistory
 	/// </summary>
 	[JsonProperty("pts")]
 	public ulong? Pts { get; set; }

diff --git a/...Utils/BotsLongPool/BotsLongPoolHelpers.cs → ...Utils/BotsLongPoll/BotsLongPoolHelpers.cs b/...Utils/BotsLongPool/BotsLongPoolHelpers.cs → ...Utils/BotsLongPoll/BotsLongPoolHelpers.cs
@@ -1,14 +1,15 @@
 #nullable enable
+using System;
 using System.Collections.Generic;
 using Newtonsoft.Json.Linq;
 using VkNet.Model;
 
-namespace VkNet.Utils.BotsLongPool;
+namespace VkNet.Utils.BotsLongPoll;
 
 /// <summary>
 /// Методы для обработки событий лонгпула у сообществ.
 /// </summary>
-public static class BotsLongPoolHelpers
+public static class BotsLongPollHelpers
 {
 	/// <summary>
 	/// Метод для получения обновлений группы из массива JObject, который не бросает исключений, но вместе с обновлениями возвращает ошибки при десериализации, если таковые имеются.
@@ -45,4 +46,10 @@ public static List<GroupUpdateEvent> GetGroupUpdateEvents(IEnumerable<JObject> j
 
 		return updates;
 	}
-}
+}
+
+/// <summary>
+/// Методы для обработки событий лонгпула у сообществ.
+/// </summary>
+[Obsolete(ObsoleteText.ObsoleteLongPool, true)]
+public static class BotsLongPoolHelpers {}
diff --git a/...otsLongPool/BotsLongPoolOnUpdatesEvent.cs → ...otsLongPoll/BotsLongPoolOnUpdatesEvent.cs b/...otsLongPool/BotsLongPoolOnUpdatesEvent.cs → ...otsLongPoll/BotsLongPoolOnUpdatesEvent.cs
@@ -1,14 +1,15 @@
 #nullable enable
+using System;
 using System.Collections.Generic;
 using Newtonsoft.Json.Linq;
 using VkNet.Model;
 
-namespace VkNet.Utils.BotsLongPool;
+namespace VkNet.Utils.BotsLongPoll;
 
 /// <summary>
-/// Обёртка для BotsLongPoolUpdatesProviderParams.OnUpdates, в которой содержится вся информация о текущем массиве событий лонгпула для бота в сообществе.
+/// Обёртка для BotsLongPollUpdatesProviderParams.OnUpdates, в которой содержится вся информация о текущем массиве событий лонгпула для бота в сообществе.
 /// </summary>
-public class BotsLongPoolOnUpdatesEvent
+public class BotsLongPollOnUpdatesEvent
 {
 	/// <summary>
 	/// Обновление в событиях группы.
@@ -19,4 +20,10 @@ public class BotsLongPoolOnUpdatesEvent
 	/// Обработанные обновления из Response
 	/// </summary>
 	public List<GroupUpdateEvent> Updates;
-}
+}
+
+/// <summary>
+/// Обёртка для BotsLongPollUpdatesProviderParams.OnUpdates, в которой содержится вся информация о текущем массиве событий лонгпула для бота в сообществе.
+/// </summary>
+[Obsolete(ObsoleteText.ObsoleteLongPool, true)]
+public static class BotsLongPoolOnUpdatesEvent {}
diff --git a/...otsLongPool/BotsLongPoolUpdatesHandler.cs → ...otsLongPoll/BotsLongPoolUpdatesHandler.cs b/...otsLongPool/BotsLongPoolUpdatesHandler.cs → ...otsLongPoll/BotsLongPoolUpdatesHandler.cs
@@ -13,15 +13,15 @@
 using VkNet.Exception;
 using VkNet.Model;
 
-namespace VkNet.Utils.BotsLongPool;
+namespace VkNet.Utils.BotsLongPoll;
 
 /// <summary>
 /// Реализация лонгпула для бота в сообществе
 /// </summary>
 [UsedImplicitly]
-public class BotsLongPoolUpdatesHandler : IBotsLongPoolUpdatesHandler
+public class BotsLongPollUpdatesHandler : IBotsLongPollUpdatesHandler
 {
-	private readonly BotsLongPoolUpdatesHandlerParams _params;
+	private readonly BotsLongPollUpdatesHandlerParams _params;
 
 	private ulong? _currentTs;
 
@@ -30,9 +30,9 @@ public class BotsLongPoolUpdatesHandler : IBotsLongPoolUpdatesHandler
 	private string? _currentServer;
 
 	/// <summary>
-	/// Инициализирует новый экземпляр класса <see cref="BotsLongPoolUpdatesHandler" />
+	/// Инициализирует новый экземпляр класса <see cref="BotsLongPollUpdatesHandler" />
 	/// </summary>
-	public BotsLongPoolUpdatesHandler(BotsLongPoolUpdatesHandlerParams @params) => _params = @params;
+	public BotsLongPollUpdatesHandler(BotsLongPollUpdatesHandlerParams @params) => _params = @params;
 
 	/// <summary>
 	/// Запуск отслеживания событий
@@ -46,14 +46,14 @@ public async Task RunAsync(CancellationToken token = default)
 			while (_params.GetPause?.Invoke() is not true)
 			{
 				token.ThrowIfCancellationRequested();
-				await NextLongPoolHistoryAsync(token: token);
+				await NextLongPollHistoryAsync(token: token);
 			}
 
 			await Task.Delay(_params.DelayBetweenUpdates, token);
 		}
 	}
 
-	private async Task NextLongPoolHistoryAsync(CancellationToken token = default)
+	private async Task NextLongPollHistoryAsync(CancellationToken token = default)
 	{
 		try
 		{
@@ -85,7 +85,7 @@ private async Task NextLongPoolHistoryAsync(CancellationToken token = default)
 			}
 
 			SetTs(response.Ts);
-			var updates = BotsLongPoolHelpers.GetGroupUpdateEvents(response.Updates);
+			var updates = BotsLongPollHelpers.GetGroupUpdateEvents(response.Updates);
 			_params.OnUpdates?.Invoke(new()
 			{
 				Response = response,
@@ -103,7 +103,7 @@ private async Task HandleExceptionAsync(System.Exception exception, Cancellation
 		switch (exception)
 		{
 			case LongPollException longPollException:
-				await HandleLongPoolExceptionAsync(longPollException, token);
+				await HandleLongPollExceptionAsync(longPollException, token);
 
 				return;
 
@@ -133,7 +133,7 @@ private async Task HandleExceptionAsync(System.Exception exception, Cancellation
 	/// </summary>
 	/// <param name="exception">Ошибка, связанная с лонгпулом</param>
 	/// <param name="token">Токен отмены операции</param>
-	private async Task HandleLongPoolExceptionAsync(LongPollException exception, CancellationToken token)
+	private async Task HandleLongPollExceptionAsync(LongPollException exception, CancellationToken token)
 	{
 		switch (exception)
 		{
@@ -150,7 +150,7 @@ private async Task HandleLongPoolExceptionAsync(LongPollException exception, Can
 			default:
 				try
 				{
-					await UpdateLongPoolServerAsync(token);
+					await UpdateLongPollServerAsync(token);
 				}
 				catch (System.Exception ex)
 				{
@@ -177,7 +177,7 @@ private async Task InitCurrentTsAsync(CancellationToken token)
 		}
 	}
 
-	private async Task UpdateLongPoolServerAsync(CancellationToken token)
+	private async Task UpdateLongPollServerAsync(CancellationToken token)
 	{
 		try
 		{
@@ -217,4 +217,10 @@ private void IncTs()
 
 		SetTs(_currentTs.Value + 1);
 	}
-}
+}
+
+/// <summary>
+/// Реализация лонгпула для бота в сообществе
+/// </summary>
+[Obsolete(ObsoleteText.ObsoleteLongPool, true)]
+public static class BotsLongPoolUpdatesHandler {}
diff --git a/...gPool/BotsLongPoolUpdatesHandlerParams.cs → ...gPoll/BotsLongPoolUpdatesHandlerParams.cs b/...gPool/BotsLongPoolUpdatesHandlerParams.cs → ...gPoll/BotsLongPoolUpdatesHandlerParams.cs
@@ -3,13 +3,13 @@
 using JetBrains.Annotations;
 using VkNet.Abstractions;
 
-namespace VkNet.Utils.BotsLongPool;
+namespace VkNet.Utils.BotsLongPoll;
 
 /// <summary>
-/// Параметры для конструктора BotsLongPoolUpdatesHandler
+/// Параметры для конструктора BotsLongPollUpdatesHandler
 /// </summary>
 [UsedImplicitly]
-public class BotsLongPoolUpdatesHandlerParams
+public class BotsLongPollUpdatesHandlerParams
 {
 	/// <summary>
 	/// ID вашего бота (группы)
@@ -28,9 +28,9 @@ public class BotsLongPoolUpdatesHandlerParams
 	public IVkApi Api { get; set; }
 
 	/// <summary>
-	/// Инициализирует новый экземпляр класса <see cref="BotsLongPoolUpdatesHandlerParams" />
+	/// Инициализирует новый экземпляр класса <see cref="BotsLongPollUpdatesHandlerParams" />
 	/// </summary>
-	public BotsLongPoolUpdatesHandlerParams(IVkApi api, ulong groupId)
+	public BotsLongPollUpdatesHandlerParams(IVkApi api, ulong groupId)
 	{
 		Api = api;
 		GroupId = groupId;
@@ -55,7 +55,7 @@ public BotsLongPoolUpdatesHandlerParams(IVkApi api, ulong groupId)
 	/// <summary>
 	/// Функция, в которую будут отправлены полученные события.
 	/// </summary>
-	public Action<BotsLongPoolOnUpdatesEvent>? OnUpdates { get; set; } = null;
+	public Action<BotsLongPollOnUpdatesEvent>? OnUpdates { get; set; } = null;
 
 	/// <summary>
 	/// Функция, в которую будет отправляться TS при каждом его обновлении.
@@ -71,4 +71,10 @@ public BotsLongPoolUpdatesHandlerParams(IVkApi api, ulong groupId)
 	/// Функция, в которую будут отправлены незначительные или временные ошибки (например - SocketException или ошибки связанные с интернетом или с доступом к ВКонтакте)
 	/// </summary>
 	public Action<System.Exception>? OnWarn { get; set; } = null;
-}
+}
+
+/// <summary>
+/// Параметры для конструктора BotsLongPollUpdatesHandler
+/// </summary>
+[Obsolete(ObsoleteText.ObsoleteLongPool, true)]
+public static class BotsLongPoolUpdatesHandlerParams {}
diff --git a/VkNet/Utils/BotsLongPool/GroupUpdateEvent.cs → VkNet/Utils/BotsLongPoll/GroupUpdateEvent.cs b/VkNet/Utils/BotsLongPool/GroupUpdateEvent.cs → VkNet/Utils/BotsLongPoll/GroupUpdateEvent.cs
@@ -2,7 +2,7 @@
 using Newtonsoft.Json.Linq;
 using VkNet.Model;
 
-namespace VkNet.Utils.BotsLongPool;
+namespace VkNet.Utils.BotsLongPoll;
 
 /// <summary>
 /// Обёртка для GroupUpdate, в которой кроме самого обновления есть и ошибки при парсинге.

diff --git a/...tsLongPool/IBotsLongPoolUpdatesHandler.cs → ...tsLongPoll/IBotsLongPoolUpdatesHandler.cs b/...tsLongPool/IBotsLongPoolUpdatesHandler.cs → ...tsLongPoll/IBotsLongPoolUpdatesHandler.cs
@@ -1,17 +1,24 @@
 #nullable enable
+using System;
 using System.Threading;
 using System.Threading.Tasks;
 
-namespace VkNet.Utils.BotsLongPool;
+namespace VkNet.Utils.BotsLongPoll;
 
 /// <summary>
 /// Обработчик лонгпула групповых сообщений
 /// </summary>
-public interface IBotsLongPoolUpdatesHandler
+public interface IBotsLongPollUpdatesHandler
 {
 	/// <summary>
 	/// Запуск отслеживания событий
 	/// </summary>
 	/// <param name="token">Токен отмены операции</param>
 	Task RunAsync(CancellationToken token = default);
-}
+}
+
+/// <summary>
+/// Обработчик лонгпула групповых сообщений
+/// </summary>
+[Obsolete(ObsoleteText.ObsoleteLongPool, true)]
+public interface IBotsLongPoolUpdatesHandler {}
diff --git a/VkNet/Utils/ObsoleteText.cs b/VkNet/Utils/ObsoleteText.cs
@@ -101,4 +101,10 @@ public static class ObsoleteText
 	/// </summary>
 	public const string ObsoleteCyrillicProperty =
 		"Данное поле содержало кириллицу в названии. Обновите использование на поле с латинским названием.";
+
+	/// <summary>
+	/// В версии 1.76.0 была опечатка в слове LongPool. Исправьте его на правильное: LongPoll.
+	/// </summary>
+	public const string ObsoleteLongPool =
+		"В версии 1.76.0 была опечатка в слове LongPool. Исправьте его на правильное: LongPoll.";
 }
diff --git a/...sLongPool/IUsersLongPoolUpdatesHandler.cs → ...sLongPoll/IUsersLongPoolUpdatesHandler.cs b/...sLongPool/IUsersLongPoolUpdatesHandler.cs → ...sLongPoll/IUsersLongPoolUpdatesHandler.cs
@@ -2,12 +2,12 @@
 using System.Threading;
 using System.Threading.Tasks;
 
-namespace VkNet.Utils.UsersLongPool;
+namespace VkNet.Utils.UsersLongPoll;
 
 /// <summary>
 /// Обработчик лонгпула пользовательских сообщений
 /// </summary>
-public interface IUsersLongPoolUpdatesHandler
+public interface IUsersLongPollUpdatesHandler
 {
 	/// <summary>
 	/// Запуск отслеживания событий

diff --git a/...t/Utils/UsersLongPool/UserMessageEvent.cs → ...t/Utils/UsersLongPoll/UserMessageEvent.cs b/...t/Utils/UsersLongPool/UserMessageEvent.cs → ...t/Utils/UsersLongPoll/UserMessageEvent.cs
@@ -2,7 +2,7 @@
 using Newtonsoft.Json.Linq;
 using VkNet.Model;
 
-namespace VkNet.Utils.UsersLongPool;
+namespace VkNet.Utils.UsersLongPoll;
 
 /// <summary>
 /// Обёртка для Message, в которой кроме самого сообщения есть и ошибки при парсинге.

diff --git a/...ils/UsersLongPool/UsersLongPoolHelpers.cs → ...ils/UsersLongPoll/UsersLongPoolHelpers.cs b/...ils/UsersLongPool/UsersLongPoolHelpers.cs → ...ils/UsersLongPoll/UsersLongPoolHelpers.cs
@@ -3,12 +3,12 @@
 using Newtonsoft.Json.Linq;
 using VkNet.Model;
 
-namespace VkNet.Utils.UsersLongPool;
+namespace VkNet.Utils.UsersLongPoll;
 
 /// <summary>
 /// Методы для обработки событий лонгпула у сообществ.
 /// </summary>
-public static class UsersLongPoolHelpers
+public static class UsersLongPollHelpers
 {
 	/// <summary>
 	/// Метод для получения сообщений из массива JObject, который не бросает исключений, но вместе с сообщениями возвращает ошибки при десериализации, если таковые имеются.

diff --git a/...rsLongPool/UsersLongPoolOnUpdatesEvent.cs → ...rsLongPoll/UsersLongPoolOnUpdatesEvent.cs b/...rsLongPool/UsersLongPoolOnUpdatesEvent.cs → ...rsLongPoll/UsersLongPoolOnUpdatesEvent.cs
@@ -3,12 +3,12 @@
 using Newtonsoft.Json.Linq;
 using VkNet.Model;
 
-namespace VkNet.Utils.UsersLongPool;
+namespace VkNet.Utils.UsersLongPoll;
 
 /// <summary>
-/// Обёртка для UsersLongPoolUpdatesHandlerParams.OnUpdates, в которой содержится вся информация о текущем массиве событий лонгпула для пользователя.
+/// Обёртка для UsersLongPollUpdatesHandlerParams.OnUpdates, в которой содержится вся информация о текущем массиве событий лонгпула для пользователя.
 /// </summary>
-public class UsersLongPoolOnUpdatesEvent
+public class UsersLongPollOnUpdatesEvent
 {
 	/// <summary>
 	/// Обновление в событиях пользователя.