Class BucketId

Namespace

Kook.Net

Assembly

Kook.Net.Core.dll

表示一个限速桶。

public sealed class BucketId : IEquatable<BucketId>

Inheritance

object

BucketId

Implements

IEquatable<BucketId>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

BucketHash

获取此桶的哈希值。

public string? BucketHash { get; }

Property Value

string

Remarks

此哈希值由 KOOK 提供，用于分组限速。

Endpoint

获取将要请求的终结点（如果可用）。

public string? Endpoint { get; }

Property Value

string

HttpMethod

获取用于发起请求的 HTTP 方法（如果可用）。

public HttpMethod? HttpMethod { get; }

Property Value

HttpMethod

IsHashBucket

获取此限速桶是否为哈希分组限速桶。

public bool IsHashBucket { get; }

Property Value

bool

MajorParameters

获取路由的主要参数。

public IOrderedEnumerable<KeyValuePair<string, string>> MajorParameters { get; }

Property Value

IOrderedEnumerable<KeyValuePair<string, string>>

Methods

Create(HttpMethod?, string?, Dictionary<string, string>?)

基于 HttpMethod 和 Endpoint 创建一个新的 BucketId。

public static BucketId Create(HttpMethod? httpMethod, string? endpoint, Dictionary<string, string>? majorParams)

Parameters

httpMethod HttpMethod

用于发送请求的 HTTP 方法。

endpoint string

请求的终结点。

majorParams Dictionary<string, string>

终结点的主要路由参数。

Returns

BucketId

一个基于指定的 HttpMethod 和 Endpoint 创建的 BucketId。

Create(string, BucketId)

基于 BucketHash 和之前的 BucketId 创建一个新的 BucketId。

public static BucketId Create(string hash, BucketId oldBucket)

Parameters

hash string

由 KOOK 提供的分组限速哈希值。

oldBucket BucketId

要被升级为哈希分组限速桶的已有限速桶。

Returns

BucketId

一个基于指定的 BucketHash 和之前的 BucketId 创建的 BucketId。

Equals(BucketId?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(BucketId? other)

Parameters

other BucketId

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetBucketHash()

获取将此桶定义为哈希分组限速桶的字符串。

public string? GetBucketHash()

Returns

string

如果此桶是哈希分组限速桶，则返回此桶的哈希值；否则返回 null。

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

GetUniqueEndpoint()

获取将此桶定义为终结点限速桶的字符串。

public string? GetUniqueEndpoint()

Returns

string

如果此桶是终结点限速桶，则返回此桶的终结点；否则返回 null。

ToString()

Returns a string that represents the current object.

public override string? ToString()

Returns

string

A string that represents the current object.