3
edits
UDP API DEV: Difference between revisions
Request GOINGDOWN notification response
(Request GOINGDOWN notification response) |
|||
| Line 188: | Line 188: | ||
* comp=1 means that the client supports compression ([http://java.sun.com/j2se/1.5.0/docs/api/java/util/zip/Deflater.html DEFLATE]). The server will compress (instead of truncating) the datagrams when needed if this option is enabled. The first two bytes of compressed datagrams will always be set to zero. (So tags should never start with that.) | * comp=1 means that the client supports compression ([http://java.sun.com/j2se/1.5.0/docs/api/java/util/zip/Deflater.html DEFLATE]). The server will compress (instead of truncating) the datagrams when needed if this option is enabled. The first two bytes of compressed datagrams will always be set to zero. (So tags should never start with that.) | ||
* Default [http://en.wikipedia.org/wiki/MTU_(networking) mtu] is 1400. Min = 400, Max = 1400. | * Default [http://en.wikipedia.org/wiki/MTU_(networking) mtu] is 1400. Min = 400, Max = 1400. | ||
== API Status Notification == | |||
=== GOINGDOWN === | |||
Clients with any notification on will receive the GOINGDOWN message before the API goes offline. | |||
'''Notification Packet Format:''' | |||
XXX {int4 notify_packet_id} NOTIFICATION | |||
{int4 time_online}|{int4 comment} | |||
'''Info:''' | |||
* time_online is time the API should be up again, 0 if indefinite (client can direct user to the anidb site for status updates) | |||
* comment can tell the user the reason for the API to go down and/or tell where to check for status updates | |||