Difference between revisions of "KAG Server Record"
(Created page with "Each server on record via the API has attributes associated with it. These include '''address:''' the primary IPv4 or IPV6 server address (string) '''additionalAddress:''' a se...") |
|||
| Line 1: | Line 1: | ||
Each server on record via the API has attributes associated with it. These include | Each server on record via the API has attributes associated with it. These include | ||
| − | '''address:''' the primary IPv4 or IPV6 server address (string) | + | '''address:''' the primary IPv4 or IPV6 server address (string)<br> |
| − | '''additionalAddress:''' a secondary IPv4 or IPv6 server address (string) | + | '''additionalAddress:''' a secondary IPv4 or IPv6 server address (string)<br> |
| − | ('''Note:''' A server may only have one each of IPv4 and IPv6 addresses associated with it.) | + | ('''Note:''' A server may only have one each of IPv4 and IPv6 addresses associated with it.)<br> |
| − | ('''Note:''' IPv6 is not actually supported in the KAG engine/codebase yet, however servers which are IPv6-enabled will register as IPv4+IPv6 with the API. The IPv6 addresses are not currently given back to clients though.) | + | ('''Note:''' IPv6 is not actually supported in the KAG engine/codebase yet, however servers which are IPv6-enabled will register as IPv4+IPv6 with the API. The IPv6 addresses are not currently given back to clients though.)<br> |
| − | port: the game port that the server is bound to | + | '''port''': the game port that the server is bound to<br> |
| − | '''maxPlayers:''' the maximum number of players allowed in the server (int) | + | '''maxPlayers:''' the maximum number of players allowed in the server (int)<br> |
| − | '''currentPlayers:''' the current number of players in the server (int) | + | '''currentPlayers:''' the current number of players in the server (int)<br> |
| − | '''gameMode:''' current gamemode (int) | + | '''gameMode:''' current gamemode (int)<br> |
| − | '''password:''' whether or not the server has a password (bool) | + | '''password:''' whether or not the server has a password (bool)<br> |
| − | '''gold: whether or not the server is gold/premium-only (bool) | + | '''gold: whether or not the server is gold/premium-only (bool)<br> |
| − | '''preferAF:''' if the server has a preference that clients use IPv4 or IPv6, it is indicated here (int 4, 6, or 0 [zero means no preference in which case the client preference is used. if no preference in the client, it prefers IPv6 if available]) | + | '''preferAF:''' if the server has a preference that clients use IPv4 or IPv6, it is indicated here (int 4, 6, or 0 [zero means no preference in which case the client preference is used. if no preference in the client, it prefers IPv6 if available])<br> |
| − | '''firstSeen:''' the first time this server (identified by its primary address and port) was ever seen | + | '''firstSeen:''' the first time this server (identified by its primary address and port) was ever seen<br> |
| − | '''lastUpdate:''' the last time this server checked in | + | '''lastUpdate:''' the last time this server checked in<br> |
| − | '''thisStart:''' the first time the server was seen this "session" (within the window that it is considered active, currently determined by the API and currently 60 seconds) | + | '''thisStart:''' the first time the server was seen this "session" (within the window that it is considered active, currently determined by the API and currently 60 seconds)<br> |
| − | registeredFrom:''' the IP address that first registered this server. Most of the time this will be the same as the server's primary address. It will almost always be the server's primary or additional address but may be a past secondary address | + | registeredFrom:''' the IP address that first registered this server. Most of the time this will be the same as the server's primary address. It will almost always be the server's primary or additional address but may be a past secondary address<br> |
| − | '''updatedFrom:''' the last IP address to update this server's record. Most of the time this will be the same as the server's primary address. It will always be the server's primary or additional address. | + | '''updatedFrom:''' the last IP address to update this server's record. Most of the time this will be the same as the server's primary address. It will always be the server's primary or additional address. <br> |
(Planned/not yet implemented) only servers which are actually connectable will be registered in the list. The API will verify that the server is reachable before listing it. | (Planned/not yet implemented) only servers which are actually connectable will be registered in the list. The API will verify that the server is reachable before listing it. | ||
Revision as of 21:18, 18 April 2012
Each server on record via the API has attributes associated with it. These include
address: the primary IPv4 or IPV6 server address (string)
additionalAddress: a secondary IPv4 or IPv6 server address (string)
(Note: A server may only have one each of IPv4 and IPv6 addresses associated with it.)
(Note: IPv6 is not actually supported in the KAG engine/codebase yet, however servers which are IPv6-enabled will register as IPv4+IPv6 with the API. The IPv6 addresses are not currently given back to clients though.)
port: the game port that the server is bound to
maxPlayers: the maximum number of players allowed in the server (int)
currentPlayers: the current number of players in the server (int)
gameMode: current gamemode (int)
password: whether or not the server has a password (bool)
gold: whether or not the server is gold/premium-only (bool)
preferAF: if the server has a preference that clients use IPv4 or IPv6, it is indicated here (int 4, 6, or 0 [zero means no preference in which case the client preference is used. if no preference in the client, it prefers IPv6 if available])
firstSeen: the first time this server (identified by its primary address and port) was ever seen
lastUpdate: the last time this server checked in
thisStart: the first time the server was seen this "session" (within the window that it is considered active, currently determined by the API and currently 60 seconds)
registeredFrom: the IP address that first registered this server. Most of the time this will be the same as the server's primary address. It will almost always be the server's primary or additional address but may be a past secondary address
updatedFrom: the last IP address to update this server's record. Most of the time this will be the same as the server's primary address. It will always be the server's primary or additional address.
(Planned/not yet implemented) only servers which are actually connectable will be registered in the list. The API will verify that the server is reachable before listing it.
