steam-condenser 1.2.0 → 1.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (371) hide show
  1. data/Gemfile.lock +7 -7
  2. data/README.md +9 -2
  3. data/doc/A2M_GET_SERVERS_BATCH2_Packet.html +426 -0
  4. data/doc/A2S_INFO_Packet.html +260 -0
  5. data/doc/A2S_PLAYER_Packet.html +295 -0
  6. data/doc/A2S_RULES_Packet.html +296 -0
  7. data/doc/A2S_SERVERQUERY_GETCHALLENGE_Packet.html +261 -0
  8. data/doc/AbstractL4DStats.html +978 -0
  9. data/doc/AbstractL4DWeapon.html +734 -0
  10. data/doc/Achievement.html +660 -0
  11. data/doc/AlienSwarmMission.html +1557 -0
  12. data/doc/AlienSwarmStats.html +965 -0
  13. data/doc/AlienSwarmWeapon.html +640 -0
  14. data/doc/AppNews.html +1442 -0
  15. data/doc/C2M_CHECKMD5_Packet.html +341 -0
  16. data/doc/CSSMap.html +806 -0
  17. data/doc/CSSStats.html +825 -0
  18. data/doc/CSSWeapon.html +889 -0
  19. data/doc/Cacheable.html +913 -0
  20. data/doc/Cacheable/ClassMethods.html +696 -0
  21. data/doc/DefenseGridStats.html +2559 -0
  22. data/doc/DoDSClass.html +1264 -0
  23. data/doc/DoDSStats.html +486 -0
  24. data/doc/DoDSWeapon.html +806 -0
  25. data/doc/Dota2BetaInventory.html +339 -0
  26. data/doc/Dota2Inventory.html +339 -0
  27. data/doc/Dota2Item.html +388 -0
  28. data/doc/Dota2Stats.html +366 -0
  29. data/doc/GameAchievement.html +1257 -0
  30. data/doc/GameClass.html +321 -0
  31. data/doc/GameInventory.html +1363 -0
  32. data/doc/GameItem.html +1339 -0
  33. data/doc/GameLeaderboard.html +1609 -0
  34. data/doc/GameLeaderboardEntry.html +629 -0
  35. data/doc/GameSchema.html +568 -0
  36. data/doc/GameServer.html +2405 -0
  37. data/doc/GameStats.html +1461 -0
  38. data/doc/GameWeapon.html +590 -0
  39. data/doc/GoldSrcServer.html +740 -0
  40. data/doc/GoldSrcSocket.html +850 -0
  41. data/doc/ItemSchema.html +780 -0
  42. data/doc/L4D2Map.html +739 -0
  43. data/doc/L4D2Stats.html +930 -0
  44. data/doc/L4D2Weapon.html +486 -0
  45. data/doc/L4DExplosive.html +374 -0
  46. data/doc/L4DMap.html +776 -0
  47. data/doc/L4DStats.html +530 -0
  48. data/doc/L4DWeapon.html +296 -0
  49. data/doc/M2A_SERVER_BATCH_Packet.html +430 -0
  50. data/doc/M2C_ISVALIDMD5_Packet.html +383 -0
  51. data/doc/M2S_REQUESTRESTART_Packet.html +382 -0
  52. data/doc/MasterServer.html +1070 -0
  53. data/doc/MasterServerSocket.html +293 -0
  54. data/doc/Module.html +194 -0
  55. data/doc/PacketFormatError.html +257 -0
  56. data/doc/Portal2Inventory.html +339 -0
  57. data/doc/Portal2Item.html +499 -0
  58. data/doc/Portal2Stats.html +368 -0
  59. data/doc/RCONAuthRequest.html +318 -0
  60. data/doc/RCONAuthResponse.html +305 -0
  61. data/doc/RCONBanError.html +247 -0
  62. data/doc/RCONExecRequest.html +318 -0
  63. data/doc/RCONExecResponse.html +407 -0
  64. data/doc/RCONGoldSrcRequest.html +363 -0
  65. data/doc/RCONGoldSrcResponse.html +367 -0
  66. data/doc/RCONNoAuthError.html +247 -0
  67. data/doc/RCONPacket.html +548 -0
  68. data/doc/RCONPacketFactory.html +300 -0
  69. data/doc/RCONSocket.html +669 -0
  70. data/doc/RCONTerminator.html +304 -0
  71. data/doc/RequestWithChallenge.html +233 -0
  72. data/doc/S2A_INFO2_Packet.html +371 -0
  73. data/doc/S2A_INFO_BasePacket.html +357 -0
  74. data/doc/S2A_INFO_DETAILED_Packet.html +370 -0
  75. data/doc/S2A_LOGSTRING_Packet.html +373 -0
  76. data/doc/S2A_PLAYER_Packet.html +417 -0
  77. data/doc/S2A_RULES_Packet.html +411 -0
  78. data/doc/S2C_CHALLENGE_Packet.html +370 -0
  79. data/doc/S2M_HEARTBEAT2_Packet.html +444 -0
  80. data/doc/Server.html +781 -0
  81. data/doc/SourceServer.html +776 -0
  82. data/doc/SourceSocket.html +366 -0
  83. data/doc/StatsAttribute.html +514 -0
  84. data/doc/SteamCondenser.html +155 -0
  85. data/doc/SteamCondenser/A2M_GET_SERVERS_BATCH2_Packet.html +413 -0
  86. data/doc/SteamCondenser/A2S_INFO_Packet.html +249 -0
  87. data/doc/SteamCondenser/A2S_PLAYER_Packet.html +281 -0
  88. data/doc/SteamCondenser/A2S_RULES_Packet.html +282 -0
  89. data/doc/SteamCondenser/A2S_SERVERQUERY_GETCHALLENGE_Packet.html +250 -0
  90. data/doc/SteamCondenser/AbstractL4DStats.html +954 -0
  91. data/doc/SteamCondenser/AbstractL4DWeapon.html +703 -0
  92. data/doc/SteamCondenser/AlienSwarmMission.html +1494 -0
  93. data/doc/SteamCondenser/AlienSwarmStats.html +938 -0
  94. data/doc/SteamCondenser/AlienSwarmWeapon.html +614 -0
  95. data/doc/SteamCondenser/AppNews.html +1387 -0
  96. data/doc/SteamCondenser/C2M_CHECKMD5_Packet.html +327 -0
  97. data/doc/SteamCondenser/CSSMap.html +774 -0
  98. data/doc/SteamCondenser/CSSStats.html +799 -0
  99. data/doc/SteamCondenser/CSSWeapon.html +855 -0
  100. data/doc/SteamCondenser/Cacheable.html +698 -0
  101. data/doc/SteamCondenser/Cacheable/ClassMethods.html +531 -0
  102. data/doc/SteamCondenser/Community.html +134 -0
  103. data/doc/SteamCondenser/DefenseGridStats.html +2455 -0
  104. data/doc/SteamCondenser/DoDSClass.html +1209 -0
  105. data/doc/SteamCondenser/DoDSStats.html +470 -0
  106. data/doc/SteamCondenser/DoDSWeapon.html +774 -0
  107. data/doc/SteamCondenser/Error.html +156 -0
  108. data/doc/SteamCondenser/Error/PacketFormat.html +246 -0
  109. data/doc/SteamCondenser/Error/RCONBan.html +237 -0
  110. data/doc/SteamCondenser/Error/RCONNoAuth.html +236 -0
  111. data/doc/SteamCondenser/Error/Timeout.html +238 -0
  112. data/doc/SteamCondenser/Error/WebApi.html +339 -0
  113. data/doc/SteamCondenser/GameAchievement.html +1210 -0
  114. data/doc/SteamCondenser/GameClass.html +306 -0
  115. data/doc/SteamCondenser/GameInventory.html +1236 -0
  116. data/doc/SteamCondenser/GameItem.html +1282 -0
  117. data/doc/SteamCondenser/GameLeaderboard.html +1562 -0
  118. data/doc/SteamCondenser/GameLeaderboardEntry.html +604 -0
  119. data/doc/SteamCondenser/GameServer.html +2337 -0
  120. data/doc/SteamCondenser/GameStats.html +1416 -0
  121. data/doc/SteamCondenser/GameWeapon.html +566 -0
  122. data/doc/SteamCondenser/GoldSrcServer.html +716 -0
  123. data/doc/SteamCondenser/GoldSrcSocket.html +831 -0
  124. data/doc/SteamCondenser/L4D2Map.html +713 -0
  125. data/doc/SteamCondenser/L4D2Stats.html +906 -0
  126. data/doc/SteamCondenser/L4D2Weapon.html +466 -0
  127. data/doc/SteamCondenser/L4DExplosive.html +362 -0
  128. data/doc/SteamCondenser/L4DMap.html +746 -0
  129. data/doc/SteamCondenser/L4DStats.html +513 -0
  130. data/doc/SteamCondenser/L4DWeapon.html +284 -0
  131. data/doc/SteamCondenser/M2A_SERVER_BATCH_Packet.html +415 -0
  132. data/doc/SteamCondenser/M2C_ISVALIDMD5_Packet.html +368 -0
  133. data/doc/SteamCondenser/M2S_REQUESTRESTART_Packet.html +367 -0
  134. data/doc/SteamCondenser/MasterServer.html +1046 -0
  135. data/doc/SteamCondenser/MasterServerSocket.html +282 -0
  136. data/doc/SteamCondenser/Portal2Inventory.html +217 -0
  137. data/doc/SteamCondenser/Portal2Item.html +483 -0
  138. data/doc/SteamCondenser/Portal2Stats.html +353 -0
  139. data/doc/SteamCondenser/RCONAuthRequest.html +306 -0
  140. data/doc/SteamCondenser/RCONAuthResponse.html +293 -0
  141. data/doc/SteamCondenser/RCONExecRequest.html +306 -0
  142. data/doc/SteamCondenser/RCONExecResponse.html +392 -0
  143. data/doc/SteamCondenser/RCONGoldSrcRequest.html +349 -0
  144. data/doc/SteamCondenser/RCONGoldSrcResponse.html +354 -0
  145. data/doc/SteamCondenser/RCONPacket.html +530 -0
  146. data/doc/SteamCondenser/RCONPacketFactory.html +293 -0
  147. data/doc/SteamCondenser/RCONSocket.html +649 -0
  148. data/doc/SteamCondenser/RCONTerminator.html +292 -0
  149. data/doc/SteamCondenser/RequestWithChallenge.html +223 -0
  150. data/doc/SteamCondenser/S2A_INFO2_Packet.html +359 -0
  151. data/doc/SteamCondenser/S2A_INFO_BasePacket.html +342 -0
  152. data/doc/SteamCondenser/S2A_INFO_DETAILED_Packet.html +358 -0
  153. data/doc/SteamCondenser/S2A_LOGSTRING_Packet.html +358 -0
  154. data/doc/SteamCondenser/S2A_PLAYER_Packet.html +402 -0
  155. data/doc/SteamCondenser/S2A_RULES_Packet.html +396 -0
  156. data/doc/SteamCondenser/S2C_CHALLENGE_Packet.html +356 -0
  157. data/doc/SteamCondenser/S2M_HEARTBEAT2_Packet.html +430 -0
  158. data/doc/SteamCondenser/Server.html +754 -0
  159. data/doc/SteamCondenser/Servers.html +133 -0
  160. data/doc/SteamCondenser/SourceServer.html +752 -0
  161. data/doc/SteamCondenser/SourceSocket.html +355 -0
  162. data/doc/SteamCondenser/SteamGame.html +1802 -0
  163. data/doc/SteamCondenser/SteamGroup.html +969 -0
  164. data/doc/SteamCondenser/SteamId.html +4242 -0
  165. data/doc/SteamCondenser/SteamPacket.html +456 -0
  166. data/doc/SteamCondenser/SteamPacketFactory.html +521 -0
  167. data/doc/SteamCondenser/SteamPlayer.html +1696 -0
  168. data/doc/SteamCondenser/SteamSocket.html +679 -0
  169. data/doc/SteamCondenser/TF2BetaInventory.html +198 -0
  170. data/doc/SteamCondenser/TF2Class.html +1145 -0
  171. data/doc/SteamCondenser/TF2ClassFactory.html +263 -0
  172. data/doc/SteamCondenser/TF2Engineer.html +534 -0
  173. data/doc/SteamCondenser/TF2GoldenWrench.html +731 -0
  174. data/doc/SteamCondenser/TF2Inventory.html +217 -0
  175. data/doc/SteamCondenser/TF2Item.html +482 -0
  176. data/doc/SteamCondenser/TF2Medic.html +445 -0
  177. data/doc/SteamCondenser/TF2Sniper.html +357 -0
  178. data/doc/SteamCondenser/TF2Spy.html +531 -0
  179. data/doc/SteamCondenser/TF2Stats.html +670 -0
  180. data/doc/SteamCondenser/TimeoutError.html +249 -0
  181. data/doc/SteamCondenser/WebApi.html +999 -0
  182. data/doc/SteamCondenser/XMLData.html +171 -0
  183. data/doc/SteamCondenserError.html +153 -0
  184. data/doc/SteamGame.html +1859 -0
  185. data/doc/SteamGroup.html +1012 -0
  186. data/doc/SteamId.html +4369 -0
  187. data/doc/SteamPacket.html +469 -0
  188. data/doc/SteamPacketFactory.html +545 -0
  189. data/doc/SteamPlayer.html +1766 -0
  190. data/doc/SteamSocket.html +699 -0
  191. data/doc/StringIO.html +947 -0
  192. data/doc/TF2BetaInventory.html +315 -0
  193. data/doc/TF2Class.html +1194 -0
  194. data/doc/TF2ClassFactory.html +273 -0
  195. data/doc/TF2Engineer.html +558 -0
  196. data/doc/TF2GoldenWrench.html +760 -0
  197. data/doc/TF2Inventory.html +339 -0
  198. data/doc/TF2Item.html +499 -0
  199. data/doc/TF2Medic.html +465 -0
  200. data/doc/TF2Sniper.html +373 -0
  201. data/doc/TF2Spy.html +555 -0
  202. data/doc/TF2Stats.html +696 -0
  203. data/doc/WebApi.html +1021 -0
  204. data/doc/WebApiError.html +347 -0
  205. data/doc/XMLData.html +253 -0
  206. data/doc/_index.html +717 -0
  207. data/doc/class_list.html +53 -0
  208. data/doc/css/common.css +1 -0
  209. data/doc/css/full_list.css +57 -0
  210. data/doc/css/style.css +328 -0
  211. data/doc/file.LICENSE.html +100 -0
  212. data/doc/file.README.html +136 -0
  213. data/doc/file_list.html +58 -0
  214. data/doc/frames.html +28 -0
  215. data/doc/index.html +136 -0
  216. data/doc/js/app.js +214 -0
  217. data/doc/js/full_list.js +173 -0
  218. data/doc/js/jquery.js +4 -0
  219. data/doc/method_list.html +3988 -0
  220. data/doc/methods_list.html +3900 -0
  221. data/doc/top-level-namespace.html +114 -0
  222. data/lib/steam-condenser/version.rb +1 -1
  223. data/lib/steam/community/cacheable.rb +105 -44
  224. data/lib/steam/community/dota2/dota2_beta_inventory.rb +27 -0
  225. data/lib/steam/community/dota2/dota2_inventory.rb +27 -0
  226. data/lib/steam/community/dota2/dota2_item.rb +33 -0
  227. data/lib/steam/community/game_inventory.rb +18 -16
  228. data/lib/steam/community/game_leaderboard.rb +2 -2
  229. data/lib/steam/community/game_stats.rb +1 -1
  230. data/lib/steam/community/portal2/portal2_inventory.rb +11 -9
  231. data/lib/steam/community/steam_game.rb +0 -2
  232. data/lib/steam/community/steam_group.rb +2 -7
  233. data/lib/steam/community/steam_id.rb +2 -7
  234. data/lib/steam/community/tf2/tf2_beta_inventory.rb +11 -8
  235. data/lib/steam/community/tf2/tf2_inventory.rb +11 -9
  236. data/lib/steam/community/xml_data.rb +8 -1
  237. data/lib/steam/packets/a2s_player_packet.rb +1 -1
  238. data/lib/steam/packets/a2s_rules_packet.rb +1 -1
  239. data/lib/steam/servers/master_server.rb +3 -2
  240. data/lib/steam/sockets/rcon_socket.rb +1 -2
  241. data/pkg/steam-condenser-1.2.0.gem +0 -0
  242. data/pkg/steam-condenser-1.2.0/Gemfile +3 -0
  243. data/pkg/steam-condenser-1.2.0/Gemfile.lock +30 -0
  244. data/pkg/steam-condenser-1.2.0/LICENSE +25 -0
  245. data/pkg/steam-condenser-1.2.0/README.md +47 -0
  246. data/pkg/steam-condenser-1.2.0/Rakefile +46 -0
  247. data/pkg/steam-condenser-1.2.0/lib/core_ext/stringio.rb +91 -0
  248. data/pkg/steam-condenser-1.2.0/lib/errors/packet_format_error.rb +21 -0
  249. data/pkg/steam-condenser-1.2.0/lib/errors/rcon_ban_error.rb +22 -0
  250. data/pkg/steam-condenser-1.2.0/lib/errors/rcon_no_auth_error.rb +21 -0
  251. data/pkg/steam-condenser-1.2.0/lib/errors/steam_condenser_error.rb +11 -0
  252. data/pkg/steam-condenser-1.2.0/lib/errors/timeout_error.rb +28 -0
  253. data/pkg/steam-condenser-1.2.0/lib/errors/web_api_error.rb +57 -0
  254. data/pkg/steam-condenser-1.2.0/lib/steam-condenser.rb +18 -0
  255. data/pkg/steam-condenser-1.2.0/lib/steam-condenser/community.rb +24 -0
  256. data/pkg/steam-condenser-1.2.0/lib/steam-condenser/servers.rb +24 -0
  257. data/pkg/steam-condenser-1.2.0/lib/steam-condenser/version.rb +11 -0
  258. data/pkg/steam-condenser-1.2.0/lib/steam/community/alien_swarm/alien_swarm_mission.rb +119 -0
  259. data/pkg/steam-condenser-1.2.0/lib/steam/community/alien_swarm/alien_swarm_stats.rb +179 -0
  260. data/pkg/steam-condenser-1.2.0/lib/steam/community/alien_swarm/alien_swarm_weapon.rb +49 -0
  261. data/pkg/steam-condenser-1.2.0/lib/steam/community/app_news.rb +133 -0
  262. data/pkg/steam-condenser-1.2.0/lib/steam/community/cacheable.rb +137 -0
  263. data/pkg/steam-condenser-1.2.0/lib/steam/community/css/css_map.rb +61 -0
  264. data/pkg/steam-condenser-1.2.0/lib/steam/community/css/css_stats.rb +136 -0
  265. data/pkg/steam-condenser-1.2.0/lib/steam/community/css/css_weapon.rb +69 -0
  266. data/pkg/steam-condenser-1.2.0/lib/steam/community/defense_grid/defense_grid_stats.rb +237 -0
  267. data/pkg/steam-condenser-1.2.0/lib/steam/community/dods/dods_class.rb +90 -0
  268. data/pkg/steam-condenser-1.2.0/lib/steam/community/dods/dods_stats.rb +61 -0
  269. data/pkg/steam-condenser-1.2.0/lib/steam/community/dods/dods_weapon.rb +67 -0
  270. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_achievement.rb +109 -0
  271. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_class.rb +22 -0
  272. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_inventory.rb +152 -0
  273. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_item.rb +99 -0
  274. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_leaderboard.rb +201 -0
  275. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_leaderboard_entry.rb +43 -0
  276. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_stats.rb +175 -0
  277. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_weapon.rb +41 -0
  278. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/abstract_l4d_stats.rb +173 -0
  279. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/abstract_l4d_weapon.rb +56 -0
  280. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d2_map.rb +90 -0
  281. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d2_stats.rb +165 -0
  282. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d2_weapon.rb +38 -0
  283. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_explosive.rb +34 -0
  284. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_map.rb +65 -0
  285. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_stats.rb +71 -0
  286. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_weapon.rb +26 -0
  287. data/pkg/steam-condenser-1.2.0/lib/steam/community/portal2/portal2_inventory.rb +25 -0
  288. data/pkg/steam-condenser-1.2.0/lib/steam/community/portal2/portal2_item.rb +47 -0
  289. data/pkg/steam-condenser-1.2.0/lib/steam/community/portal2/portal2_stats.rb +32 -0
  290. data/pkg/steam-condenser-1.2.0/lib/steam/community/steam_game.rb +182 -0
  291. data/pkg/steam-condenser-1.2.0/lib/steam/community/steam_group.rb +135 -0
  292. data/pkg/steam-condenser-1.2.0/lib/steam/community/steam_id.rb +513 -0
  293. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_beta_inventory.rb +22 -0
  294. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_class.rb +92 -0
  295. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_class_factory.rb +40 -0
  296. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_engineer.rb +43 -0
  297. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_golden_wrench.rb +70 -0
  298. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_inventory.rb +25 -0
  299. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_item.rb +47 -0
  300. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_medic.rb +35 -0
  301. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_sniper.rb +28 -0
  302. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_spy.rb +41 -0
  303. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_stats.rb +76 -0
  304. data/pkg/steam-condenser-1.2.0/lib/steam/community/web_api.rb +129 -0
  305. data/pkg/steam-condenser-1.2.0/lib/steam/community/xml_data.rb +17 -0
  306. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2m_get_servers_batch2_packet.rb +59 -0
  307. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_info_packet.rb +24 -0
  308. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_player_packet.rb +31 -0
  309. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_rules_packet.rb +32 -0
  310. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_serverquery_getchallenge_packet.rb +25 -0
  311. data/pkg/steam-condenser-1.2.0/lib/steam/packets/c2m_checkmd5_packet.rb +30 -0
  312. data/pkg/steam-condenser-1.2.0/lib/steam/packets/m2a_server_batch_packet.rb +52 -0
  313. data/pkg/steam-condenser-1.2.0/lib/steam/packets/m2c_isvalidmd5_packet.rb +34 -0
  314. data/pkg/steam-condenser-1.2.0/lib/steam/packets/m2s_requestrestart_packet.rb +34 -0
  315. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_auth_request.rb +28 -0
  316. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_auth_response.rb +30 -0
  317. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_exec_request.rb +28 -0
  318. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_exec_response.rb +37 -0
  319. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_goldsrc_request.rb +35 -0
  320. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_goldsrc_response.rb +34 -0
  321. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_packet.rb +57 -0
  322. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_packet_factory.rb +43 -0
  323. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_terminator.rb +29 -0
  324. data/pkg/steam-condenser-1.2.0/lib/steam/packets/request_with_challenge.rb +19 -0
  325. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_info2_packet.rb +62 -0
  326. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_info_base_packet.rb +35 -0
  327. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_info_detailed_packet.rb +61 -0
  328. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_logstring_packet.rb +30 -0
  329. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_player_packet.rb +44 -0
  330. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_rules_packet.rb +48 -0
  331. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2c_challenge_packet.rb +35 -0
  332. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2m_heartbeat2_packet.rb +71 -0
  333. data/pkg/steam-condenser-1.2.0/lib/steam/packets/steam_packet.rb +52 -0
  334. data/pkg/steam-condenser-1.2.0/lib/steam/packets/steam_packet_factory.rb +108 -0
  335. data/pkg/steam-condenser-1.2.0/lib/steam/servers/game_server.rb +392 -0
  336. data/pkg/steam-condenser-1.2.0/lib/steam/servers/goldsrc_server.rb +74 -0
  337. data/pkg/steam-condenser-1.2.0/lib/steam/servers/master_server.rb +182 -0
  338. data/pkg/steam-condenser-1.2.0/lib/steam/servers/server.rb +104 -0
  339. data/pkg/steam-condenser-1.2.0/lib/steam/servers/source_server.rb +98 -0
  340. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/goldsrc_socket.rb +142 -0
  341. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/master_server_socket.rb +30 -0
  342. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/rcon_socket.rb +94 -0
  343. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/source_socket.rb +78 -0
  344. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/steam_socket.rb +86 -0
  345. data/pkg/steam-condenser-1.2.0/lib/steam/steam_player.rb +143 -0
  346. data/pkg/steam-condenser-1.2.0/steam-condenser.gemspec +25 -0
  347. data/pkg/steam-condenser-1.2.0/test/core_ext/test_stringio.rb +59 -0
  348. data/pkg/steam-condenser-1.2.0/test/fixtures/invalid.xml +2 -0
  349. data/pkg/steam-condenser-1.2.0/test/fixtures/sonofthor.xml +882 -0
  350. data/pkg/steam-condenser-1.2.0/test/fixtures/status_goldsrc +3 -0
  351. data/pkg/steam-condenser-1.2.0/test/fixtures/status_source +3 -0
  352. data/pkg/steam-condenser-1.2.0/test/fixtures/valve-members.xml +231 -0
  353. data/pkg/steam-condenser-1.2.0/test/helper.rb +45 -0
  354. data/pkg/steam-condenser-1.2.0/test/steam/communtiy/test_steam_group.rb +83 -0
  355. data/pkg/steam-condenser-1.2.0/test/steam/communtiy/test_steam_id.rb +111 -0
  356. data/pkg/steam-condenser-1.2.0/test/steam/communtiy/test_web_api.rb +98 -0
  357. data/pkg/steam-condenser-1.2.0/test/steam/packets/test_steam_packet.rb +37 -0
  358. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_game_server.rb +296 -0
  359. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_goldsrc_server.rb +59 -0
  360. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_master_server.rb +131 -0
  361. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_server.rb +72 -0
  362. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_source_server.rb +126 -0
  363. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_goldsrc_socket.rb +127 -0
  364. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_master_server_socket.rb +42 -0
  365. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_rcon_socket.rb +109 -0
  366. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_source_socket.rb +77 -0
  367. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_steam_socket.rb +97 -0
  368. data/steam-condenser.gemspec +3 -3
  369. data/test/steam/communtiy/test_cacheable.rb +100 -0
  370. data/test/steam/servers/test_master_server.rb +3 -3
  371. metadata +366 -15
@@ -0,0 +1,1046 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: SteamCondenser::MasterServer
8
+
9
+ &mdash; Steam Condenser – Ruby API
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (M)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span>
38
+ &raquo;
39
+ <span class="title">MasterServer</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Class: SteamCondenser::MasterServer
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+ <dt class="r1">Inherits:</dt>
68
+ <dd class="r1">
69
+ <span class="inheritName">Object</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">SteamCondenser::MasterServer</li>
75
+
76
+ </ul>
77
+ <a href="#" class="inheritanceTree">show all</a>
78
+
79
+ </dd>
80
+
81
+
82
+
83
+
84
+
85
+
86
+ <dt class="r2">Includes:</dt>
87
+ <dd class="r2"><span class='object_link'><a href="Server.html" title="SteamCondenser::Server (module)">Server</a></span></dd>
88
+
89
+
90
+
91
+
92
+
93
+ <dt class="r1 last">Defined in:</dt>
94
+ <dd class="r1 last">lib/steam/servers/master_server.rb</dd>
95
+
96
+ </dl>
97
+ <div class="clear"></div>
98
+
99
+ <h2>Overview</h2><div class="docstring">
100
+ <div class="discussion">
101
+ <p>This class represents a Steam master server and can be used to get game
102
+ servers which are publicly available</p>
103
+
104
+ <p>An intance of this class can be used much like Steam&#39;s server browser to get
105
+ a list of available game servers, including filters to narrow down the search
106
+ results.</p>
107
+
108
+
109
+ </div>
110
+ </div>
111
+ <div class="tags">
112
+
113
+ <h3>Author:</h3>
114
+ <ul class="author">
115
+
116
+ <li>
117
+
118
+
119
+
120
+
121
+
122
+ <div class='inline'><p>Sebastian Staudt</p>
123
+ </div>
124
+
125
+ </li>
126
+
127
+ </ul>
128
+
129
+ </div>
130
+ <h2>Constant Summary</h2>
131
+
132
+ <dl class="constants">
133
+
134
+ <dt id="GOLDSRC_MASTER_SERVER-constant" class="">GOLDSRC_MASTER_SERVER =
135
+ <div class="docstring">
136
+ <div class="discussion">
137
+ <p>The master server address to query for GoldSrc game servers</p>
138
+
139
+
140
+ </div>
141
+ </div>
142
+ <div class="tags">
143
+
144
+
145
+ </div>
146
+ </dt>
147
+ <dd><pre class="code"><span class='string val'>'hl1master.steampowered.com'</span><span class='comma token'>,</span> <span class='integer val'>27010</span>
148
+ </pre></dd>
149
+
150
+ <dt id="SOURCE_MASTER_SERVER-constant" class="">SOURCE_MASTER_SERVER =
151
+ <div class="docstring">
152
+ <div class="discussion">
153
+ <p>The master server address to query for Source game servers</p>
154
+
155
+
156
+ </div>
157
+ </div>
158
+ <div class="tags">
159
+
160
+
161
+ </div>
162
+ </dt>
163
+ <dd><pre class="code"><span class='string val'>'hl2master.steampowered.com'</span><span class='comma token'>,</span> <span class='integer val'>27011</span>
164
+ </pre></dd>
165
+
166
+ <dt id="REGION_US_EAST_COAST-constant" class="">REGION_US_EAST_COAST =
167
+ <div class="docstring">
168
+ <div class="discussion">
169
+ <p>The region code for the US east coast</p>
170
+
171
+
172
+ </div>
173
+ </div>
174
+ <div class="tags">
175
+
176
+
177
+ </div>
178
+ </dt>
179
+ <dd><pre class="code"><span class='integer val'>0x00</span>
180
+ </pre></dd>
181
+
182
+ <dt id="REGION_US_WEST_COAST-constant" class="">REGION_US_WEST_COAST =
183
+ <div class="docstring">
184
+ <div class="discussion">
185
+ <p>The region code for the US west coast</p>
186
+
187
+
188
+ </div>
189
+ </div>
190
+ <div class="tags">
191
+
192
+
193
+ </div>
194
+ </dt>
195
+ <dd><pre class="code"><span class='integer val'>0x01</span>
196
+ </pre></dd>
197
+
198
+ <dt id="REGION_SOUTH_AMERICA-constant" class="">REGION_SOUTH_AMERICA =
199
+ <div class="docstring">
200
+ <div class="discussion">
201
+ <p>The region code for South America</p>
202
+
203
+
204
+ </div>
205
+ </div>
206
+ <div class="tags">
207
+
208
+
209
+ </div>
210
+ </dt>
211
+ <dd><pre class="code"><span class='integer val'>0x02</span>
212
+ </pre></dd>
213
+
214
+ <dt id="REGION_EUROPE-constant" class="">REGION_EUROPE =
215
+ <div class="docstring">
216
+ <div class="discussion">
217
+ <p>The region code for Europe</p>
218
+
219
+
220
+ </div>
221
+ </div>
222
+ <div class="tags">
223
+
224
+
225
+ </div>
226
+ </dt>
227
+ <dd><pre class="code"><span class='integer val'>0x03</span>
228
+ </pre></dd>
229
+
230
+ <dt id="REGION_ASIA-constant" class="">REGION_ASIA =
231
+ <div class="docstring">
232
+ <div class="discussion">
233
+ <p>The region code for Asia</p>
234
+
235
+
236
+ </div>
237
+ </div>
238
+ <div class="tags">
239
+
240
+
241
+ </div>
242
+ </dt>
243
+ <dd><pre class="code"><span class='integer val'>0x04</span>
244
+ </pre></dd>
245
+
246
+ <dt id="REGION_AUSTRALIA-constant" class="">REGION_AUSTRALIA =
247
+ <div class="docstring">
248
+ <div class="discussion">
249
+ <p>The region code for Australia</p>
250
+
251
+
252
+ </div>
253
+ </div>
254
+ <div class="tags">
255
+
256
+
257
+ </div>
258
+ </dt>
259
+ <dd><pre class="code"><span class='integer val'>0x05</span>
260
+ </pre></dd>
261
+
262
+ <dt id="REGION_MIDDLE_EAST-constant" class="">REGION_MIDDLE_EAST =
263
+ <div class="docstring">
264
+ <div class="discussion">
265
+ <p>The region code for the Middle East</p>
266
+
267
+
268
+ </div>
269
+ </div>
270
+ <div class="tags">
271
+
272
+
273
+ </div>
274
+ </dt>
275
+ <dd><pre class="code"><span class='integer val'>0x06</span>
276
+ </pre></dd>
277
+
278
+ <dt id="REGION_AFRICA-constant" class="">REGION_AFRICA =
279
+ <div class="docstring">
280
+ <div class="discussion">
281
+ <p>The region code for Africa</p>
282
+
283
+
284
+ </div>
285
+ </div>
286
+ <div class="tags">
287
+
288
+
289
+ </div>
290
+ </dt>
291
+ <dd><pre class="code"><span class='integer val'>0x07</span>
292
+ </pre></dd>
293
+
294
+ <dt id="REGION_ALL-constant" class="">REGION_ALL =
295
+ <div class="docstring">
296
+ <div class="discussion">
297
+ <p>The region code for the whole world</p>
298
+
299
+
300
+ </div>
301
+ </div>
302
+ <div class="tags">
303
+
304
+
305
+ </div>
306
+ </dt>
307
+ <dd><pre class="code"><span class='integer val'>0x</span><span class='rubyid_FF constant id'>FF</span>
308
+ </pre></dd>
309
+
310
+ <dt id="retries-classvariable" class="">@@retries =
311
+ <div class="docstring">
312
+ <div class="discussion">
313
+ <p>The default number of allowed retries</p>
314
+
315
+
316
+ </div>
317
+ </div>
318
+ <div class="tags">
319
+
320
+
321
+ </div>
322
+ </dt>
323
+ <dd><pre class="code"><span class='integer val'>3</span>
324
+ </pre></dd>
325
+
326
+ </dl>
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+ <h2>Instance Attribute Summary</h2>
335
+
336
+ <h3 class="inherited">Attributes included from <span class='object_link'><a href="Server.html" title="SteamCondenser::Server (module)">Server</a></span></h3>
337
+ <p class="inherited"><span class='object_link'><a href="Server.html#host_names-instance_method" title="SteamCondenser::Server#host_names (method)">#host_names</a></span>, <span class='object_link'><a href="Server.html#ip_addresses-instance_method" title="SteamCondenser::Server#ip_addresses (method)">#ip_addresses</a></span></p>
338
+
339
+
340
+
341
+ <h2>
342
+ Class Method Summary
343
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
344
+ </h2>
345
+
346
+ <ul class="summary">
347
+
348
+ <li class="public ">
349
+ <span class="summary_signature">
350
+
351
+ <a href="#retries%3D-class_method" title="retries= (class method)">+ (Object) <strong>retries=</strong>(retries) </a>
352
+
353
+
354
+
355
+ </span>
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+ <span class="summary_desc"><div class='inline'><p>Sets the number of consecutive requests that may fail, before getting
365
+ the server list is cancelled (default: 3).</p>
366
+ </div></span>
367
+
368
+ </li>
369
+
370
+
371
+ </ul>
372
+
373
+ <h2>
374
+ Instance Method Summary
375
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
376
+ </h2>
377
+
378
+ <ul class="summary">
379
+
380
+ <li class="public ">
381
+ <span class="summary_signature">
382
+
383
+ <a href="#challenge-instance_method" title="#challenge (instance method)">- (Fixnum) <strong>challenge</strong> </a>
384
+
385
+
386
+
387
+ </span>
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+ <span class="summary_desc"><div class='inline'><p>Request a challenge number from the master server.</p>
397
+ </div></span>
398
+
399
+ </li>
400
+
401
+
402
+ <li class="public ">
403
+ <span class="summary_signature">
404
+
405
+ <a href="#init_socket-instance_method" title="#init_socket (instance method)">- (Object) <strong>init_socket</strong> </a>
406
+
407
+
408
+
409
+ </span>
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+ <span class="summary_desc"><div class='inline'><p>Initializes the socket to communicate with the master server.</p>
419
+ </div></span>
420
+
421
+ </li>
422
+
423
+
424
+ <li class="public ">
425
+ <span class="summary_signature">
426
+
427
+ <a href="#send_heartbeat-instance_method" title="#send_heartbeat (instance method)">- (Array&lt;SteamPacket&gt;) <strong>send_heartbeat</strong>(data) </a>
428
+
429
+
430
+
431
+ </span>
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+ <span class="summary_desc"><div class='inline'><p>Sends a constructed heartbeat to the master server.</p>
441
+ </div></span>
442
+
443
+ </li>
444
+
445
+
446
+ <li class="public ">
447
+ <span class="summary_signature">
448
+
449
+ <a href="#servers-instance_method" title="#servers (instance method)">- (Array&lt;Array&lt;String&gt;&gt;) <strong>servers</strong>(region_code = MasterServer::REGION_ALL, filters = '', force = false) </a>
450
+
451
+
452
+
453
+ </span>
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+ <span class="summary_desc"><div class='inline'><p>Returns a list of game server matching the given region and filters.</p>
463
+ </div></span>
464
+
465
+ </li>
466
+
467
+
468
+ </ul>
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Server.html" title="SteamCondenser::Server (module)">Server</a></span></h3>
480
+ <p class="inherited"><span class='object_link'><a href="Server.html#failsafe-instance_method" title="SteamCondenser::Server#failsafe (method)">#failsafe</a></span>, <span class='object_link'><a href="Server.html#initialize-instance_method" title="SteamCondenser::Server#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Server.html#rotate_ip-instance_method" title="SteamCondenser::Server#rotate_ip (method)">#rotate_ip</a></span></p>
481
+ <div id="constructor_details" class="method_details_list">
482
+ <h2>Constructor Details</h2>
483
+
484
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Server.html#initialize-instance_method" title="SteamCondenser::Server#initialize (method)">SteamCondenser::Server</a></span></p>
485
+
486
+ </div>
487
+
488
+
489
+ <div id="class_method_details" class="method_details_list">
490
+ <h2>Class Method Details</h2>
491
+
492
+
493
+ <div class="method_details first">
494
+ <p class="signature first" id="retries=-class_method">
495
+
496
+ + (<tt>Object</tt>) <strong>retries=</strong>(retries)
497
+
498
+
499
+
500
+ </p><div class="docstring">
501
+ <div class="discussion">
502
+ <p>Sets the number of consecutive requests that may fail, before getting
503
+ the server list is cancelled (default: 3)</p>
504
+
505
+
506
+ </div>
507
+ </div>
508
+ <div class="tags">
509
+ <h3>Parameters:</h3>
510
+ <ul class="param">
511
+
512
+ <li>
513
+
514
+ <span class='name'>The</span>
515
+
516
+
517
+ <span class='type'>(<tt>Fixnum</tt>)</span>
518
+
519
+
520
+
521
+ &mdash;
522
+ <div class='inline'><p>number of allowed retries</p>
523
+ </div>
524
+
525
+ </li>
526
+
527
+ </ul>
528
+
529
+
530
+ </div><table class="source_code">
531
+ <tr>
532
+ <td>
533
+ <pre class="lines">
534
+
535
+
536
+ 67
537
+ 68
538
+ 69</pre>
539
+ </td>
540
+ <td>
541
+ <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 67</span>
542
+
543
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_retries identifier id'>retries</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='rubyid_retries identifier id'>retries</span><span class='rparen token'>)</span>
544
+ <span class='rubyid_@@retries ivar id'>@@retries</span> <span class='assign token'>=</span> <span class='rubyid_retries identifier id'>retries</span>
545
+ <span class='rubyid_end end kw'>end</span>
546
+ </pre>
547
+ </td>
548
+ </tr>
549
+ </table>
550
+ </div>
551
+
552
+ </div>
553
+
554
+ <div id="instance_method_details" class="method_details_list">
555
+ <h2>Instance Method Details</h2>
556
+
557
+
558
+ <div class="method_details first">
559
+ <p class="signature first" id="challenge-instance_method">
560
+
561
+ - (<tt>Fixnum</tt>) <strong>challenge</strong>
562
+
563
+
564
+
565
+ </p><div class="docstring">
566
+ <div class="discussion">
567
+
568
+ <div class="note notetag">
569
+ <strong>Note:</strong>
570
+ <div class='inline'><p>Please note that this is <strong>not</strong> needed for finding servers using
571
+ <span class='object_link'><a href="#servers-instance_method" title="SteamCondenser::MasterServer#servers (method)">#servers</a></span>.</p>
572
+ </div>
573
+ </div>
574
+
575
+ <p>Request a challenge number from the master server.</p>
576
+
577
+ <p>This is used for further communication with the master server.</p>
578
+
579
+
580
+ </div>
581
+ </div>
582
+ <div class="tags">
583
+
584
+ <h3>Returns:</h3>
585
+ <ul class="return">
586
+
587
+ <li>
588
+
589
+
590
+ <span class='type'>(<tt>Fixnum</tt>)</span>
591
+
592
+
593
+
594
+ &mdash;
595
+ <div class='inline'><p>The challenge number from the master server</p>
596
+ </div>
597
+
598
+ </li>
599
+
600
+ </ul>
601
+
602
+ <h3>See Also:</h3>
603
+ <ul class="see">
604
+
605
+ <li><span class='object_link'><a href="#send_heartbeat-instance_method" title="SteamCondenser::MasterServer#send_heartbeat (method)">#send_heartbeat</a></span></li>
606
+
607
+ </ul>
608
+
609
+ </div><table class="source_code">
610
+ <tr>
611
+ <td>
612
+ <pre class="lines">
613
+
614
+
615
+ 79
616
+ 80
617
+ 81
618
+ 82
619
+ 83
620
+ 84</pre>
621
+ </td>
622
+ <td>
623
+ <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 79</span>
624
+
625
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_challenge identifier id'>challenge</span>
626
+ <span class='rubyid_failsafe identifier id'>failsafe</span> <span class='rubyid_do do kw'>do</span>
627
+ <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span> <span class='rubyid_C2M_CHECKMD5_Packet constant id'>C2M_CHECKMD5_Packet</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span>
628
+ <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_reply identifier id'>reply</span><span class='dot token'>.</span><span class='rubyid_challenge identifier id'>challenge</span>
629
+ <span class='rubyid_end end kw'>end</span>
630
+ <span class='rubyid_end end kw'>end</span>
631
+ </pre>
632
+ </td>
633
+ </tr>
634
+ </table>
635
+ </div>
636
+
637
+ <div class="method_details ">
638
+ <p class="signature " id="init_socket-instance_method">
639
+
640
+ - (<tt>Object</tt>) <strong>init_socket</strong>
641
+
642
+
643
+
644
+ </p><div class="docstring">
645
+ <div class="discussion">
646
+ <p>Initializes the socket to communicate with the master server</p>
647
+
648
+
649
+ </div>
650
+ </div>
651
+ <div class="tags">
652
+
653
+
654
+ <h3>See Also:</h3>
655
+ <ul class="see">
656
+
657
+ <li><span class='object_link'><a href="MasterServerSocket.html" title="SteamCondenser::MasterServerSocket (class)">SteamCondenser::MasterServerSocket</a></span></li>
658
+
659
+ </ul>
660
+
661
+ </div><table class="source_code">
662
+ <tr>
663
+ <td>
664
+ <pre class="lines">
665
+
666
+
667
+ 89
668
+ 90
669
+ 91</pre>
670
+ </td>
671
+ <td>
672
+ <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 89</span>
673
+
674
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_init_socket identifier id'>init_socket</span>
675
+ <span class='rubyid_@socket ivar id'>@socket</span> <span class='assign token'>=</span> <span class='rubyid_MasterServerSocket constant id'>MasterServerSocket</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_@ip_address ivar id'>@ip_address</span><span class='comma token'>,</span> <span class='rubyid_@port ivar id'>@port</span>
676
+ <span class='rubyid_end end kw'>end</span>
677
+ </pre>
678
+ </td>
679
+ </tr>
680
+ </table>
681
+ </div>
682
+
683
+ <div class="method_details ">
684
+ <p class="signature " id="send_heartbeat-instance_method">
685
+
686
+ - (<tt>Array&lt;<span class='object_link'><a href="SteamPacket.html" title="SteamCondenser::SteamPacket (module)">SteamPacket</a></span>&gt;</tt>) <strong>send_heartbeat</strong>(data)
687
+
688
+
689
+
690
+ </p><div class="docstring">
691
+ <div class="discussion">
692
+ <p>Sends a constructed heartbeat to the master server</p>
693
+
694
+ <p>This can be used to check server versions externally.</p>
695
+
696
+
697
+ </div>
698
+ </div>
699
+ <div class="tags">
700
+ <h3>Parameters:</h3>
701
+ <ul class="param">
702
+
703
+ <li>
704
+
705
+ <span class='name'>The</span>
706
+
707
+
708
+ <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
709
+
710
+
711
+
712
+ &mdash;
713
+ <div class='inline'><p>data to send with the heartbeat request</p>
714
+ </div>
715
+
716
+ </li>
717
+
718
+ </ul>
719
+
720
+ <h3>Returns:</h3>
721
+ <ul class="return">
722
+
723
+ <li>
724
+
725
+
726
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="SteamPacket.html" title="SteamCondenser::SteamPacket (module)">SteamPacket</a></span>&gt;</tt>)</span>
727
+
728
+
729
+
730
+ &mdash;
731
+ <div class='inline'><p>Zero or more reply packets from the server.
732
+ Zero means either the heartbeat was accepted by the master or there
733
+ was a timeout. So usually it&#39;s best to repeat a heartbeat a few
734
+ times when not receiving any packets.</p>
735
+ </div>
736
+
737
+ </li>
738
+
739
+ </ul>
740
+ <h3>Raises:</h3>
741
+ <ul class="raise">
742
+
743
+ <li>
744
+
745
+
746
+ <span class='type'>(<tt><span class='object_link'><a href="Error.html" title="SteamCondenser::Error (class)">Error</a></span></tt>)</span>
747
+
748
+
749
+
750
+ &mdash;
751
+ <div class='inline'><p>if heartbeat data is missing the challenge number or the
752
+ reply cannot be parsed</p>
753
+ </div>
754
+
755
+ </li>
756
+
757
+ </ul>
758
+
759
+ <h3>See Also:</h3>
760
+ <ul class="see">
761
+
762
+ <li><span class='object_link'><a href="S2M_HEARTBEAT2_Packet.html" title="SteamCondenser::S2M_HEARTBEAT2_Packet (class)">S2M_HEARTBEAT2_Packet</a></span></li>
763
+
764
+ </ul>
765
+
766
+ </div><table class="source_code">
767
+ <tr>
768
+ <td>
769
+ <pre class="lines">
770
+
771
+
772
+ 169
773
+ 170
774
+ 171
775
+ 172
776
+ 173
777
+ 174
778
+ 175
779
+ 176
780
+ 177
781
+ 178
782
+ 179
783
+ 180
784
+ 181
785
+ 182</pre>
786
+ </td>
787
+ <td>
788
+ <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 169</span>
789
+
790
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_send_heartbeat identifier id'>send_heartbeat</span><span class='lparen token'>(</span><span class='rubyid_data identifier id'>data</span><span class='rparen token'>)</span>
791
+ <span class='rubyid_reply_packets identifier id'>reply_packets</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
792
+
793
+ <span class='rubyid_failsafe identifier id'>failsafe</span> <span class='rubyid_do do kw'>do</span>
794
+ <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span> <span class='rubyid_S2M_HEARTBEAT2_Packet constant id'>S2M_HEARTBEAT2_Packet</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_data identifier id'>data</span><span class='rparen token'>)</span>
795
+
796
+ <span class='rubyid_begin begin kw'>begin</span>
797
+ <span class='rubyid_loop identifier id'>loop</span> <span class='lbrace token'>{</span> <span class='rubyid_reply_packets identifier id'>reply_packets</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_reply identifier id'>reply</span> <span class='rbrace token'>}</span>
798
+ <span class='rubyid_rescue rescue kw'>rescue</span> <span class='rubyid_Error constant id'>Error</span><span class='colon2 op'>::</span><span class='rubyid_Timeout constant id'>Timeout</span>
799
+ <span class='rubyid_end end kw'>end</span>
800
+ <span class='rubyid_end end kw'>end</span>
801
+
802
+ <span class='rubyid_reply_packets identifier id'>reply_packets</span>
803
+ <span class='rubyid_end end kw'>end</span>
804
+ </pre>
805
+ </td>
806
+ </tr>
807
+ </table>
808
+ </div>
809
+
810
+ <div class="method_details ">
811
+ <p class="signature " id="servers-instance_method">
812
+
813
+ - (<tt>Array&lt;Array&lt;String&gt;&gt;</tt>) <strong>servers</strong>(region_code = MasterServer::REGION_ALL, filters = '', force = false)
814
+
815
+
816
+
817
+ </p><div class="docstring">
818
+ <div class="discussion">
819
+
820
+ <div class="note notetag">
821
+ <strong>Note:</strong>
822
+ <div class='inline'><p>Receiving all servers from the master server is taking quite some
823
+ time.</p>
824
+ </div>
825
+ </div>
826
+
827
+ <p>Returns a list of game server matching the given region and filters</p>
828
+
829
+ <p>Filtering:
830
+ Instead of filtering the results sent by the master server locally, you
831
+ should at least use the following filters to narrow down the results sent
832
+ by the master server.</p>
833
+
834
+ <p>Available filters:</p>
835
+
836
+ <ul>
837
+ <li><code>\type\d</code>: Request only dedicated servers</li>
838
+ <li><code>\secure\1</code>: Request only secure servers</li>
839
+ <li><code>\gamedir\[mod]</code>: Request only servers of a specific mod</li>
840
+ <li><code>\map\[mapname]</code>: Request only servers running a specific map</li>
841
+ <li><code>\linux\1</code>: Request only linux servers</li>
842
+ <li><code>\emtpy\1</code>: Request only <strong>non</strong>-empty servers</li>
843
+ <li><code>\full\1</code>: Request only servers <strong>not</strong> full</li>
844
+ <li><code>\proxy\1</code>: Request only spectator proxy servers</li>
845
+ </ul>
846
+
847
+
848
+ </div>
849
+ </div>
850
+ <div class="tags">
851
+ <h3>Parameters:</h3>
852
+ <ul class="param">
853
+
854
+ <li>
855
+
856
+ <span class='name'>region_code</span>
857
+
858
+
859
+ <span class='type'>(<tt>Fixnum</tt>)</span>
860
+
861
+
862
+ <em class="default">(defaults to: <tt>MasterServer::REGION_ALL</tt>)</em>
863
+
864
+
865
+ &mdash;
866
+ <div class='inline'><p>The region code to specify a location of the
867
+ game servers</p>
868
+ </div>
869
+
870
+ </li>
871
+
872
+ <li>
873
+
874
+ <span class='name'>filters</span>
875
+
876
+
877
+ <span class='type'>(<tt>String</tt>)</span>
878
+
879
+
880
+ <em class="default">(defaults to: <tt>''</tt>)</em>
881
+
882
+
883
+ &mdash;
884
+ <div class='inline'><p>The filters that game servers should match</p>
885
+ </div>
886
+
887
+ </li>
888
+
889
+ <li>
890
+
891
+ <span class='name'>force</span>
892
+
893
+
894
+ <span class='type'>(<tt>Boolean</tt>)</span>
895
+
896
+
897
+ <em class="default">(defaults to: <tt>false</tt>)</em>
898
+
899
+
900
+ &mdash;
901
+ <div class='inline'><p>Return a list of servers even if an error occured
902
+ while fetching them from the master server</p>
903
+ </div>
904
+
905
+ </li>
906
+
907
+ </ul>
908
+
909
+ <h3>Returns:</h3>
910
+ <ul class="return">
911
+
912
+ <li>
913
+
914
+
915
+ <span class='type'>(<tt>Array&lt;Array&lt;String&gt;&gt;</tt>)</span>
916
+
917
+
918
+
919
+ &mdash;
920
+ <div class='inline'><p>A list of game servers matching the given
921
+ region and filters</p>
922
+ </div>
923
+
924
+ </li>
925
+
926
+ </ul>
927
+ <h3>Raises:</h3>
928
+ <ul class="raise">
929
+
930
+ <li>
931
+
932
+
933
+ <span class='type'>(<tt><span class='object_link'><a href="Error/Timeout.html" title="SteamCondenser::Error::Timeout (class)">Error::Timeout</a></span></tt>)</span>
934
+
935
+
936
+
937
+ &mdash;
938
+ <div class='inline'><p>if too many timeouts occur while querying the
939
+ master server</p>
940
+ </div>
941
+
942
+ </li>
943
+
944
+ </ul>
945
+
946
+ <h3>See Also:</h3>
947
+ <ul class="see">
948
+
949
+ <li><span class='object_link'><a href="A2M_GET_SERVERS_BATCH2_Packet.html" title="SteamCondenser::A2M_GET_SERVERS_BATCH2_Packet (class)">A2M_GET_SERVERS_BATCH2_Packet</a></span></li>
950
+
951
+ <li><span class='object_link'><a href="#retries%3D-class_method" title="SteamCondenser::MasterServer.retries= (method)">retries=</a></span></li>
952
+
953
+ </ul>
954
+
955
+ </div><table class="source_code">
956
+ <tr>
957
+ <td>
958
+ <pre class="lines">
959
+
960
+
961
+ 124
962
+ 125
963
+ 126
964
+ 127
965
+ 128
966
+ 129
967
+ 130
968
+ 131
969
+ 132
970
+ 133
971
+ 134
972
+ 135
973
+ 136
974
+ 137
975
+ 138
976
+ 139
977
+ 140
978
+ 141
979
+ 142
980
+ 143
981
+ 144
982
+ 145
983
+ 146
984
+ 147
985
+ 148
986
+ 149
987
+ 150
988
+ 151
989
+ 152
990
+ 153
991
+ 154
992
+ 155</pre>
993
+ </td>
994
+ <td>
995
+ <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 124</span>
996
+
997
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_servers identifier id'>servers</span><span class='lparen token'>(</span><span class='rubyid_region_code identifier id'>region_code</span> <span class='assign token'>=</span> <span class='rubyid_MasterServer constant id'>MasterServer</span><span class='colon2 op'>::</span><span class='rubyid_REGION_ALL constant id'>REGION_ALL</span><span class='comma token'>,</span> <span class='rubyid_filters identifier id'>filters</span> <span class='assign token'>=</span> <span class='string val'>''</span><span class='comma token'>,</span> <span class='rubyid_force identifier id'>force</span> <span class='assign token'>=</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
998
+ <span class='rubyid_fail_count identifier id'>fail_count</span> <span class='assign token'>=</span> <span class='integer val'>0</span>
999
+ <span class='rubyid_finished identifier id'>finished</span> <span class='assign token'>=</span> <span class='rubyid_false false kw'>false</span>
1000
+ <span class='rubyid_current_server identifier id'>current_server</span> <span class='assign token'>=</span> <span class='string val'>'0.0.0.0:0'</span>
1001
+ <span class='rubyid_server_array identifier id'>server_array</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
1002
+
1003
+ <span class='rubyid_begin begin kw'>begin</span>
1004
+ <span class='rubyid_failsafe identifier id'>failsafe</span> <span class='rubyid_do do kw'>do</span>
1005
+ <span class='rubyid_begin begin kw'>begin</span>
1006
+ <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_send identifier id'>send</span> <span class='rubyid_A2M_GET_SERVERS_BATCH2_Packet constant id'>A2M_GET_SERVERS_BATCH2_Packet</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_region_code identifier id'>region_code</span><span class='comma token'>,</span> <span class='rubyid_current_server identifier id'>current_server</span><span class='comma token'>,</span> <span class='rubyid_filters identifier id'>filters</span><span class='rparen token'>)</span>
1007
+ <span class='rubyid_begin begin kw'>begin</span>
1008
+ <span class='rubyid_servers identifier id'>servers</span> <span class='assign token'>=</span> <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_reply identifier id'>reply</span><span class='dot token'>.</span><span class='rubyid_servers identifier id'>servers</span>
1009
+ <span class='rubyid_servers identifier id'>servers</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_server identifier id'>server</span><span class='bitor op'>|</span>
1010
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_server identifier id'>server</span> <span class='eq op'>==</span> <span class='string val'>'0.0.0.0:0'</span>
1011
+ <span class='rubyid_finished identifier id'>finished</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span>
1012
+ <span class='rubyid_else else kw'>else</span>
1013
+ <span class='rubyid_current_server identifier id'>current_server</span> <span class='assign token'>=</span> <span class='rubyid_server identifier id'>server</span>
1014
+ <span class='rubyid_server_array identifier id'>server_array</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_server identifier id'>server</span><span class='dot token'>.</span><span class='rubyid_split identifier id'>split</span><span class='lparen token'>(</span><span class='string val'>':'</span><span class='rparen token'>)</span>
1015
+ <span class='rubyid_end end kw'>end</span>
1016
+ <span class='rubyid_end end kw'>end</span>
1017
+ <span class='rubyid_fail_count identifier id'>fail_count</span> <span class='assign token'>=</span> <span class='integer val'>0</span>
1018
+ <span class='rubyid_rescue rescue kw'>rescue</span> <span class='rubyid_Error constant id'>Error</span><span class='colon2 op'>::</span><span class='rubyid_Timeout constant id'>Timeout</span>
1019
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_$! gvar id'>$!</span> <span class='rubyid_if if_mod kw'>if</span> <span class='lparen token'>(</span><span class='rubyid_fail_count identifier id'>fail_count</span> <span class='opasgn op'>+=</span> <span class='integer val'>1</span><span class='rparen token'>)</span> <span class='eq op'>==</span> <span class='rubyid_@@retries ivar id'>@@retries</span>
1020
+ <span class='rubyid_end end kw'>end</span>
1021
+ <span class='rubyid_end end kw'>end</span> <span class='rubyid_while while_mod kw'>while</span> <span class='notop op'>!</span><span class='rubyid_finished identifier id'>finished</span>
1022
+ <span class='rubyid_end end kw'>end</span>
1023
+ <span class='rubyid_rescue rescue kw'>rescue</span> <span class='rubyid_Error constant id'>Error</span><span class='colon2 op'>::</span><span class='rubyid_Timeout constant id'>Timeout</span>
1024
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_$! gvar id'>$!</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_force identifier id'>force</span>
1025
+ <span class='rubyid_end end kw'>end</span>
1026
+
1027
+ <span class='rubyid_server_array identifier id'>server_array</span>
1028
+ <span class='rubyid_end end kw'>end</span>
1029
+ </pre>
1030
+ </td>
1031
+ </tr>
1032
+ </table>
1033
+ </div>
1034
+
1035
+ </div>
1036
+
1037
+ </div>
1038
+
1039
+ <div id="footer">
1040
+ Generated on Mon Apr 30 07:02:59 2012 by
1041
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1042
+ 0.7.5 (ruby-1.8.7).
1043
+ </div>
1044
+
1045
+ </body>
1046
+ </html>