flywithu/CryptoExchange.Net
1
0
Fork 0
mirror of https://github.com/JKorf/CryptoExchange.Net synced 2025-07-25 10:55:30 +00:00
Code Issues Releases Wiki Activity

Updated version

Browse Source
This commit is contained in:
Jkorf 2021-01-11 09:37:09 +01:00
parent 1c5f7d8073
commit c1d86b3776
3 changed files with 28 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CryptoExchange.Net/CryptoExchange.Net.csproj
View File

@ -6,13 +6,13 @@
<PackageId>CryptoExchange.Net</PackageId> <PackageId>CryptoExchange.Net</PackageId>
<Authors>JKorf</Authors> <Authors>JKorf</Authors>
<Description>A base package for implementing cryptocurrency exchange API's</Description> <Description>A base package for implementing cryptocurrency exchange API's</Description>
<PackageVersion>3.4.0</PackageVersion> <PackageVersion>3.5.0</PackageVersion>
<AssemblyVersion>3.4.0</AssemblyVersion> <AssemblyVersion>3.5.0</AssemblyVersion>
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance> <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
<PackageProjectUrl>https://github.com/JKorf/CryptoExchange.Net</PackageProjectUrl> <PackageProjectUrl>https://github.com/JKorf/CryptoExchange.Net</PackageProjectUrl>
<NeutralLanguage>en</NeutralLanguage> <NeutralLanguage>en</NeutralLanguage>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild> <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<PackageReleaseNotes>3.4.0 - Updated IExchangeClient interface, Fix for dropping message after timeout on socket, Added virtual HandleUnhandledMessage method in SocketClient</PackageReleaseNotes> <PackageReleaseNotes>3.5.0 - Additional info on exception messages, Added support for rate limiting using credits</PackageReleaseNotes>
<Nullable>enable</Nullable> <Nullable>enable</Nullable>
<LangVersion>8.0</LangVersion> <LangVersion>8.0</LangVersion>
<PackageLicenseExpression>MIT</PackageLicenseExpression> <PackageLicenseExpression>MIT</PackageLicenseExpression>

26
CryptoExchange.Net/CryptoExchange.Net.xml
View File

@ -925,13 +925,14 @@
Rate limiter interface Rate limiter interface
</summary> </summary>
</member> </member>
<member name="M:CryptoExchange.Net.Interfaces.IRateLimiter.LimitRequest(CryptoExchange.Net.RestClient,System.String,CryptoExchange.Net.Objects.RateLimitingBehaviour)"> <member name="M:CryptoExchange.Net.Interfaces.IRateLimiter.LimitRequest(CryptoExchange.Net.RestClient,System.String,CryptoExchange.Net.Objects.RateLimitingBehaviour,System.Int32)">
<summary> <summary>
Limit the request if needed Limit the request if needed
</summary> </summary>
<param name="client"></param> <param name="client"></param>
<param name="url"></param> <param name="url"></param>
<param name="limitBehaviour"></param> <param name="limitBehaviour"></param>
<param name="credits"></param>
<returns></returns> <returns></returns>
</member> </member>
<member name="T:CryptoExchange.Net.Interfaces.IRequest"> <member name="T:CryptoExchange.Net.Interfaces.IRequest">
@ -2457,7 +2458,7 @@
<param name="limitPerApiKey">The amount to limit to</param> <param name="limitPerApiKey">The amount to limit to</param>
<param name="perTimePeriod">The time period over which the limit counts</param> <param name="perTimePeriod">The time period over which the limit counts</param>
</member> </member>
<member name="M:CryptoExchange.Net.RateLimiter.RateLimiterAPIKey.LimitRequest(CryptoExchange.Net.RestClient,System.String,CryptoExchange.Net.Objects.RateLimitingBehaviour)"> <member name="M:CryptoExchange.Net.RateLimiter.RateLimiterAPIKey.LimitRequest(CryptoExchange.Net.RestClient,System.String,CryptoExchange.Net.Objects.RateLimitingBehaviour,System.Int32)">
<inheritdoc /> <inheritdoc />
</member> </member>
<member name="M:CryptoExchange.Net.RateLimiter.RateLimiterAPIKey.Dispose"> <member name="M:CryptoExchange.Net.RateLimiter.RateLimiterAPIKey.Dispose">
@ -2465,6 +2466,21 @@
Dispose Dispose
</summary> </summary>
</member> </member>
<member name="T:CryptoExchange.Net.RateLimiter.RateLimiterCredit">
<summary>
Limits the amount of requests per time period to a certain limit, counts the total amount of requests.
</summary>
</member>
<member name="M:CryptoExchange.Net.RateLimiter.RateLimiterCredit.#ctor(System.Int32,System.TimeSpan)">
<summary>
Create a new RateLimiterTotal. This rate limiter limits the amount of requests per time period to a certain limit, counts the total amount of requests.
</summary>
<param name="limit">The amount to limit to</param>
<param name="perTimePeriod">The time period over which the limit counts</param>
</member>
<member name="M:CryptoExchange.Net.RateLimiter.RateLimiterCredit.LimitRequest(CryptoExchange.Net.RestClient,System.String,CryptoExchange.Net.Objects.RateLimitingBehaviour,System.Int32)">
<inheritdoc />
</member>
<member name="T:CryptoExchange.Net.RateLimiter.RateLimiterPerEndpoint"> <member name="T:CryptoExchange.Net.RateLimiter.RateLimiterPerEndpoint">
<summary> <summary>
Limits the amount of requests per time period to a certain limit, counts the request per endpoint. Limits the amount of requests per time period to a certain limit, counts the request per endpoint.
@ -2477,7 +2493,7 @@
<param name="limitPerEndpoint">The amount to limit to</param> <param name="limitPerEndpoint">The amount to limit to</param>
<param name="perTimePeriod">The time period over which the limit counts</param> <param name="perTimePeriod">The time period over which the limit counts</param>
</member> </member>
<member name="M:CryptoExchange.Net.RateLimiter.RateLimiterPerEndpoint.LimitRequest(CryptoExchange.Net.RestClient,System.String,CryptoExchange.Net.Objects.RateLimitingBehaviour)"> <member name="M:CryptoExchange.Net.RateLimiter.RateLimiterPerEndpoint.LimitRequest(CryptoExchange.Net.RestClient,System.String,CryptoExchange.Net.Objects.RateLimitingBehaviour,System.Int32)">
<inheritdoc /> <inheritdoc />
</member> </member>
<member name="T:CryptoExchange.Net.RateLimiter.RateLimiterTotal"> <member name="T:CryptoExchange.Net.RateLimiter.RateLimiterTotal">
@ -2492,7 +2508,7 @@
<param name="limit">The amount to limit to</param> <param name="limit">The amount to limit to</param>
<param name="perTimePeriod">The time period over which the limit counts</param> <param name="perTimePeriod">The time period over which the limit counts</param>
</member> </member>
<member name="M:CryptoExchange.Net.RateLimiter.RateLimiterTotal.LimitRequest(CryptoExchange.Net.RestClient,System.String,CryptoExchange.Net.Objects.RateLimitingBehaviour)"> <member name="M:CryptoExchange.Net.RateLimiter.RateLimiterTotal.LimitRequest(CryptoExchange.Net.RestClient,System.String,CryptoExchange.Net.Objects.RateLimitingBehaviour,System.Int32)">
<inheritdoc /> <inheritdoc />
</member> </member>
<member name="T:CryptoExchange.Net.RateLimiter.RateLimitObject"> <member name="T:CryptoExchange.Net.RateLimiter.RateLimitObject">
@ -2688,7 +2704,7 @@
</summary> </summary>
<returns>The roundtrip time of the ping request</returns> <returns>The roundtrip time of the ping request</returns>
</member> </member>
<member name="M:CryptoExchange.Net.RestClient.SendRequest``1(System.Uri,System.Net.Http.HttpMethod,System.Threading.CancellationToken,System.Collections.Generic.Dictionary{System.String,System.Object},System.Boolean,System.Boolean,System.Nullable{CryptoExchange.Net.Objects.PostParameters},System.Nullable{CryptoExchange.Net.Objects.ArrayParametersSerialization})"> <member name="M:CryptoExchange.Net.RestClient.SendRequest``1(System.Uri,System.Net.Http.HttpMethod,System.Threading.CancellationToken,System.Collections.Generic.Dictionary{System.String,System.Object},System.Boolean,System.Boolean,System.Nullable{CryptoExchange.Net.Objects.PostParameters},System.Nullable{CryptoExchange.Net.Objects.ArrayParametersSerialization},System.Int32)">
<summary> <summary>
Execute a request Execute a request
</summary> </summary>

4
README.md
View File

@ -286,6 +286,10 @@ static async Task GetExchangeData(IExchangeClient client)
```` ````
## Release notes ## Release notes
* Version 3.5.0 - 11 jan 2021
* Additional info on exception messages
* Added support for rate limiting using credits
* Version 3.4.0 - 21 dec 2020 * Version 3.4.0 - 21 dec 2020
* Updated IExchangeClient interface * Updated IExchangeClient interface
* Fix for dropping message after timeout on socket * Fix for dropping message after timeout on socket