Difference between revisions of "MYTH PROTO VERSION (Myth Protocol)"

From MythTV Official Wiki
Jump to: navigation, search
m (remove telnet references)
(Description: Updates about the client token, since the previous text didn't at all portray its true meaning and importance)
Line 13: Line 13:
  
 
=== Description ===
 
=== Description ===
If the version number given matches the protocol version number spoken by the server, the command will succeed. Otherwise, the command will fail.  This should always be the first command sent by a client when it connects to insure that it will be understood by the server. The token is a simple randomly generated string, to ensure the client has been updated to support the version it claims to use.
+
If the version number and client token given matches the protocol version number spoken by the server, and the client token associated with this version, the command will succeed. Otherwise, the command will fail.  This should always be the first command sent by a client when it connects to insure that it will be understood by the server.  
 +
 
 +
The client token is a simple randomly generated string, unique for each version of the protocol. Its purpose is to ensure that the client has been updated to support the version it claims to use; this makes it a bit harder for people to write "bad" MythTV client code which just tries to "guess" protocol versions, without updating the client code.
  
 
=== Returns ===
 
=== Returns ===

Revision as of 20:09, 7 December 2010

MYTH_PROTO_VERSION

Arguments

Command arguments: <client protocol version> <client protocol token>

List arguments: none

Examples

Command:

30      MYTH_PROTO_VERSION 62 78B5631E

Response:

13      ACCEPT[]:[]62

Description

If the version number and client token given matches the protocol version number spoken by the server, and the client token associated with this version, the command will succeed. Otherwise, the command will fail. This should always be the first command sent by a client when it connects to insure that it will be understood by the server.

The client token is a simple randomly generated string, unique for each version of the protocol. Its purpose is to ensure that the client has been updated to support the version it claims to use; this makes it a bit harder for people to write "bad" MythTV client code which just tries to "guess" protocol versions, without updating the client code.

Returns

Successful response:

ACCEPT[]:[]<server protocol version>

Unsuccessful response:

REJECT[]:[]<server protocol version>

Changelog

version changeset description
1 [3021] initial version
62 [26280] added protocol token