Protocols/OSCAR/Errors: Difference between revisions

From NINA Wiki
Jump to navigation Jump to search
(Created page with "{{Protocols/OSCAR}} === TLV Class: ERROR__TAGS === These are common tags used by error SNACs. {| class="wikitable" ! Name ! Type ! Length ! Value |- | ERROR__TAGS_FAIL_URL...")
 
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Protocols/OSCAR}}
{{Protocols/OSCAR}}
Errors are implemented in a common way for all foodgroups each having a SNAC as subgroup 0x01. For the most part, subgroup 0x01 allows errors sent from either client or host, but in some cases it may only be from the host, for the time being. It should always be assumed, however, that this may change in the future.


=== TLV Class: ERROR__TAGS ===
=== TLV Class: ERROR__TAGS ===
Line 28: Line 30:
| ERROR__TAGS_ERROR_INFO_CLSID
| ERROR__TAGS_ERROR_INFO_CLSID
| 0x29
| 0x29
|
| [[Protocols/OSCAR/UUIDs|UUID]]
[Protocols/OSCAR/UUIDs UUID]
| UUID specifying format of ERROR_INFO_DATA data
| UUID specifying format of ERROR_INFO_DATA data
|-
|-
Line 37: Line 38:
| Extra information describing error
| Extra information describing error
|}
|}
=== Class: ERROR__CODE ===
Generic error codes
{| class="wikitable"
! Name
! Value
! Notes
|-
| ERROR__CODE_INVALID_SNAC
| 0x01
| Not a known SNAC
|-
| ERROR__CODE_RATE_TO_HOST
| 0x02
| Exceed the rate limit to host
|-
| ERROR__CODE_RATE_TO_CLIENT
| 0x03
| Exceed the rate limit to the remote user
|-
| ERROR__CODE_NOT_LOGGED_ON
| 0x04
| Remote user is not logged in
|-
| ERROR__CODE_SERVICE_UNAVAILABLE
| 0x05
| Normally available but something is wrong right now
|-
| ERROR__CODE_SERVICE_NOT_DEFINED
| 0x06
| Requested a service that does not exist
|-
| ERROR__CODE_OBSOLETE_SNAC
| 0x07
| This SNAC is known no longer supported
|-
| ERROR__CODE_NOT_SUPPORTED_BY_HOST
| 0x08
| Unknown SNAC
|-
| ERROR__CODE_NOT_SUPPORTED_BY_CLIENT
| 0x09
| Remote user is on but does not support the request
|-
| ERROR__CODE_REFUSED_BY_CLIENT
| 0x0A
| Message is bigger then remote client wants
|-
| ERROR__CODE_REPLY_TOO_BIG
| 0x0B
| Message from remote client bigger than host wants
|-
| ERROR__CODE_RESPONSES_LOST
| 0x0C
| Unexpected error occurred and response was dropped
|-
| ERROR__CODE_REQUEST_DENIED
| 0x0D
| Host said user or client is not allowed to do this
|-
| ERROR__CODE_BUSTED_SNAC_PAYLOAD
| 0x0E
| SNAC is too small or is not in the right format
|-
| ERROR__CODE_INSUFFICIENT_RIGHTS
| 0x0F
| User or client does not have the correct rights to make the request
|-
| ERROR__CODE_IN_LOCAL_PERMIT_DENY
| 0x10
| User is trying to interact with someone blocked by their own settings
|-
| ERROR__CODE_TOO_EVIL_SENDER
| 0x11
| Sender is too evil
|-
| ERROR__CODE_TOO_EVIL_RECEIVER
| 0x12
| Receiver is too evil
|-
| ERROR__CODE_USER_TEMP_UNAVAIL
| 0x13
| User is migrating or the host is down
|-
| ERROR__CODE_NO_MATCH
| 0x14
| Item was not found
|-
| ERROR__CODE_LIST_OVERFLOW
| 0x15
| Too many items were specified in a list
|-
| ERROR__CODE_REQUEST_AMBIGOUS
| 0x16
| Host could not figure out which item to operate on
|-
| ERROR__CODE_QUEUE_FULL
| 0x17
| NOT YET DOCUMENTED
|-
| ERROR__CODE_NOT_WHILE_ON_AOL
| 0x18
| The operation cannot be performed with an AOL or CompuServe 2000 client logged in.
|-
| ERROR__CODE_QUERY_FAIL
| 0x19
| NOT YET DOCUMENTED
|-
| ERROR__CODE_TIMEOUT
| 0x1A
| Operation timed out before being completed
|-
| ERROR__CODE_ERROR_TEXT
| 0x1B
| NOT YET DOCUMENTED
|-
| ERROR__CODE_GENERAL_FAILURE
| 0x1C
| General failure
|-
| ERROR__CODE_PROGRESS
| 0x1D
| NOT YET DOCUMENTED
|-
| ERROR__CODE_IN_FREE_AREA
| 0x1E
| NOT YET DOCUMENTED
|-
| ERROR__CODE_RESTRICTED_BY_PC
| 0x1F
| Restricted by parental controls
|-
| ERROR__CODE_REMOTE_RESTRICTED_BY_PC
| 0x20
| Remote user is restricted by parental controls
|}
=== From Aleksandr Shutko: Complete SNAC(xx,01) error list ===
<table width=640 bgcolor=darkblue cellSpacing=0 cellPadding=0 border=0><tr><td>
<table width=100% cellSpacing=2 cellPadding=0 border=0><tr><td  bgcolor=#4040FF >
<table width=100% cellSpacing=0 cellPadding=0 border=0>
<tr>
<td><b><font color="white">Complete SNAC(xx,01) error list&nbsp;</font></b></td>
<td width=40% align=right><b><font color="white">&nbsp;</font></b></td>
</tr>
</table>
</td></tr>
</table>
</td></tr></table>
<table width=640 cellSpacing=0 cellPadding=0 border=0>
<tr>
<td>
<br>
Here is the list of the known error codes for families error SNACs(xx,01).
<br><br>
<table width=640 bgcolor=darkblue cellSpacing=0 cellPadding=0 border=0><tr><td>
<table width=100% cellSpacing=2 cellPadding=0 border=0><tr><td  bgcolor=white >
<table width=640 cellSpacing=1 cellPadding=1 border=0>
<tr>
<td bgcolor=#E9E9E9 width=90 valign=top>&nbsp;&nbsp;<b><font color=blue>0x01</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Invalid SNAC header.</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x02</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Server rate limit exceeded</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x03</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Client rate limit exceeded</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x04</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Recipient is not logged in</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x05</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Requested service unavailable</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x06</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Requested service not defined</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x07</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;You sent obsolete SNAC</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x08</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Not supported by server</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x09</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Not supported by client</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x0A</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Refused by client</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x0B</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Reply too big</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x0C</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Responses lost</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x0D</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Request denied</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x0E</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Incorrect SNAC format</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x0F</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Insufficient rights</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x10</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;In local permit/deny (recipient blocked)</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x11</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Sender too evil</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x12</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Receiver too evil</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x13</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;User temporarily unavailable</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x14</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;No match</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x15</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;List overflow</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x16</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Request ambiguous</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x17</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Server queue full</td>
</tr>
<tr>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;<b><font color=blue>0x18</font></b></td>
<td bgcolor=#E9E9E9 valign=top>&nbsp;&nbsp;Not while on AOL</td>
</tr>
</table>
</td></tr></table>
</td></tr></table>
</td></tr></table>
[[Category:With_Contrib]]


[[Category:Stub]]
[[Category:Stub]]

Latest revision as of 06:27, 13 February 2021

OSCAR Protocol
IntroductionTermsClients
Basic
DatatypesFLAPSNACTLV
UUIDsErrorsTool IDs
Host Interaction
Rate LimitsMigrationMessages
Other Services
ADMINADVERTALERT
BARTBOSBUCPCHAT
CHAT_NAV
Tutorials
Sign OnBARTRendezvous
ICBMLocateBuddies
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)


Errors are implemented in a common way for all foodgroups each having a SNAC as subgroup 0x01. For the most part, subgroup 0x01 allows errors sent from either client or host, but in some cases it may only be from the host, for the time being. It should always be assumed, however, that this may change in the future.

TLV Class: ERROR__TAGS

These are common tags used by error SNACs.

Name Type Length Value
ERROR__TAGS_FAIL_URL 0x04 string URL with more detail
ERROR__TAGS_ERROR_SUBCODE 0x08 uint16 (word) Foodgroup-specific error code
ERROR__TAGS_ERROR_TEXT 0x1B string String error message text
ERROR__TAGS_ERROR_INFO_CLSID 0x29 UUID UUID specifying format of ERROR_INFO_DATA data
ERROR__TAGS_ERROR_INFO_DATA 0x2A blob Extra information describing error

Class: ERROR__CODE

Generic error codes

Name Value Notes
ERROR__CODE_INVALID_SNAC 0x01 Not a known SNAC
ERROR__CODE_RATE_TO_HOST 0x02 Exceed the rate limit to host
ERROR__CODE_RATE_TO_CLIENT 0x03 Exceed the rate limit to the remote user
ERROR__CODE_NOT_LOGGED_ON 0x04 Remote user is not logged in
ERROR__CODE_SERVICE_UNAVAILABLE 0x05 Normally available but something is wrong right now
ERROR__CODE_SERVICE_NOT_DEFINED 0x06 Requested a service that does not exist
ERROR__CODE_OBSOLETE_SNAC 0x07 This SNAC is known no longer supported
ERROR__CODE_NOT_SUPPORTED_BY_HOST 0x08 Unknown SNAC
ERROR__CODE_NOT_SUPPORTED_BY_CLIENT 0x09 Remote user is on but does not support the request
ERROR__CODE_REFUSED_BY_CLIENT 0x0A Message is bigger then remote client wants
ERROR__CODE_REPLY_TOO_BIG 0x0B Message from remote client bigger than host wants
ERROR__CODE_RESPONSES_LOST 0x0C Unexpected error occurred and response was dropped
ERROR__CODE_REQUEST_DENIED 0x0D Host said user or client is not allowed to do this
ERROR__CODE_BUSTED_SNAC_PAYLOAD 0x0E SNAC is too small or is not in the right format
ERROR__CODE_INSUFFICIENT_RIGHTS 0x0F User or client does not have the correct rights to make the request
ERROR__CODE_IN_LOCAL_PERMIT_DENY 0x10 User is trying to interact with someone blocked by their own settings
ERROR__CODE_TOO_EVIL_SENDER 0x11 Sender is too evil
ERROR__CODE_TOO_EVIL_RECEIVER 0x12 Receiver is too evil
ERROR__CODE_USER_TEMP_UNAVAIL 0x13 User is migrating or the host is down
ERROR__CODE_NO_MATCH 0x14 Item was not found
ERROR__CODE_LIST_OVERFLOW 0x15 Too many items were specified in a list
ERROR__CODE_REQUEST_AMBIGOUS 0x16 Host could not figure out which item to operate on
ERROR__CODE_QUEUE_FULL 0x17 NOT YET DOCUMENTED
ERROR__CODE_NOT_WHILE_ON_AOL 0x18 The operation cannot be performed with an AOL or CompuServe 2000 client logged in.
ERROR__CODE_QUERY_FAIL 0x19 NOT YET DOCUMENTED
ERROR__CODE_TIMEOUT 0x1A Operation timed out before being completed
ERROR__CODE_ERROR_TEXT 0x1B NOT YET DOCUMENTED
ERROR__CODE_GENERAL_FAILURE 0x1C General failure
ERROR__CODE_PROGRESS 0x1D NOT YET DOCUMENTED
ERROR__CODE_IN_FREE_AREA 0x1E NOT YET DOCUMENTED
ERROR__CODE_RESTRICTED_BY_PC 0x1F Restricted by parental controls
ERROR__CODE_REMOTE_RESTRICTED_BY_PC 0x20 Remote user is restricted by parental controls

From Aleksandr Shutko: Complete SNAC(xx,01) error list

Complete SNAC(xx,01) error list   


Here is the list of the known error codes for families error SNACs(xx,01).

  0x01   Invalid SNAC header.
  0x02   Server rate limit exceeded
  0x03   Client rate limit exceeded
  0x04   Recipient is not logged in
  0x05   Requested service unavailable
  0x06   Requested service not defined
  0x07   You sent obsolete SNAC
  0x08   Not supported by server
  0x09   Not supported by client
  0x0A   Refused by client
  0x0B   Reply too big
  0x0C   Responses lost
  0x0D   Request denied
  0x0E   Incorrect SNAC format
  0x0F   Insufficient rights
  0x10   In local permit/deny (recipient blocked)
  0x11   Sender too evil
  0x12   Receiver too evil
  0x13   User temporarily unavailable
  0x14   No match
  0x15   List overflow
  0x16   Request ambiguous
  0x17   Server queue full
  0x18   Not while on AOL