Documentation
¶
Overview ¶
Package quota contains usage data about the Battle.net API, which comes back as part of the response headers after you make a call with one of the gobattlenet clients.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Quota ¶
type Quota struct {
// contains filtered or unexported fields
}
Quota contains data about the Battle.net API usage. The following is a breakdown of the headers:
X-Plan-Qps-Allotted: The maximum QPS (queries per second) capacity set on your API key. This is the maximum number of calls that can be made in any given second.
X-Plan-Qps-Current: The current count of calls being applied against the above limit; in this case, it is a representation of how many calls your key is making at that particular second in time.
X-Plan-Quota-Allotted: The maximum number of calls that can be made on daily basis.
X-Plan-Quota-Current: The current count of calls made in the current limit period, i.e. the current day.
X-Plan-Quota-Reset: The time when the quota count will reset to 0.
func (*Quota) QuotaAlloted ¶
QuotaAlloted returns the alloted quota.
func (*Quota) QuotaCurrent ¶
QuotaCurrent returns the current quota.
func (*Quota) QuotaReset ¶
QuotaReset returns the time the quota will reset.
Source Files