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,1070 @@
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: 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
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index (M)</a> &raquo;
35
+
36
+
37
+ <span class="title">MasterServer</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: MasterServer
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">MasterServer</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+ <dt class="r2">Includes:</dt>
94
+ <dd class="r2"><span class='object_link'><a href="Server.html" title="Server (module)">Server</a></span></dd>
95
+
96
+
97
+
98
+
99
+
100
+ <dt class="r1 last">Defined in:</dt>
101
+ <dd class="r1 last">lib/steam/servers/master_server.rb</dd>
102
+
103
+ </dl>
104
+ <div class="clear"></div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+ <p>This class represents a Steam master server and can be used to get game
109
+ servers which are publicly available</p>
110
+
111
+ <p>An intance of this class can be used much like Steam&#39;s server browser to get
112
+ a list of available game servers, including filters to narrow down the search
113
+ results.</p>
114
+
115
+
116
+ </div>
117
+ </div>
118
+ <div class="tags">
119
+
120
+ <p class="tag_title">Author:</p>
121
+ <ul class="author">
122
+
123
+ <li>
124
+
125
+
126
+
127
+
128
+
129
+ <div class='inline'><p>Sebastian Staudt</p>
130
+ </div>
131
+
132
+ </li>
133
+
134
+ </ul>
135
+
136
+ </div>
137
+ <h2>Constant Summary</h2>
138
+
139
+ <dl class="constants">
140
+
141
+ <dt id="GOLDSRC_MASTER_SERVER-constant" class="">GOLDSRC_MASTER_SERVER =
142
+ <div class="docstring">
143
+ <div class="discussion">
144
+ <p>The master server address to query for GoldSrc game servers</p>
145
+
146
+
147
+ </div>
148
+ </div>
149
+ <div class="tags">
150
+
151
+
152
+ </div>
153
+ </dt>
154
+ <dd><pre class="code"><span class='string val'>'hl1master.steampowered.com'</span><span class='comma token'>,</span> <span class='integer val'>27010</span>
155
+ </pre></dd>
156
+
157
+ <dt id="SOURCE_MASTER_SERVER-constant" class="">SOURCE_MASTER_SERVER =
158
+ <div class="docstring">
159
+ <div class="discussion">
160
+ <p>The master server address to query for Source game servers</p>
161
+
162
+
163
+ </div>
164
+ </div>
165
+ <div class="tags">
166
+
167
+
168
+ </div>
169
+ </dt>
170
+ <dd><pre class="code"><span class='string val'>'hl2master.steampowered.com'</span><span class='comma token'>,</span> <span class='integer val'>27011</span>
171
+ </pre></dd>
172
+
173
+ <dt id="REGION_US_EAST_COAST-constant" class="">REGION_US_EAST_COAST =
174
+ <div class="docstring">
175
+ <div class="discussion">
176
+ <p>The region code for the US east coast</p>
177
+
178
+
179
+ </div>
180
+ </div>
181
+ <div class="tags">
182
+
183
+
184
+ </div>
185
+ </dt>
186
+ <dd><pre class="code"><span class='integer val'>0x00</span>
187
+ </pre></dd>
188
+
189
+ <dt id="REGION_US_WEST_COAST-constant" class="">REGION_US_WEST_COAST =
190
+ <div class="docstring">
191
+ <div class="discussion">
192
+ <p>The region code for the US west coast</p>
193
+
194
+
195
+ </div>
196
+ </div>
197
+ <div class="tags">
198
+
199
+
200
+ </div>
201
+ </dt>
202
+ <dd><pre class="code"><span class='integer val'>0x01</span>
203
+ </pre></dd>
204
+
205
+ <dt id="REGION_SOUTH_AMERICA-constant" class="">REGION_SOUTH_AMERICA =
206
+ <div class="docstring">
207
+ <div class="discussion">
208
+ <p>The region code for South America</p>
209
+
210
+
211
+ </div>
212
+ </div>
213
+ <div class="tags">
214
+
215
+
216
+ </div>
217
+ </dt>
218
+ <dd><pre class="code"><span class='integer val'>0x02</span>
219
+ </pre></dd>
220
+
221
+ <dt id="REGION_EUROPE-constant" class="">REGION_EUROPE =
222
+ <div class="docstring">
223
+ <div class="discussion">
224
+ <p>The region code for Europe</p>
225
+
226
+
227
+ </div>
228
+ </div>
229
+ <div class="tags">
230
+
231
+
232
+ </div>
233
+ </dt>
234
+ <dd><pre class="code"><span class='integer val'>0x03</span>
235
+ </pre></dd>
236
+
237
+ <dt id="REGION_ASIA-constant" class="">REGION_ASIA =
238
+ <div class="docstring">
239
+ <div class="discussion">
240
+ <p>The region code for Asia</p>
241
+
242
+
243
+ </div>
244
+ </div>
245
+ <div class="tags">
246
+
247
+
248
+ </div>
249
+ </dt>
250
+ <dd><pre class="code"><span class='integer val'>0x04</span>
251
+ </pre></dd>
252
+
253
+ <dt id="REGION_AUSTRALIA-constant" class="">REGION_AUSTRALIA =
254
+ <div class="docstring">
255
+ <div class="discussion">
256
+ <p>The region code for Australia</p>
257
+
258
+
259
+ </div>
260
+ </div>
261
+ <div class="tags">
262
+
263
+
264
+ </div>
265
+ </dt>
266
+ <dd><pre class="code"><span class='integer val'>0x05</span>
267
+ </pre></dd>
268
+
269
+ <dt id="REGION_MIDDLE_EAST-constant" class="">REGION_MIDDLE_EAST =
270
+ <div class="docstring">
271
+ <div class="discussion">
272
+ <p>The region code for the Middle East</p>
273
+
274
+
275
+ </div>
276
+ </div>
277
+ <div class="tags">
278
+
279
+
280
+ </div>
281
+ </dt>
282
+ <dd><pre class="code"><span class='integer val'>0x06</span>
283
+ </pre></dd>
284
+
285
+ <dt id="REGION_AFRICA-constant" class="">REGION_AFRICA =
286
+ <div class="docstring">
287
+ <div class="discussion">
288
+ <p>The region code for Africa</p>
289
+
290
+
291
+ </div>
292
+ </div>
293
+ <div class="tags">
294
+
295
+
296
+ </div>
297
+ </dt>
298
+ <dd><pre class="code"><span class='integer val'>0x07</span>
299
+ </pre></dd>
300
+
301
+ <dt id="REGION_ALL-constant" class="">REGION_ALL =
302
+ <div class="docstring">
303
+ <div class="discussion">
304
+ <p>The region code for the whole world</p>
305
+
306
+
307
+ </div>
308
+ </div>
309
+ <div class="tags">
310
+
311
+
312
+ </div>
313
+ </dt>
314
+ <dd><pre class="code"><span class='integer val'>0x</span><span class='rubyid_FF constant id'>FF</span>
315
+ </pre></dd>
316
+
317
+ <dt id="retries-classvariable" class="">@@retries =
318
+ <div class="docstring">
319
+ <div class="discussion">
320
+ <p>The default number of allowed retries</p>
321
+
322
+
323
+ </div>
324
+ </div>
325
+ <div class="tags">
326
+
327
+
328
+ </div>
329
+ </dt>
330
+ <dd><pre class="code"><span class='integer val'>3</span>
331
+ </pre></dd>
332
+
333
+ </dl>
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+ <h2>Instance Attribute Summary</h2>
342
+
343
+ <h3 class="inherited">Attributes included from <span class='object_link'><a href="Server.html" title="Server (module)">Server</a></span></h3>
344
+ <p class="inherited"><span class='object_link'><a href="Server.html#host_names-instance_method" title="Server#host_names (method)">#host_names</a></span>, <span class='object_link'><a href="Server.html#ip_addresses-instance_method" title="Server#ip_addresses (method)">#ip_addresses</a></span></p>
345
+
346
+
347
+
348
+ <h2>
349
+ Class Method Summary
350
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
351
+ </h2>
352
+
353
+ <ul class="summary">
354
+
355
+ <li class="public ">
356
+ <span class="summary_signature">
357
+
358
+ <a href="#retries%3D-class_method" title="retries= (class method)">+ (Object) <strong>retries=</strong>(retries) </a>
359
+
360
+
361
+
362
+ </span>
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+ <span class="summary_desc"><div class='inline'><p>Sets the number of consecutive requests that may fail, before getting
373
+ the server list is cancelled (default: 3).</p>
374
+ </div></span>
375
+
376
+ </li>
377
+
378
+
379
+ </ul>
380
+
381
+ <h2>
382
+ Instance Method Summary
383
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
384
+ </h2>
385
+
386
+ <ul class="summary">
387
+
388
+ <li class="public ">
389
+ <span class="summary_signature">
390
+
391
+ <a href="#challenge-instance_method" title="#challenge (instance method)">- (Fixnum) <strong>challenge</strong> </a>
392
+
393
+
394
+
395
+ </span>
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+ <span class="summary_desc"><div class='inline'><p>Request a challenge number from the master server.</p>
406
+ </div></span>
407
+
408
+ </li>
409
+
410
+
411
+ <li class="public ">
412
+ <span class="summary_signature">
413
+
414
+ <a href="#init_socket-instance_method" title="#init_socket (instance method)">- (Object) <strong>init_socket</strong> </a>
415
+
416
+
417
+
418
+ </span>
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+ <span class="summary_desc"><div class='inline'><p>Initializes the socket to communicate with the master server.</p>
429
+ </div></span>
430
+
431
+ </li>
432
+
433
+
434
+ <li class="public ">
435
+ <span class="summary_signature">
436
+
437
+ <a href="#send_heartbeat-instance_method" title="#send_heartbeat (instance method)">- (Array&lt;SteamPacket&gt;) <strong>send_heartbeat</strong>(data) </a>
438
+
439
+
440
+
441
+ </span>
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+ <span class="summary_desc"><div class='inline'><p>Sends a constructed heartbeat to the master server.</p>
452
+ </div></span>
453
+
454
+ </li>
455
+
456
+
457
+ <li class="public ">
458
+ <span class="summary_signature">
459
+
460
+ <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>
461
+
462
+
463
+
464
+ </span>
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+ <span class="summary_desc"><div class='inline'><p>Returns a list of game server matching the given region and filters.</p>
475
+ </div></span>
476
+
477
+ </li>
478
+
479
+
480
+ </ul>
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Server.html" title="Server (module)">Server</a></span></h3>
493
+ <p class="inherited"><span class='object_link'><a href="Server.html#failsafe-instance_method" title="Server#failsafe (method)">#failsafe</a></span>, <span class='object_link'><a href="Server.html#initialize-instance_method" title="Server#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Server.html#rotate_ip-instance_method" title="Server#rotate_ip (method)">#rotate_ip</a></span></p>
494
+ <div id="constructor_details" class="method_details_list">
495
+ <h2>Constructor Details</h2>
496
+
497
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Server.html#initialize-instance_method" title="Server#initialize (method)">Server</a></span></p>
498
+
499
+ </div>
500
+
501
+
502
+ <div id="class_method_details" class="method_details_list">
503
+ <h2>Class Method Details</h2>
504
+
505
+
506
+ <div class="method_details first">
507
+ <h3 class="signature first" id="retries=-class_method">
508
+
509
+ + (<tt>Object</tt>) <strong>retries=</strong>(retries)
510
+
511
+
512
+
513
+
514
+
515
+ </h3><div class="docstring">
516
+ <div class="discussion">
517
+ <p>Sets the number of consecutive requests that may fail, before getting
518
+ the server list is cancelled (default: 3)</p>
519
+
520
+
521
+ </div>
522
+ </div>
523
+ <div class="tags">
524
+ <p class="tag_title">Parameters:</p>
525
+ <ul class="param">
526
+
527
+ <li>
528
+
529
+ <span class='name'>retries</span>
530
+
531
+
532
+ <span class='type'>(<tt>Fixnum</tt>)</span>
533
+
534
+
535
+
536
+ &mdash;
537
+ <div class='inline'><p>The number of allowed retries</p>
538
+ </div>
539
+
540
+ </li>
541
+
542
+ </ul>
543
+
544
+
545
+ </div><table class="source_code">
546
+ <tr>
547
+ <td>
548
+ <pre class="lines">
549
+
550
+
551
+ 65
552
+ 66
553
+ 67</pre>
554
+ </td>
555
+ <td>
556
+ <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 65</span>
557
+
558
+ <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>
559
+ <span class='rubyid_@@retries ivar id'>@@retries</span> <span class='assign token'>=</span> <span class='rubyid_retries identifier id'>retries</span>
560
+ <span class='rubyid_end end kw'>end</span>
561
+ </pre>
562
+ </td>
563
+ </tr>
564
+ </table>
565
+ </div>
566
+
567
+ </div>
568
+
569
+ <div id="instance_method_details" class="method_details_list">
570
+ <h2>Instance Method Details</h2>
571
+
572
+
573
+ <div class="method_details first">
574
+ <h3 class="signature first" id="challenge-instance_method">
575
+
576
+ - (<tt>Fixnum</tt>) <strong>challenge</strong>
577
+
578
+
579
+
580
+
581
+
582
+ </h3><div class="docstring">
583
+ <div class="discussion">
584
+
585
+ <div class="note notetag">
586
+ <strong>Note:</strong>
587
+ <div class='inline'><p>Please note that this is <strong>not</strong> needed for finding servers using
588
+ <span class='object_link'><a href="#servers-instance_method" title="MasterServer#servers (method)">#servers</a></span>.</p>
589
+ </div>
590
+ </div>
591
+
592
+ <p>Request a challenge number from the master server.</p>
593
+
594
+ <p>This is used for further communication with the master server.</p>
595
+
596
+
597
+ </div>
598
+ </div>
599
+ <div class="tags">
600
+
601
+ <p class="tag_title">Returns:</p>
602
+ <ul class="return">
603
+
604
+ <li>
605
+
606
+
607
+ <span class='type'>(<tt>Fixnum</tt>)</span>
608
+
609
+
610
+
611
+ &mdash;
612
+ <div class='inline'><p>The challenge number from the master server</p>
613
+ </div>
614
+
615
+ </li>
616
+
617
+ </ul>
618
+
619
+ <p class="tag_title">See Also:</p>
620
+ <ul class="see">
621
+
622
+ <li><span class='object_link'><a href="#send_heartbeat-instance_method" title="MasterServer#send_heartbeat (method)">#send_heartbeat</a></span></li>
623
+
624
+ </ul>
625
+
626
+ </div><table class="source_code">
627
+ <tr>
628
+ <td>
629
+ <pre class="lines">
630
+
631
+
632
+ 77
633
+ 78
634
+ 79
635
+ 80
636
+ 81
637
+ 82</pre>
638
+ </td>
639
+ <td>
640
+ <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 77</span>
641
+
642
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_challenge identifier id'>challenge</span>
643
+ <span class='rubyid_failsafe identifier id'>failsafe</span> <span class='rubyid_do do kw'>do</span>
644
+ <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>
645
+ <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>
646
+ <span class='rubyid_end end kw'>end</span>
647
+ <span class='rubyid_end end kw'>end</span>
648
+ </pre>
649
+ </td>
650
+ </tr>
651
+ </table>
652
+ </div>
653
+
654
+ <div class="method_details ">
655
+ <h3 class="signature " id="init_socket-instance_method">
656
+
657
+ - (<tt>Object</tt>) <strong>init_socket</strong>
658
+
659
+
660
+
661
+
662
+
663
+ </h3><div class="docstring">
664
+ <div class="discussion">
665
+ <p>Initializes the socket to communicate with the master server</p>
666
+
667
+
668
+ </div>
669
+ </div>
670
+ <div class="tags">
671
+
672
+
673
+ <p class="tag_title">See Also:</p>
674
+ <ul class="see">
675
+
676
+ <li><span class='object_link'><a href="MasterServerSocket.html" title="MasterServerSocket (class)">MasterServerSocket</a></span></li>
677
+
678
+ </ul>
679
+
680
+ </div><table class="source_code">
681
+ <tr>
682
+ <td>
683
+ <pre class="lines">
684
+
685
+
686
+ 87
687
+ 88
688
+ 89</pre>
689
+ </td>
690
+ <td>
691
+ <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 87</span>
692
+
693
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_init_socket identifier id'>init_socket</span>
694
+ <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>
695
+ <span class='rubyid_end end kw'>end</span>
696
+ </pre>
697
+ </td>
698
+ </tr>
699
+ </table>
700
+ </div>
701
+
702
+ <div class="method_details ">
703
+ <h3 class="signature " id="send_heartbeat-instance_method">
704
+
705
+ - (<tt>Array&lt;<span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span>&gt;</tt>) <strong>send_heartbeat</strong>(data)
706
+
707
+
708
+
709
+
710
+
711
+ </h3><div class="docstring">
712
+ <div class="discussion">
713
+ <p>Sends a constructed heartbeat to the master server</p>
714
+
715
+ <p>This can be used to check server versions externally.</p>
716
+
717
+
718
+ </div>
719
+ </div>
720
+ <div class="tags">
721
+ <p class="tag_title">Parameters:</p>
722
+ <ul class="param">
723
+
724
+ <li>
725
+
726
+ <span class='name'>data</span>
727
+
728
+
729
+ <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
730
+
731
+
732
+
733
+ &mdash;
734
+ <div class='inline'><p>The data to send with the heartbeat
735
+ request</p>
736
+ </div>
737
+
738
+ </li>
739
+
740
+ </ul>
741
+
742
+ <p class="tag_title">Returns:</p>
743
+ <ul class="return">
744
+
745
+ <li>
746
+
747
+
748
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span>&gt;</tt>)</span>
749
+
750
+
751
+
752
+ &mdash;
753
+ <div class='inline'><p>Zero or more reply packets from the server.
754
+ Zero means either the heartbeat was accepted by the master or there
755
+ was a timeout. So usually it&#39;s best to repeat a heartbeat a few
756
+ times when not receiving any packets.</p>
757
+ </div>
758
+
759
+ </li>
760
+
761
+ </ul>
762
+ <p class="tag_title">Raises:</p>
763
+ <ul class="raise">
764
+
765
+ <li>
766
+
767
+
768
+ <span class='type'>(<tt><span class='object_link'><a href="SteamCondenserError.html" title="SteamCondenserError (class)">SteamCondenserError</a></span></tt>)</span>
769
+
770
+
771
+
772
+ &mdash;
773
+ <div class='inline'><p>if heartbeat data is missing the
774
+ challenge number or the reply cannot be parsed</p>
775
+ </div>
776
+
777
+ </li>
778
+
779
+ </ul>
780
+
781
+ <p class="tag_title">See Also:</p>
782
+ <ul class="see">
783
+
784
+ <li><span class='object_link'><a href="S2M_HEARTBEAT2_Packet.html" title="S2M_HEARTBEAT2_Packet (class)">S2M_HEARTBEAT2_Packet</a></span></li>
785
+
786
+ </ul>
787
+
788
+ </div><table class="source_code">
789
+ <tr>
790
+ <td>
791
+ <pre class="lines">
792
+
793
+
794
+ 168
795
+ 169
796
+ 170
797
+ 171
798
+ 172
799
+ 173
800
+ 174
801
+ 175
802
+ 176
803
+ 177
804
+ 178
805
+ 179
806
+ 180
807
+ 181</pre>
808
+ </td>
809
+ <td>
810
+ <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 168</span>
811
+
812
+ <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>
813
+ <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>
814
+
815
+ <span class='rubyid_failsafe identifier id'>failsafe</span> <span class='rubyid_do do kw'>do</span>
816
+ <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>
817
+
818
+ <span class='rubyid_begin begin kw'>begin</span>
819
+ <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>
820
+ <span class='rubyid_rescue rescue kw'>rescue</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_TimeoutError constant id'>TimeoutError</span>
821
+ <span class='rubyid_end end kw'>end</span>
822
+ <span class='rubyid_end end kw'>end</span>
823
+
824
+ <span class='rubyid_reply_packets identifier id'>reply_packets</span>
825
+ <span class='rubyid_end end kw'>end</span>
826
+ </pre>
827
+ </td>
828
+ </tr>
829
+ </table>
830
+ </div>
831
+
832
+ <div class="method_details ">
833
+ <h3 class="signature " id="servers-instance_method">
834
+
835
+ - (<tt>Array&lt;Array&lt;String&gt;&gt;</tt>) <strong>servers</strong>(region_code = MasterServer::REGION_ALL, filters = '', force = false)
836
+
837
+
838
+
839
+
840
+
841
+ </h3><div class="docstring">
842
+ <div class="discussion">
843
+
844
+ <div class="note notetag">
845
+ <strong>Note:</strong>
846
+ <div class='inline'><p>Receiving all servers from the master server is taking quite some
847
+ time.</p>
848
+ </div>
849
+ </div>
850
+
851
+ <p>Returns a list of game server matching the given region and filters</p>
852
+
853
+ <p>Filtering:
854
+ Instead of filtering the results sent by the master server locally, you
855
+ should at least use the following filters to narrow down the results sent
856
+ by the master server.</p>
857
+
858
+ <p>Available filters:</p>
859
+
860
+ <ul>
861
+ <li><code>\type\d</code>: Request only dedicated servers</li>
862
+ <li><code>\secure\1</code>: Request only secure servers</li>
863
+ <li><code>\gamedir\[mod]</code>: Request only servers of a specific mod</li>
864
+ <li><code>\map\[mapname]</code>: Request only servers running a specific map</li>
865
+ <li><code>\linux\1</code>: Request only linux servers</li>
866
+ <li><code>\emtpy\1</code>: Request only <strong>non</strong>-empty servers</li>
867
+ <li><code>\full\1</code>: Request only servers <strong>not</strong> full</li>
868
+ <li><code>\proxy\1</code>: Request only spectator proxy servers</li>
869
+ </ul>
870
+
871
+
872
+ </div>
873
+ </div>
874
+ <div class="tags">
875
+ <p class="tag_title">Parameters:</p>
876
+ <ul class="param">
877
+
878
+ <li>
879
+
880
+ <span class='name'>region_code</span>
881
+
882
+
883
+ <span class='type'>(<tt>Fixnum</tt>)</span>
884
+
885
+
886
+ <em class="default">(defaults to: <tt>MasterServer::REGION_ALL</tt>)</em>
887
+
888
+
889
+ &mdash;
890
+ <div class='inline'><p>The region code to specify a location of the
891
+ game servers</p>
892
+ </div>
893
+
894
+ </li>
895
+
896
+ <li>
897
+
898
+ <span class='name'>filters</span>
899
+
900
+
901
+ <span class='type'>(<tt>String</tt>)</span>
902
+
903
+
904
+ <em class="default">(defaults to: <tt>''</tt>)</em>
905
+
906
+
907
+ &mdash;
908
+ <div class='inline'><p>The filters that game servers should match</p>
909
+ </div>
910
+
911
+ </li>
912
+
913
+ <li>
914
+
915
+ <span class='name'>force</span>
916
+
917
+
918
+ <span class='type'>(<tt>Boolean</tt>)</span>
919
+
920
+
921
+ <em class="default">(defaults to: <tt>false</tt>)</em>
922
+
923
+
924
+ &mdash;
925
+ <div class='inline'><p>Return a list of servers even if an error occured
926
+ while fetching them from the master server</p>
927
+ </div>
928
+
929
+ </li>
930
+
931
+ </ul>
932
+
933
+ <p class="tag_title">Returns:</p>
934
+ <ul class="return">
935
+
936
+ <li>
937
+
938
+
939
+ <span class='type'>(<tt>Array&lt;Array&lt;String&gt;&gt;</tt>)</span>
940
+
941
+
942
+
943
+ &mdash;
944
+ <div class='inline'><p>A list of game servers matching the given
945
+ region and filters</p>
946
+ </div>
947
+
948
+ </li>
949
+
950
+ </ul>
951
+ <p class="tag_title">Raises:</p>
952
+ <ul class="raise">
953
+
954
+ <li>
955
+
956
+
957
+ <span class='type'>(<tt><span class='object_link'><a href="SteamCondenser/TimeoutError.html" title="SteamCondenser::TimeoutError (class)">SteamCondenser::TimeoutError</a></span></tt>)</span>
958
+
959
+
960
+
961
+ &mdash;
962
+ <div class='inline'><p>if too many timeouts occur while
963
+ querying the master server</p>
964
+ </div>
965
+
966
+ </li>
967
+
968
+ </ul>
969
+
970
+ <p class="tag_title">See Also:</p>
971
+ <ul class="see">
972
+
973
+ <li><span class='object_link'><a href="A2M_GET_SERVERS_BATCH2_Packet.html" title="A2M_GET_SERVERS_BATCH2_Packet (class)">A2M_GET_SERVERS_BATCH2_Packet</a></span></li>
974
+
975
+ <li><span class='object_link'><a href="#retries%3D-class_method" title="MasterServer.retries= (method)">retries=</a></span></li>
976
+
977
+ </ul>
978
+
979
+ </div><table class="source_code">
980
+ <tr>
981
+ <td>
982
+ <pre class="lines">
983
+
984
+
985
+ 122
986
+ 123
987
+ 124
988
+ 125
989
+ 126
990
+ 127
991
+ 128
992
+ 129
993
+ 130
994
+ 131
995
+ 132
996
+ 133
997
+ 134
998
+ 135
999
+ 136
1000
+ 137
1001
+ 138
1002
+ 139
1003
+ 140
1004
+ 141
1005
+ 142
1006
+ 143
1007
+ 144
1008
+ 145
1009
+ 146
1010
+ 147
1011
+ 148
1012
+ 149
1013
+ 150
1014
+ 151
1015
+ 152
1016
+ 153</pre>
1017
+ </td>
1018
+ <td>
1019
+ <pre class="code"><span class="info file"># File 'lib/steam/servers/master_server.rb', line 122</span>
1020
+
1021
+ <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>
1022
+ <span class='rubyid_fail_count identifier id'>fail_count</span> <span class='assign token'>=</span> <span class='integer val'>0</span>
1023
+ <span class='rubyid_finished identifier id'>finished</span> <span class='assign token'>=</span> <span class='rubyid_false false kw'>false</span>
1024
+ <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>
1025
+ <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>
1026
+
1027
+ <span class='rubyid_begin begin kw'>begin</span>
1028
+ <span class='rubyid_failsafe identifier id'>failsafe</span> <span class='rubyid_do do kw'>do</span>
1029
+ <span class='rubyid_begin begin kw'>begin</span>
1030
+ <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>
1031
+ <span class='rubyid_begin begin kw'>begin</span>
1032
+ <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>
1033
+ <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>
1034
+ <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>
1035
+ <span class='rubyid_finished identifier id'>finished</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span>
1036
+ <span class='rubyid_else else kw'>else</span>
1037
+ <span class='rubyid_current_server identifier id'>current_server</span> <span class='assign token'>=</span> <span class='rubyid_server identifier id'>server</span>
1038
+ <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>
1039
+ <span class='rubyid_end end kw'>end</span>
1040
+ <span class='rubyid_end end kw'>end</span>
1041
+ <span class='rubyid_fail_count identifier id'>fail_count</span> <span class='assign token'>=</span> <span class='integer val'>0</span>
1042
+ <span class='rubyid_rescue rescue kw'>rescue</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_TimeoutError constant id'>TimeoutError</span>
1043
+ <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>
1044
+ <span class='rubyid_end end kw'>end</span>
1045
+ <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>
1046
+ <span class='rubyid_end end kw'>end</span>
1047
+ <span class='rubyid_rescue rescue kw'>rescue</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_TimeoutError constant id'>TimeoutError</span>
1048
+ <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>
1049
+ <span class='rubyid_end end kw'>end</span>
1050
+
1051
+ <span class='rubyid_server_array identifier id'>server_array</span>
1052
+ <span class='rubyid_end end kw'>end</span>
1053
+ </pre>
1054
+ </td>
1055
+ </tr>
1056
+ </table>
1057
+ </div>
1058
+
1059
+ </div>
1060
+
1061
+ </div>
1062
+
1063
+ <div id="footer">
1064
+ Generated on Sat Jul 21 13:09:39 2012 by
1065
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1066
+ 0.8.2.1 (ruby-1.8.7).
1067
+ </div>
1068
+
1069
+ </body>
1070
+ </html>