Difference between revisions of "Protocols/OSCAR/SNAC/OSERVICE RATE PARAMS REPLY"
Jump to navigation
Jump to search
(Created page with "{{Protocols/OSCAR}} {{Protocols/OSCAR/SNAC/Stats |origin={{Protocols/OSCAR/SNAC/OSERVICE__RATE_PARAMS_REPLY/Origin}} |name=OSERVICE__RATE_PARAMS_REPLY |id=0x0001, 0x0007 |serv...") |
|||
Line 18: | Line 18: | ||
=== SNAC Data === | === SNAC Data === | ||
− | + | ||
+ | |||
+ | === Datatype: Rate Parameters === | ||
+ | |||
+ | Describes the rate parameters for a single rate class. | ||
+ | |||
+ | {| class="wikitable" | ||
+ | ! Name | ||
+ | ! Type | ||
+ | ! Notes | ||
+ | |- | ||
+ | | classId | ||
+ | | uint16 (word) | ||
+ | | Rate class being described | ||
+ | |- | ||
+ | | windowSize | ||
+ | | uint32 (dword) | ||
+ | | Number of events to count | ||
+ | |- | ||
+ | | clearThreshold | ||
+ | | uint32 (dword) | ||
+ | | Once rate limited the average has to reach this value in order to clear | ||
+ | |- | ||
+ | | alertThreshold | ||
+ | | uint32 (dword) | ||
+ | | Server will tell the client it is getting close to the limit | ||
+ | |- | ||
+ | | limitThreshold | ||
+ | | uint32 (dword) | ||
+ | | SNACs will be dropped below this value | ||
+ | |- | ||
+ | | disconnectThreshold | ||
+ | | uint32 (dword) | ||
+ | | Server will disconnect below this value | ||
+ | |- | ||
+ | | currentAverage | ||
+ | | uint32 (dword) | ||
+ | | Current value for the class; higher is better | ||
+ | |- | ||
+ | | maxAverage | ||
+ | | uint32 (dword) | ||
+ | | The maximum rate value; if the current value rises about this value it should be reset | ||
+ | |- | ||
+ | | lastArrivalDelta | ||
+ | | uint32 (dword) | ||
+ | | Last message was received this long ago | ||
+ | |- | ||
+ | | droppingSNACs | ||
+ | | uint8 (byte) | ||
+ | | Is the server dropping SNACs for this rate class | ||
+ | |} | ||
+ | |||
+ | === Datatype: Rate Class Members === | ||
+ | |||
+ | Describes all the SNACs in a single rate class. | ||
+ | |||
+ | {| class="wikitable" | ||
+ | ! Name | ||
+ | ! Type | ||
+ | ! Notes | ||
+ | |- | ||
+ | | id | ||
+ | | uint16 (word) | ||
+ | | Rate class being described | ||
+ | |- | ||
+ | | numMembers | ||
+ | | uint16 (word) | ||
+ | | Number of SNACs in this rate class | ||
+ | |- | ||
+ | | snacIds | ||
+ | | Array of [[Protocols/OSCAR/SNAC#Datatype:_SNAC_ID|SNAC__ID]] length numMembers | ||
+ | | SNACs in this rate class | ||
+ | |} | ||
=== OSERVICE SNACs === | === OSERVICE SNACs === |
Revision as of 04:47, 21 March 2020
OSCAR Protocol |
Introduction • Terms • Clients |
Basic |
Datatypes • FLAP • SNAC • TLV |
UUIDs • Errors • Tool IDs |
Host Interaction |
Rate Limits • Migration • Messages |
Other Services |
ADMIN • ADVERT • ALERT |
BART • BOS • BUCP • CHAT |
CHAT_NAV |
Tutorials |
Sign On • BART • Rendezvous |
ICBM • Locate • Buddies |
Foodgroups |
OSERVICE (0x0001) |
LOCATE (0x0002) |
BUDDY (0x0003) |
ICBM (0x0004) |
ADVERT (0x0005) |
INVITE (0x0006) |
ADMIN (0x0007) |
POPUP (0x0008) |
PD (0x0009) |
USER_LOOKUP (0x000A) |
STATS (0x000B) |
TRANSLATE (0x000C) |
CHAT_NAV (0x000D) |
CHAT (0x000E) |
ODIR (0x000F) |
BART (0x0010) |
FEEDBAG (0x0013) |
ICQ (0x0015) |
BUCP (0x0017) |
ALERT (0x0018) |
PLUGIN (0x0022) |
UNNAMED_FG_24 (0x0024) |
MDIR (0x0025) |
ARS (0x044A) |
ID | Origin | Name | Foodgroup | Service | Status | Version |
---|---|---|---|---|---|---|
0x0001, 0x0007 | Host | OSERVICE__RATE_PARAMS_REPLY | Unspecified | All | Active | 4.0 |
Contains response to the OSERVICE__RATE_PARAMS_QUERY.
Contents
SNAC Header
Foodgroup | uint16 (word) | 00 01 |
Subgroup | uint16 (word) | 00 07 |
Flags | uint16 (word) | 00 00 |
Request ID | uint32 (dword) | 00 00 00 00 |
SNAC Data
Datatype: Rate Parameters
Describes the rate parameters for a single rate class.
Name | Type | Notes |
---|---|---|
classId | uint16 (word) | Rate class being described |
windowSize | uint32 (dword) | Number of events to count |
clearThreshold | uint32 (dword) | Once rate limited the average has to reach this value in order to clear |
alertThreshold | uint32 (dword) | Server will tell the client it is getting close to the limit |
limitThreshold | uint32 (dword) | SNACs will be dropped below this value |
disconnectThreshold | uint32 (dword) | Server will disconnect below this value |
currentAverage | uint32 (dword) | Current value for the class; higher is better |
maxAverage | uint32 (dword) | The maximum rate value; if the current value rises about this value it should be reset |
lastArrivalDelta | uint32 (dword) | Last message was received this long ago |
droppingSNACs | uint8 (byte) | Is the server dropping SNACs for this rate class |
Datatype: Rate Class Members
Describes all the SNACs in a single rate class.
Name | Type | Notes |
---|---|---|
id | uint16 (word) | Rate class being described |
numMembers | uint16 (word) | Number of SNACs in this rate class |
snacIds | Array of SNAC__ID length numMembers | SNACs in this rate class |
OSERVICE SNACs
|