mirror of
https://github.com/JKorf/CryptoExchange.Net.git
synced 2026-08-12 17:03:10 +00:00
e823114623
* Result types: * (Web)CallResult types are replaced by HttpResult, WebSocketResult and QueryResult with the same logic * Updated result types to record type * Result creation can be done with (Http/WebSocket/Query)Result.Ok(..) and .Fail(..) * Removed implicit result type conversion to bool, `if (result)` no longer works, instead use `if (result.Success)` * Replaced CallResult.SuccessResult with CallResult.Ok() * Fixed result object nullability hinting, for example Data might be null if Success isn't checked for true * Parameters & serialization: * Added support for `enabled` and `disabled` strings to bool converter * Removed ParameterCollection type, has been replaced by Parameters type * Removed ArraySerialization, OrderParameters and ParameterOrderComparer properties from RestApiClient, moved to ParameterSerializationsSettings * Updated RestRequestConfiguration in AuthenticationProvider.ProcessRequest to contain the full RequestDefinition instead of copied fields * Clients: * Updated Api client constructor logging parameter from ILogger to ILoggerFactory? * Added Api client constructor exchange name parameter * Added ToString overrides on base API types * Added Exchange property on BaseApiClient * Added ApiCredentials property on IRestApiClient and ISocketApiClient interfaces * Updated ILogger source from client name to topic specific client name * Removed logging from client creation * Fixed BaseRestClient SetApiCredentials not marked as virtual * Rest: * Added BaseAddress to RequestDefinition object * Updated RestApiClient AuthenticationProvider logic from private to protected and virtual * Removed RestApiClient.SendAsync baseAddress parameter removed * Removed RestApiClient.SendAsync without type parameter * WebSocket: * Updated MessageRouting definition into CreateForEvent for subscriptions and CreateForQuery for queries * Improved Query type safety with CeateForQuery which allows second parameter for specifying the result type * Renamed MessageRouter.CreateWithoutHandler to CreateVoid * Updated SocketApiClient.GetSocketConnection to check connection uri instead of Tag for finding compatible connections * Removed unused UnhandledMessageExpected property SocketApiClient * Fixed issue in SocketApiClient.GetSocketConnection causing requests to always wait the full max 10 seconds when there was a reconnecting socket * Shared APIs: * Updated Option definitions to always require the exchange name as first parameter * Added missing dedicated option types * Added Discover method on ISharedClient interface, returning info on supported capabilities and operations * Added SharedRequest GetParamValue helper method accepting multiple parameter names * Added ResetStaticExchangeParameters method on ExchangeParameters * Added Status property to SharedWithdrawal model * Added TradingModes property to SharedBalance model * Updated ExchangeSymbolCache to support multiple environments and additional key separation * Updated Shared ExchangeParameters parameter names to be case insensitive * Updated code comments * Replaced ExchangeResult with ExchangeCallResult type * Removed AsExchangeResult/ExchangeWebResult * Removed TradingMode from the response model, only maintained on models where it makes sense * Removed IListenKey support, listen keys now rely on internal management with TokenManager * Rate limiting: * Fixed websocket connection attempts counting towards rate limit even when server could not be reached * Removed host from rate limit methods, now part of the already provided RequestDefinition * Added amount parameter to RateLimit Reset method to allow partially resetting the limit * Added TokenManager implementation for automatic listenkey/token management * Added UserClientProvider base class * Added async streaming on UserDataTracker items with StreamUpdatesAsync * Added cancellation token support to UserDataTracker starting * Added Unit type for non-result types * Added ServerError constructor taking ErrorType and message to make it easier to create * Added SupportedEnvironments property to PlatformInfo * Updated SymbolOrderBook DoResyncAsync to return CallResult instead of CallResult<bool> which was redundant * Various small performance improvements
96 lines
4.7 KiB
C#
96 lines
4.7 KiB
C#
using CryptoExchange.Net.RateLimiting.Interfaces;
|
|
using System.Collections.Concurrent;
|
|
using System.IO;
|
|
using System.Net.Http;
|
|
|
|
namespace CryptoExchange.Net.Objects
|
|
{
|
|
/// <summary>
|
|
/// Request definitions cache
|
|
/// </summary>
|
|
public class RequestDefinitionCache
|
|
{
|
|
private readonly ConcurrentDictionary<string, RequestDefinition> _definitions = new();
|
|
|
|
/// <summary>
|
|
/// Get a definition if it is already in the cache or create a new definition and add it to the cache
|
|
/// </summary>
|
|
/// <param name="method">The HttpMethod</param>
|
|
/// <param name="baseAddress">The base address/host</param>
|
|
/// <param name="path">Endpoint path</param>
|
|
/// <param name="authenticated">Endpoint is authenticated</param>
|
|
/// <returns></returns>
|
|
public RequestDefinition GetOrCreate(HttpMethod method, string baseAddress, string path, bool authenticated = false)
|
|
=> GetOrCreate(method, baseAddress, path, null, 0, authenticated, null, null, null, null, null, null, null);
|
|
|
|
/// <summary>
|
|
/// Get a definition if it is already in the cache or create a new definition and add it to the cache
|
|
/// </summary>
|
|
/// <param name="method">The HttpMethod</param>
|
|
/// <param name="baseAddress">The base address/host</param>
|
|
/// <param name="path">Endpoint path</param>
|
|
/// <param name="rateLimitGate">The rate limit gate</param>
|
|
/// <param name="weight">Request weight</param>
|
|
/// <param name="authenticated">Endpoint is authenticated</param>
|
|
/// <returns></returns>
|
|
public RequestDefinition GetOrCreate(HttpMethod method, string baseAddress, string path, IRateLimitGate rateLimitGate, int weight = 1, bool authenticated = false)
|
|
=> GetOrCreate(method, baseAddress, path, rateLimitGate, weight, authenticated, null, null, null, null, null, null, null);
|
|
|
|
/// <summary>
|
|
/// Get a definition if it is already in the cache or create a new definition and add it to the cache
|
|
/// </summary>
|
|
/// <param name="baseAddress">The base address/host</param>
|
|
/// <param name="method">The HttpMethod</param>
|
|
/// <param name="path">Endpoint path</param>
|
|
/// <param name="rateLimitGate">The rate limit gate</param>
|
|
/// <param name="limitGuard">The rate limit guard for this specific endpoint</param>
|
|
/// <param name="weight">Request weight</param>
|
|
/// <param name="authenticated">Endpoint is authenticated</param>
|
|
/// <param name="requestBodyFormat">Request body format</param>
|
|
/// <param name="parameterPosition">Parameter position</param>
|
|
/// <param name="arraySerialization">Array serialization type</param>
|
|
/// <param name="preventCaching">Prevent request caching</param>
|
|
/// <param name="tryParseOnNonSuccess">Try parse the response even when status is not success</param>
|
|
/// <param name="forcePathEndWithSlash">Force trailing `/`</param>
|
|
/// <param name="identifier">Optional request identifier override</param>
|
|
/// <returns></returns>
|
|
public RequestDefinition GetOrCreate(
|
|
HttpMethod method,
|
|
string baseAddress,
|
|
string path,
|
|
IRateLimitGate? rateLimitGate,
|
|
int weight,
|
|
bool authenticated,
|
|
IRateLimitGuard? limitGuard = null,
|
|
RequestBodyFormat? requestBodyFormat = null,
|
|
HttpMethodParameterPosition? parameterPosition = null,
|
|
ArrayParametersSerialization? arraySerialization = null,
|
|
bool? preventCaching = null,
|
|
bool? tryParseOnNonSuccess = null,
|
|
bool? forcePathEndWithSlash = null,
|
|
string? identifier = null)
|
|
{
|
|
var identifierToUse = identifier ?? $"{path}{method.Method}{baseAddress}";
|
|
if (!_definitions.TryGetValue(identifierToUse, out var def))
|
|
{
|
|
def = new RequestDefinition(baseAddress, path, method)
|
|
{
|
|
Authenticated = authenticated,
|
|
LimitGuard = limitGuard,
|
|
RateLimitGate = rateLimitGate,
|
|
Weight = weight,
|
|
ArraySerialization = arraySerialization,
|
|
RequestBodyFormat = requestBodyFormat,
|
|
ParameterPosition = parameterPosition,
|
|
PreventCaching = preventCaching ?? false,
|
|
TryParseOnNonSuccess = tryParseOnNonSuccess ?? false,
|
|
ForcePathEndWithSlash = forcePathEndWithSlash ?? false,
|
|
};
|
|
_definitions.TryAdd(identifierToUse, def);
|
|
}
|
|
|
|
return def;
|
|
}
|
|
}
|
|
}
|