UDP API Definition: Difference between revisions

Jump to navigation Jump to search
Line 954: Line 954:


'''Info:'''
'''Info:'''
* This command does not require a session.
* May be used by a frontend to determine if the API is still available.
* May be used by a frontend to determine if the API is still available.
* May be executed even if not yet logged in.
* May be executed even if not yet logged in.
* The option <tt>nat=1</tt> provides an easy way to determine if the router has changed the outgoing port. ([http://tracker.anidb.info/view.php?id=587 587])
* The option <tt>nat=1</tt> provides an easy way to determine if the router has changed the outgoing port. ([http://tracker.anidb.info/view.php?id=587 587])
----
=== VERSION: Retrieve Server Version ===
'''Command String:'''
* VERSION
'''Possible Replies:'''
* 998 VERSION
: {str server version}
'''Info:'''
* This command does not require a session.
----
=== UPTIME: Retrieve Server Uptime ===
'''Command String:'''
* UPTIME
'''Possible Replies:'''
* 208 UPTIME
: {int4 udpserver uptime in milliseconds}
'''Info:'''
* This command is the preferred way to check that the session is OK.


----
----


=== ENCODING: Change Encoding for Session ===
=== ENCODING: Change Encoding for Session ===
Sets preferred [http://en.wikipedia.org/wiki/Character_encoding encoding] per session.
Sets preferred [http://en.wikipedia.org/wiki/Character_encoding encoding] per session. The preferred way to do this is to use the '''enc''' argument for AUTH. This command is mostly for testing.


'''Command String:'''
'''Command String:'''
Line 971: Line 998:


'''Info:'''
'''Info:'''
* This command does not require a session.
* Supported encodings: http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html
* Supported encodings: http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html
* Default: ASCII.
* Default: ASCII.
Line 1,004: Line 1,032:
'''Info:'''
'''Info:'''
* The client should the check length (3-10) and case (lower) of ''user'' before sending.
* The client should the check length (3-10) and case (lower) of ''user'' before sending.
----
=== UPTIME: Retrieve Server Uptime ===
'''Command String:'''
* UPTIME
'''Possible Replies:'''
* 208 UPTIME
: {int4 udpserver uptime in milliseconds}
'''Info:'''
* This command requires a session.
* This command is the preferred way to check that the session is OK.
----
=== VERSION: Retrieve Server Version ===
'''Command String:'''
* VERSION
'''Possible Replies:'''
* 998 VERSION
: {str server version}


----
----
Retrieved from "https://wiki.anidb.net/UDP_API_Definition"