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,300 @@
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
+ Module: RCONPacketFactory
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 (R)</a> &raquo;
35
+
36
+
37
+ <span class="title">RCONPacketFactory</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>Module: RCONPacketFactory
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+ <dt class="r1 last">Defined in:</dt>
82
+ <dd class="r1 last">lib/steam/packets/rcon/rcon_packet_factory.rb</dd>
83
+
84
+ </dl>
85
+ <div class="clear"></div>
86
+
87
+ <h2>Overview</h2><div class="docstring">
88
+ <div class="discussion">
89
+ <p>This module provides functionality to handle raw packet data for Source RCON</p>
90
+
91
+ <p>It&#39;s is used to transform data bytes into packet objects for RCON
92
+ communication with Source servers.</p>
93
+
94
+
95
+ </div>
96
+ </div>
97
+ <div class="tags">
98
+
99
+
100
+ <p class="tag_title">See Also:</p>
101
+ <ul class="see">
102
+
103
+ <li><span class='object_link'><a href="RCONPacket.html" title="RCONPacket (module)">RCONPacket</a></span></li>
104
+
105
+ </ul>
106
+ <p class="tag_title">Author:</p>
107
+ <ul class="author">
108
+
109
+ <li>
110
+
111
+
112
+
113
+
114
+
115
+ <div class='inline'><p>Sebastian Staudt</p>
116
+ </div>
117
+
118
+ </li>
119
+
120
+ </ul>
121
+
122
+ </div>
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+ <h2>
131
+ Class Method Summary
132
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
133
+ </h2>
134
+
135
+ <ul class="summary">
136
+
137
+ <li class="public ">
138
+ <span class="summary_signature">
139
+
140
+ <a href="#packet_from_data-class_method" title="packet_from_data (class method)">+ (RCONPacket) <strong>packet_from_data</strong>(raw_data) </a>
141
+
142
+
143
+
144
+ </span>
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+ <span class="summary_desc"><div class='inline'><p>Creates a new packet object based on the header byte of the given raw data.</p>
155
+ </div></span>
156
+
157
+ </li>
158
+
159
+
160
+ </ul>
161
+
162
+
163
+
164
+
165
+ <div id="class_method_details" class="method_details_list">
166
+ <h2>Class Method Details</h2>
167
+
168
+
169
+ <div class="method_details first">
170
+ <h3 class="signature first" id="packet_from_data-class_method">
171
+
172
+ + (<tt><span class='object_link'><a href="RCONPacket.html" title="RCONPacket (module)">RCONPacket</a></span></tt>) <strong>packet_from_data</strong>(raw_data)
173
+
174
+
175
+
176
+
177
+
178
+ </h3><div class="docstring">
179
+ <div class="discussion">
180
+ <p>Creates a new packet object based on the header byte of the given raw data</p>
181
+
182
+
183
+ </div>
184
+ </div>
185
+ <div class="tags">
186
+ <p class="tag_title">Parameters:</p>
187
+ <ul class="param">
188
+
189
+ <li>
190
+
191
+ <span class='name'>raw_data</span>
192
+
193
+
194
+ <span class='type'>(<tt>String</tt>)</span>
195
+
196
+
197
+
198
+ &mdash;
199
+ <div class='inline'><p>The raw data of the packet</p>
200
+ </div>
201
+
202
+ </li>
203
+
204
+ </ul>
205
+
206
+ <p class="tag_title">Returns:</p>
207
+ <ul class="return">
208
+
209
+ <li>
210
+
211
+
212
+ <span class='type'>(<tt><span class='object_link'><a href="RCONPacket.html" title="RCONPacket (module)">RCONPacket</a></span></tt>)</span>
213
+
214
+
215
+
216
+ &mdash;
217
+ <div class='inline'><p>The packet object generated from the packet data</p>
218
+ </div>
219
+
220
+ </li>
221
+
222
+ </ul>
223
+ <p class="tag_title">Raises:</p>
224
+ <ul class="raise">
225
+
226
+ <li>
227
+
228
+
229
+ <span class='type'>(<tt><span class='object_link'><a href="PacketFormatError.html" title="PacketFormatError (class)">PacketFormatError</a></span></tt>)</span>
230
+
231
+
232
+
233
+ &mdash;
234
+ <div class='inline'><p>if the packet header is not recognized</p>
235
+ </div>
236
+
237
+ </li>
238
+
239
+ </ul>
240
+
241
+ </div><table class="source_code">
242
+ <tr>
243
+ <td>
244
+ <pre class="lines">
245
+
246
+
247
+ 26
248
+ 27
249
+ 28
250
+ 29
251
+ 30
252
+ 31
253
+ 32
254
+ 33
255
+ 34
256
+ 35
257
+ 36
258
+ 37
259
+ 38
260
+ 39
261
+ 40
262
+ 41</pre>
263
+ </td>
264
+ <td>
265
+ <pre class="code"><span class="info file"># File 'lib/steam/packets/rcon/rcon_packet_factory.rb', line 26</span>
266
+
267
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_packet_from_data identifier id'>packet_from_data</span><span class='lparen token'>(</span><span class='rubyid_raw_data identifier id'>raw_data</span><span class='rparen token'>)</span>
268
+ <span class='rubyid_byte_buffer identifier id'>byte_buffer</span> <span class='assign token'>=</span> <span class='rubyid_StringIO constant id'>StringIO</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_raw_data identifier id'>raw_data</span>
269
+
270
+ <span class='rubyid_request_id identifier id'>request_id</span> <span class='assign token'>=</span> <span class='rubyid_byte_buffer identifier id'>byte_buffer</span><span class='dot token'>.</span><span class='rubyid_long identifier id'>long</span>
271
+ <span class='rubyid_header identifier id'>header</span> <span class='assign token'>=</span> <span class='rubyid_byte_buffer identifier id'>byte_buffer</span><span class='dot token'>.</span><span class='rubyid_long identifier id'>long</span>
272
+ <span class='rubyid_data identifier id'>data</span> <span class='assign token'>=</span> <span class='rubyid_byte_buffer identifier id'>byte_buffer</span><span class='dot token'>.</span><span class='rubyid_cstring identifier id'>cstring</span>
273
+
274
+ <span class='rubyid_case case kw'>case</span> <span class='rubyid_header identifier id'>header</span>
275
+ <span class='rubyid_when when kw'>when</span> <span class='rubyid_RCONPacket constant id'>RCONPacket</span><span class='colon2 op'>::</span><span class='rubyid_SERVERDATA_AUTH_RESPONSE constant id'>SERVERDATA_AUTH_RESPONSE</span> <span class='rubyid_then then kw'>then</span>
276
+ <span class='rubyid_return return kw'>return</span> <span class='rubyid_RCONAuthResponse constant id'>RCONAuthResponse</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_request_id identifier id'>request_id</span><span class='rparen token'>)</span>
277
+ <span class='rubyid_when when kw'>when</span> <span class='rubyid_RCONPacket constant id'>RCONPacket</span><span class='colon2 op'>::</span><span class='rubyid_SERVERDATA_RESPONSE_VALUE constant id'>SERVERDATA_RESPONSE_VALUE</span> <span class='rubyid_then then kw'>then</span>
278
+ <span class='rubyid_return return kw'>return</span> <span class='rubyid_RCONExecResponse constant id'>RCONExecResponse</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_request_id identifier id'>request_id</span><span class='comma token'>,</span> <span class='rubyid_data identifier id'>data</span><span class='rparen token'>)</span>
279
+ <span class='rubyid_else else kw'>else</span>
280
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_PacketFormatError constant id'>PacketFormatError</span><span class='comma token'>,</span> <span class='dstring node'>&quot;Unknown packet with header #{header.to_s(16)} received.&quot;</span>
281
+ <span class='rubyid_end end kw'>end</span>
282
+ <span class='rubyid_end end kw'>end</span>
283
+ </pre>
284
+ </td>
285
+ </tr>
286
+ </table>
287
+ </div>
288
+
289
+ </div>
290
+
291
+ </div>
292
+
293
+ <div id="footer">
294
+ Generated on Sat Jul 21 13:09:32 2012 by
295
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
296
+ 0.8.2.1 (ruby-1.8.7).
297
+ </div>
298
+
299
+ </body>
300
+ </html>
@@ -0,0 +1,669 @@
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: RCONSocket
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 (R)</a> &raquo;
35
+
36
+
37
+ <span class="title">RCONSocket</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: RCONSocket
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">RCONSocket</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="SteamSocket.html" title="SteamSocket (module)">SteamSocket</a></span></dd>
95
+
96
+
97
+
98
+
99
+
100
+ <dt class="r1 last">Defined in:</dt>
101
+ <dd class="r1 last">lib/steam/sockets/rcon_socket.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 socket used for RCON communication with game servers
109
+ based on the Source engine (e.g. Team Fortress 2, Counter-Strike: Source)</p>
110
+
111
+ <p>The Source engine uses a stateful TCP connection for RCON communication and
112
+ uses an additional socket of this type to handle RCON requests.</p>
113
+
114
+
115
+ </div>
116
+ </div>
117
+ <div class="tags">
118
+
119
+ <p class="tag_title">Author:</p>
120
+ <ul class="author">
121
+
122
+ <li>
123
+
124
+
125
+
126
+
127
+
128
+ <div class='inline'><p>Sebastian Staudt</p>
129
+ </div>
130
+
131
+ </li>
132
+
133
+ </ul>
134
+
135
+ </div>
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+ <h2>
144
+ Instance Method Summary
145
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
146
+ </h2>
147
+
148
+ <ul class="summary">
149
+
150
+ <li class="public ">
151
+ <span class="summary_signature">
152
+
153
+ <a href="#close-instance_method" title="#close (instance method)">- (Object) <strong>close</strong> </a>
154
+
155
+
156
+
157
+ </span>
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <span class="summary_desc"><div class='inline'><p>Closes the underlying TCP socket if it exists.</p>
168
+ </div></span>
169
+
170
+ </li>
171
+
172
+
173
+ <li class="public ">
174
+ <span class="summary_signature">
175
+
176
+ <a href="#connect-instance_method" title="#connect (instance method)">- (Object) <strong>connect</strong> </a>
177
+
178
+
179
+
180
+ </span>
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+ <span class="summary_desc"><div class='inline'><p>Connects a new TCP socket to the server.</p>
191
+ </div></span>
192
+
193
+ </li>
194
+
195
+
196
+ <li class="public ">
197
+ <span class="summary_signature">
198
+
199
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (RCONSocket) <strong>initialize</strong>(ip, port) </a>
200
+
201
+
202
+
203
+ </span>
204
+
205
+
206
+ <span class="note title constructor">constructor</span>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+ <span class="summary_desc"><div class='inline'><p>Creates a new TCP socket to communicate with the server on the given IP
216
+ address and port.</p>
217
+ </div></span>
218
+
219
+ </li>
220
+
221
+
222
+ <li class="public ">
223
+ <span class="summary_signature">
224
+
225
+ <a href="#reply-instance_method" title="#reply (instance method)">- (RCONPacket) <strong>reply</strong> </a>
226
+
227
+
228
+
229
+ </span>
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+ <span class="summary_desc"><div class='inline'><p>Reads a packet from the socket.</p>
240
+ </div></span>
241
+
242
+ </li>
243
+
244
+
245
+ <li class="public ">
246
+ <span class="summary_signature">
247
+
248
+ <a href="#send-instance_method" title="#send (instance method)">- (Object) <strong>send</strong>(data_packet) </a>
249
+
250
+
251
+
252
+ </span>
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+ <span class="summary_desc"><div class='inline'><p>Sends the given RCON packet to the server.</p>
263
+ </div></span>
264
+
265
+ </li>
266
+
267
+
268
+ </ul>
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="SteamSocket.html" title="SteamSocket (module)">SteamSocket</a></span></h3>
281
+ <p class="inherited"><span class='object_link'><a href="SteamSocket.html#receive_packet-instance_method" title="SteamSocket#receive_packet (method)">#receive_packet</a></span>, <span class='object_link'><a href="SteamSocket.html#timeout%3D-class_method" title="SteamSocket.timeout= (method)">timeout=</a></span></p>
282
+ <div id="constructor_details" class="method_details_list">
283
+ <h2>Constructor Details</h2>
284
+
285
+ <div class="method_details first">
286
+ <h3 class="signature first" id="initialize-instance_method">
287
+
288
+ - (<tt><span class='object_link'><a href="" title="RCONSocket (class)">RCONSocket</a></span></tt>) <strong>initialize</strong>(ip, port)
289
+
290
+
291
+
292
+
293
+
294
+ </h3><div class="docstring">
295
+ <div class="discussion">
296
+ <p>Creates a new TCP socket to communicate with the server on the given IP
297
+ address and port</p>
298
+
299
+
300
+ </div>
301
+ </div>
302
+ <div class="tags">
303
+ <p class="tag_title">Parameters:</p>
304
+ <ul class="param">
305
+
306
+ <li>
307
+
308
+ <span class='name'>ip</span>
309
+
310
+
311
+ <span class='type'>(<tt>String</tt>, <tt>IPAddr</tt>)</span>
312
+
313
+
314
+
315
+ &mdash;
316
+ <div class='inline'><p>Either the IP address or the DNS name of the
317
+ server</p>
318
+ </div>
319
+
320
+ </li>
321
+
322
+ <li>
323
+
324
+ <span class='name'>port</span>
325
+
326
+
327
+ <span class='type'>(<tt>Fixnum</tt>)</span>
328
+
329
+
330
+
331
+ &mdash;
332
+ <div class='inline'><p>The port the server is listening on</p>
333
+ </div>
334
+
335
+ </li>
336
+
337
+ </ul>
338
+
339
+
340
+ </div><table class="source_code">
341
+ <tr>
342
+ <td>
343
+ <pre class="lines">
344
+
345
+
346
+ 33
347
+ 34
348
+ 35
349
+ 36
350
+ 37
351
+ 38</pre>
352
+ </td>
353
+ <td>
354
+ <pre class="code"><span class="info file"># File 'lib/steam/sockets/rcon_socket.rb', line 33</span>
355
+
356
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_ip identifier id'>ip</span><span class='comma token'>,</span> <span class='rubyid_port identifier id'>port</span><span class='rparen token'>)</span>
357
+ <span class='rubyid_ip identifier id'>ip</span> <span class='assign token'>=</span> <span class='rubyid_IPSocket constant id'>IPSocket</span><span class='dot token'>.</span><span class='rubyid_getaddress identifier id'>getaddress</span><span class='lparen token'>(</span><span class='rubyid_ip identifier id'>ip</span><span class='rparen token'>)</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_ip identifier id'>ip</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span> <span class='rubyid_IPAddr constant id'>IPAddr</span>
358
+
359
+ <span class='rubyid_@ip ivar id'>@ip</span> <span class='assign token'>=</span> <span class='rubyid_ip identifier id'>ip</span>
360
+ <span class='rubyid_@port ivar id'>@port</span> <span class='assign token'>=</span> <span class='rubyid_port identifier id'>port</span>
361
+ <span class='rubyid_end end kw'>end</span>
362
+ </pre>
363
+ </td>
364
+ </tr>
365
+ </table>
366
+ </div>
367
+
368
+ </div>
369
+
370
+
371
+ <div id="instance_method_details" class="method_details_list">
372
+ <h2>Instance Method Details</h2>
373
+
374
+
375
+ <div class="method_details first">
376
+ <h3 class="signature first" id="close-instance_method">
377
+
378
+ - (<tt>Object</tt>) <strong>close</strong>
379
+
380
+
381
+
382
+
383
+
384
+ </h3><div class="docstring">
385
+ <div class="discussion">
386
+ <p>Closes the underlying TCP socket if it exists</p>
387
+
388
+ <p>SteamSocket#close</p>
389
+
390
+
391
+ </div>
392
+ </div>
393
+ <div class="tags">
394
+
395
+
396
+ </div><table class="source_code">
397
+ <tr>
398
+ <td>
399
+ <pre class="lines">
400
+
401
+
402
+ 43
403
+ 44
404
+ 45</pre>
405
+ </td>
406
+ <td>
407
+ <pre class="code"><span class="info file"># File 'lib/steam/sockets/rcon_socket.rb', line 43</span>
408
+
409
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_close identifier id'>close</span>
410
+ <span class='rubyid_super super kw'>super</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
411
+ <span class='rubyid_end end kw'>end</span>
412
+ </pre>
413
+ </td>
414
+ </tr>
415
+ </table>
416
+ </div>
417
+
418
+ <div class="method_details ">
419
+ <h3 class="signature " id="connect-instance_method">
420
+
421
+ - (<tt>Object</tt>) <strong>connect</strong>
422
+
423
+
424
+
425
+
426
+
427
+ </h3><div class="docstring">
428
+ <div class="discussion">
429
+ <p>Connects a new TCP socket to the server</p>
430
+
431
+
432
+ </div>
433
+ </div>
434
+ <div class="tags">
435
+
436
+ <p class="tag_title">Raises:</p>
437
+ <ul class="raise">
438
+
439
+ <li>
440
+
441
+
442
+ <span class='type'>(<tt><span class='object_link'><a href="SteamCondenser/TimeoutError.html" title="SteamCondenser::TimeoutError (class)">SteamCondenser::TimeoutError</a></span></tt>)</span>
443
+
444
+
445
+
446
+ &mdash;
447
+ <div class='inline'><p>if the connection could not be
448
+ established</p>
449
+ </div>
450
+
451
+ </li>
452
+
453
+ </ul>
454
+
455
+ </div><table class="source_code">
456
+ <tr>
457
+ <td>
458
+ <pre class="lines">
459
+
460
+
461
+ 51
462
+ 52
463
+ 53
464
+ 54
465
+ 55
466
+ 56
467
+ 57</pre>
468
+ </td>
469
+ <td>
470
+ <pre class="code"><span class="info file"># File 'lib/steam/sockets/rcon_socket.rb', line 51</span>
471
+
472
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_connect identifier id'>connect</span>
473
+ <span class='rubyid_begin begin kw'>begin</span>
474
+ <span class='rubyid_timeout identifier id'>timeout</span><span class='lparen token'>(</span><span class='rubyid_@@timeout ivar id'>@@timeout</span> <span class='div op'>/</span> <span class='float val'>1000.0</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='rubyid_@socket ivar id'>@socket</span> <span class='assign token'>=</span> <span class='rubyid_TCPSocket constant id'>TCPSocket</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_@ip ivar id'>@ip</span><span class='comma token'>,</span> <span class='rubyid_@port ivar id'>@port</span> <span class='rbrace token'>}</span>
475
+ <span class='rubyid_rescue rescue kw'>rescue</span> <span class='rubyid_Timeout constant id'>Timeout</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span>
476
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_TimeoutError constant id'>TimeoutError</span>
477
+ <span class='rubyid_end end kw'>end</span>
478
+ <span class='rubyid_end end kw'>end</span>
479
+ </pre>
480
+ </td>
481
+ </tr>
482
+ </table>
483
+ </div>
484
+
485
+ <div class="method_details ">
486
+ <h3 class="signature " id="reply-instance_method">
487
+
488
+ - (<tt><span class='object_link'><a href="RCONPacket.html" title="RCONPacket (module)">RCONPacket</a></span></tt>) <strong>reply</strong>
489
+
490
+
491
+
492
+
493
+
494
+ </h3><div class="docstring">
495
+ <div class="discussion">
496
+ <p>Reads a packet from the socket</p>
497
+
498
+ <p>The Source RCON protocol allows packets of an arbitrary sice transmitted
499
+ using multiple TCP packets. The data is received in chunks and concatenated
500
+ into a single response packet.</p>
501
+
502
+
503
+ </div>
504
+ </div>
505
+ <div class="tags">
506
+
507
+ <p class="tag_title">Returns:</p>
508
+ <ul class="return">
509
+
510
+ <li>
511
+
512
+
513
+ <span class='type'>(<tt><span class='object_link'><a href="RCONPacket.html" title="RCONPacket (module)">RCONPacket</a></span></tt>)</span>
514
+
515
+
516
+
517
+ &mdash;
518
+ <div class='inline'><p>The packet replied from the server</p>
519
+ </div>
520
+
521
+ </li>
522
+
523
+ </ul>
524
+ <p class="tag_title">Raises:</p>
525
+ <ul class="raise">
526
+
527
+ <li>
528
+
529
+
530
+ <span class='type'>(<tt><span class='object_link'><a href="RCONBanError.html" title="RCONBanError (class)">RCONBanError</a></span></tt>)</span>
531
+
532
+
533
+
534
+ &mdash;
535
+ <div class='inline'><p>if the IP of the local machine has been banned on the
536
+ game server</p>
537
+ </div>
538
+
539
+ </li>
540
+
541
+ </ul>
542
+
543
+ </div><table class="source_code">
544
+ <tr>
545
+ <td>
546
+ <pre class="lines">
547
+
548
+
549
+ 78
550
+ 79
551
+ 80
552
+ 81
553
+ 82
554
+ 83
555
+ 84
556
+ 85
557
+ 86
558
+ 87
559
+ 88
560
+ 89
561
+ 90
562
+ 91</pre>
563
+ </td>
564
+ <td>
565
+ <pre class="code"><span class="info file"># File 'lib/steam/sockets/rcon_socket.rb', line 78</span>
566
+
567
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_reply identifier id'>reply</span>
568
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_RCONBanError constant id'>RCONBanError</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_receive_packet identifier id'>receive_packet</span><span class='lparen token'>(</span><span class='integer val'>4</span><span class='rparen token'>)</span> <span class='eq op'>==</span> <span class='integer val'>0</span>
569
+
570
+ <span class='rubyid_remaining_bytes identifier id'>remaining_bytes</span> <span class='assign token'>=</span> <span class='rubyid_@buffer ivar id'>@buffer</span><span class='dot token'>.</span><span class='rubyid_long identifier id'>long</span>
571
+
572
+ <span class='rubyid_packet_data identifier id'>packet_data</span> <span class='assign token'>=</span> <span class='string val'>''</span>
573
+ <span class='rubyid_begin begin kw'>begin</span>
574
+ <span class='rubyid_received_bytes identifier id'>received_bytes</span> <span class='assign token'>=</span> <span class='rubyid_receive_packet identifier id'>receive_packet</span> <span class='rubyid_remaining_bytes identifier id'>remaining_bytes</span>
575
+ <span class='rubyid_remaining_bytes identifier id'>remaining_bytes</span> <span class='opasgn op'>-=</span> <span class='rubyid_received_bytes identifier id'>received_bytes</span>
576
+ <span class='rubyid_packet_data identifier id'>packet_data</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_@buffer ivar id'>@buffer</span><span class='dot token'>.</span><span class='rubyid_get identifier id'>get</span>
577
+ <span class='rubyid_end end kw'>end</span> <span class='rubyid_while while_mod kw'>while</span> <span class='rubyid_remaining_bytes identifier id'>remaining_bytes</span> <span class='gt op'>&gt;</span> <span class='integer val'>0</span>
578
+
579
+ <span class='rubyid_RCONPacketFactory constant id'>RCONPacketFactory</span><span class='dot token'>.</span><span class='rubyid_packet_from_data identifier id'>packet_from_data</span><span class='lparen token'>(</span><span class='rubyid_packet_data identifier id'>packet_data</span><span class='rparen token'>)</span>
580
+ <span class='rubyid_end end kw'>end</span>
581
+ </pre>
582
+ </td>
583
+ </tr>
584
+ </table>
585
+ </div>
586
+
587
+ <div class="method_details ">
588
+ <h3 class="signature " id="send-instance_method">
589
+
590
+ - (<tt>Object</tt>) <strong>send</strong>(data_packet)
591
+
592
+
593
+
594
+
595
+
596
+ </h3><div class="docstring">
597
+ <div class="discussion">
598
+ <p>Sends the given RCON packet to the server</p>
599
+
600
+
601
+ </div>
602
+ </div>
603
+ <div class="tags">
604
+ <p class="tag_title">Parameters:</p>
605
+ <ul class="param">
606
+
607
+ <li>
608
+
609
+ <span class='name'>data_packet</span>
610
+
611
+
612
+ <span class='type'>(<tt><span class='object_link'><a href="RCONPacket.html" title="RCONPacket (module)">RCONPacket</a></span></tt>)</span>
613
+
614
+
615
+
616
+ &mdash;
617
+ <div class='inline'><p>The RCON packet to send to the server</p>
618
+ </div>
619
+
620
+ </li>
621
+
622
+ </ul>
623
+
624
+
625
+ <p class="tag_title">See Also:</p>
626
+ <ul class="see">
627
+
628
+ <li><span class='object_link'><a href="#connect-instance_method" title="RCONSocket#connect (method)">#connect</a></span></li>
629
+
630
+ </ul>
631
+
632
+ </div><table class="source_code">
633
+ <tr>
634
+ <td>
635
+ <pre class="lines">
636
+
637
+
638
+ 63
639
+ 64
640
+ 65
641
+ 66
642
+ 67</pre>
643
+ </td>
644
+ <td>
645
+ <pre class="code"><span class="info file"># File 'lib/steam/sockets/rcon_socket.rb', line 63</span>
646
+
647
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_send identifier id'>send</span><span class='lparen token'>(</span><span class='rubyid_data_packet identifier id'>data_packet</span><span class='rparen token'>)</span>
648
+ <span class='rubyid_connect identifier id'>connect</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span> <span class='orop op'>||</span> <span class='rubyid_@socket ivar id'>@socket</span><span class='dot token'>.</span><span class='rubyid_closed? fid id'>closed?</span>
649
+
650
+ <span class='rubyid_super super kw'>super</span>
651
+ <span class='rubyid_end end kw'>end</span>
652
+ </pre>
653
+ </td>
654
+ </tr>
655
+ </table>
656
+ </div>
657
+
658
+ </div>
659
+
660
+ </div>
661
+
662
+ <div id="footer">
663
+ Generated on Sat Jul 21 13:09:36 2012 by
664
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
665
+ 0.8.2.1 (ruby-1.8.7).
666
+ </div>
667
+
668
+ </body>
669
+ </html>