steam-condenser 0.13.1 → 0.14.0

data/lib/steam/packets/rcon/rcon_terminator.rb

@@ -5,16 +5,25 @@
 
 require 'steam/packets/rcon/rcon_packet'
 
-# This class is used to determine the end of a RCON response from Source
-# servers. Packets of this type are sent after the actual RCON command and the
-# empty response packet from the server will indicate the end of the response.
+# This packet class represents a special SERVERDATA_RESPONSE_VALUE packet which
+# is sent to the server
+#
+# It is used to determine the end of a RCON response from Source servers.
+# Packets of this type are sent after the actual RCON command and the empty
+# response packet from the server will indicate the end of the response.
+#
+# @author Sebastian Staudt
+# @see SourceServer#rcon_exec
 class RCONTerminator
 
   include RCONPacket
 
-  # Creates a new RCONTerminator instance for the given request ID
+  # Creates a new RCON terminator packet instance for the given request ID
+  #
+  # @param [Fixnum] request_id The request ID for the current RCON
+  #        communication
   def initialize(request_id)
-    super request_id, RCONPacket::SERVERDATA_RESPONSE_VALUE, nil
+    super request_id, SERVERDATA_RESPONSE_VALUE, nil
   end
 
 end

data/lib/steam/packets/request_with_challenge.rb

@@ -1,12 +1,17 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
-# This module implements a to_s method for request packets which send a challenge number
+# This module implements a method to generate raw packet data used by request
+# packets which send a challenge number
+#
+# @author Sebastian Staudt
 module RequestWithChallenge
 
-  # Returns a packed version of the request
+  # Returns the raw data representing this packet
+  #
+  # @return string A string containing the raw data of this request packet
   def to_s
     [0xFF, 0xFF, 0xFF, 0xFF, @header_data, @content_data.string.to_i].pack('c5l')
   end

data/lib/steam/packets/s2a_info2_packet.rb

@@ -1,17 +1,26 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
 # Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/s2a_info_base_packet'
 
-# The S2A_INFO2_Packet class represents the response to a A2S_INFO request sent
-# to a Source server.
+# This class represents a S2A_INFO_DETAILED response packet sent by a Source or
+# GoldSrc server
+#
+# Out-of-date (before 10/24/2008) GoldSrc servers use an older format (see
+# {S2A_INFO_DETAILED_Packet}).
+#
+# @author Sebastian Staudt
+# @see GameServer#update_server_info
 class S2A_INFO2_Packet
 
   include S2A_INFO_BasePacket
 
-  # Creates a S2A_INFO2 response object based on the data received.
+  # Creates a new S2A_INFO2 response object based on the given data
+  #
+  # @param [String] data The raw packet data replied from the server
+  # @see S2A_INFO_BasePacket#generate_info_hash
   def initialize(data)
     super S2A_INFO2_HEADER, data
 

data/lib/steam/packets/s2a_info_base_packet.rb

@@ -1,19 +1,29 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
-# The S2A_INFO_BasePacket class represents the response to a A2S_INFO
-# request send to the server.
+# This module implements methods to generate and access server information from
+# S2A_INFO_DETAILED and S2A_INFO2 response packets
+#
+# @author Sebastian Staudt
+# @see S2A_INFO_DETAILED_Packet
+# @see S2A_INFO2_Packet
 module S2A_INFO_BasePacket
 
   include SteamPacket
 
+  # Returns the information provided by the server
+  #
+  # @return [Hash<String, Object>] The information provided by the server
   attr_reader :info_hash
 
-  # Returns the hash containing information on the server
+  protected
+
+  # Generates a hash of server properties from the instance variables of the
+  # including packet object
   def generate_info_hash
     @info_hash = Hash[
       *instance_variables.map { |var|

data/lib/steam/packets/s2a_info_detailed_packet.rb

@@ -1,19 +1,26 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2008-2010, Sebastian Staudt
+# Copyright (c) 2008-2011 Sebastian Staudt
 
 require "steam/packets/s2a_info_base_packet"
 
-# The S2A_INFO_DETAILED_Packet class represents the response to a A2S_INFO
-# request send to a GoldSrc server.
-# This is deprecated by 10/24/2008 for GoldSrc servers. They use the same
-# format as Source servers (S2A_INFO2) now.
+# This class represents a S2A_INFO_DETAILED response packet sent by a GoldSrc
+# server
+#
+# This is deprecated by 10/24/2008. GoldSrc servers use the same format as
+# Source servers now (see {S2A_INFO2_Packet}).
+#
+# @author Sebastian Staudt
+# @see GameServer#update_server_info
 class S2A_INFO_DETAILED_Packet
 
   include S2A_INFO_BasePacket
 
-  # Creates a S2A_INFO_DETAILED response object based on the data received.
+  # Creates a new S2A_INFO_DETAILED response object based on the given data
+  #
+  # @param [String] data The raw packet data replied from the server
+  # @see S2A_INFO_BasePacket#generate_info_hash
   def initialize(data)
     super S2A_INFO_DETAILED_HEADER, data
 

data/lib/steam/packets/s2a_logstring_packet.rb

@@ -1,19 +1,25 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
 # Copyright (c) 2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
-# The S2A_LOGSTRING packet type is used to transfer log messages.
+# This class represents a S2A_LOGSTRING packet used to transfer log messages
+#
+# @author Sebastian Staudt
 class S2A_LOGSTRING_Packet
 
   include SteamPacket
 
-  # The log message contained in this packet
+  # Returns the log message contained in this packet
+  #
+  # @return [String] The log message
   attr_reader :message
 
-  # Creates a new log message packet
+  # Creates a new S2A_LOGSTRING object based on the given data
+  #
+  # @param [String] data The raw packet data sent by the server
   def initialize(data)
     super S2A_LOGSTRING_HEADER, data
 

data/lib/steam/packets/s2a_player_packet.rb

@@ -1,25 +1,33 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
 # Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
-# The S2A_PLAYER_Packet class represents the response to a A2S_PLAYER
-# request send to the server.
+# This class represents a S2A_PLAYER response sent by a game server
+#
+# It is used to transfer a list of players currently playing on the server.
+#
+# @author Sebastian Staudt
+# @see GameServer#update_player_info
 class S2A_PLAYER_Packet
 
   include SteamPacket
 
+  # Returns the list of active players provided by the server
+  #
+  # @return [Hash<String, SteamPlayer>] All active players on the server
   attr_reader :player_hash
 
-  # Creates a S2A_PLAYER response object based on the data received.
+  # Creates a new S2A_PLAYER response object based on the given data
+  #
+  # @param [String] content_data The raw packet data sent by the server
   def initialize(content_data)
     raise Exception.new('Wrong formatted S2A_PLAYER packet.') if content_data.nil?
 
     super S2A_PLAYER_HEADER, content_data
 
-    # Ignore player count
     @content_data.byte
     @player_hash = {}
 

data/lib/steam/packets/s2a_rules_packet.rb

@@ -1,19 +1,29 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
 # Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
-# The S2A_RULES_Packet class represents the response to a A2S_RULES
-# request send to the server.
+# This class represents a S2A_RULES response sent by a game server
+#
+# It is used to transfer a list of server rules (a.k.a. CVARs) with their
+# active values.
+#
+# @author Sebastian Staudt
+# @see GameServer#update_rules_info
 class S2A_RULES_Packet
 
   include SteamPacket
 
+  # Returns the list of server rules (a.k.a. CVars) with the current values
+  #
+  # @return [Hash<String, String>] A list of server rules
   attr_reader :rules_hash
 
-  # Creates a S2A_RULES response object based on the data received.
+  # Creates a new S2A_RULES response object based on the given data
+  #
+  # @param [String] content_data The raw packet data sent by the server
   def initialize(content_data)
     raise Exception.new('Wrong formatted S2A_RULES response packet.') if content_data.nil?
 

data/lib/steam/packets/s2c_challenge_packet.rb

@@ -1,22 +1,33 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
 # Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'steam/packets/steam_packet'
 
-# The S2C_CHALLENGE_Packet class represents the response
-# to a A2S_SERVERQUERY_GETCHALLENGE request send to the server.
+# This packet class represents a S2C_CHALLENGE response replied by a game
+# server
+#
+# It is used to provide a challenge number to a client requesting information
+# from the game server.
+#
+# @author Sebastian Staudt
+# @see GameServer#update_challenge_number
 class S2C_CHALLENGE_Packet
 
   include SteamPacket
 
-  # Creates a S2C_CHALLENGE response object based on the data received.
+  # Creates a new S2C_CHALLENGE response object based on the given data
+  #
+  # @param [String] challenge_number The raw packet data replied from the
+  #        server
   def initialize(challenge_number)
     super S2C_CHALLENGE_HEADER, challenge_number
   end
 
-  # Returns the challenge number received from the server
+  # Returns the challenge number received from the game server
+  #
+  # @return [Fixnum] The challenge number provided by the game server
   def challenge_number
     @content_data.rewind
     @content_data.long

data/lib/steam/packets/s2m_heartbeat2_packet.rb

@@ -5,12 +5,19 @@
 
 require 'steam/packets/steam_packet'
 
-# The S2M_HEARTBEAT2 packet type is used to signal a game servers availability
-# and status to the master servers.
+# This class represents a S2M_HEARTBEAT2 packet sent by game servers to master
+# servers
+#
+# It is used to signal the game server's availability and status to the master
+# servers.
+#
+# @author Sebastian Staudt
+# @see MasterServer#send_heartbeat
 class S2M_HEARTBEAT2_Packet
 
   include SteamPacket
 
+  # Default data to send with a S2M_HEARTBEAT2 packet
   DEFAULT_DATA = {
     :appid     => 320,
     :bots      => 0,
@@ -34,7 +41,12 @@ class S2M_HEARTBEAT2_Packet
     :version   => '1.0.0.0'
   }
 
-  # Creates a new heartbeat packet to send to a master server
+  # Creates a new S2M_HEARTBEAT2 packet object based on the given data
+  #
+  # @param [Hash<Symbol, Object>] data The data to send with the heartbeat. The
+  #        data contents are merge with the values from {DEFAULT_DATA}.
+  # @raise [SteamCondenserException] when the required challenge number is
+  #        missing
   def initialize(data = {})
     data = DEFAULT_DATA.merge data
 
@@ -49,7 +61,9 @@ class S2M_HEARTBEAT2_Packet
     super S2M_HEARTBEAT2_HEADER, bytes
   end
 
-  # Returns a byte array representation of the packet data
+  # Returns the raw data representing this packet
+  #
+  # @return [String] A string containing the raw data of this request packet
   def to_s
     [@header_data, @content_data.string].pack('ca*')
   end

data/lib/steam/packets/steam_packet.rb

@@ -1,11 +1,15 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
 # Copyright (c) 2008-2011, Sebastian Staudt
 
 require 'stringio_additions'
 
-# This class represents a packet used by the Source query protocol
+# This module implements the basic functionality used by most of the packets
+# used in communication with master, Source or GoldSrc servers.
+#
+# @author Sebastian Staudt
+# @see SteamPacketFactory
 module SteamPacket
 
   A2M_GET_SERVERS_BATCH2_HEADER = 0x31
@@ -29,13 +33,18 @@ module SteamPacket
   S2C_CHALLENGE_HEADER = 0x41
   S2M_HEARTBEAT2_HEADER = 0x30
 
-  # Creates a new SteamPacket object with given header and content data
+  # Creates a new packet object based on the given data
+  #
+  # @param [Fixnum] header_data The packet header
+  # @param [String] content_data The raw data of the packet
   def initialize(header_data, content_data = '')
     @content_data = StringIO.new content_data.to_s
     @header_data  = header_data
   end
 
-  # Returns a packed string representing the packet's data
+  # Returns the raw data representing this packet
+  #
+  # @return [String] A string containing the raw data of this request packet
   def to_s
     [0xFF, 0xFF, 0xFF, 0xFF, @header_data, @content_data.string].pack('c5a*')
   end

data/lib/steam/packets/steam_packet_factory.rb

@@ -1,5 +1,5 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
 # Copyright (c) 2008-2011, Sebastian Staudt
 
@@ -20,9 +20,19 @@ require 'steam/packets/m2s_requestrestart_packet'
 require 'steam/packets/s2a_logstring_packet'
 require 'steam/packets/rcon/rcon_goldsrc_response'
 
+# This module provides functionality to handle raw packet data, including
+# data split into several UDP / TCP packets and BZIP2 compressed data. It's the
+# main utility to transform data bytes into packet objects.
+#
+# @author Sebastian Staudt
+# @see SteamPacket
 module SteamPacketFactory
 
   # Creates a new packet object based on the header byte of the given raw data
+  #
+  # @param [String] raw_data The raw data of the packet
+  # @raise [SteamCondenserException] if the packet header is not recognized
+  # @return [SteamPacket] The packet object generated from the packet data
   def self.packet_from_data(raw_data)
     header = raw_data[0].ord
     data = raw_data[1..-1]
@@ -65,6 +75,19 @@ module SteamPacketFactory
     end
   end
 
+  # Reassembles the data of a split and/or compressed packet into a single
+  # packet object
+  #
+  # @param [Array<String>] split_packets An array of packet data
+  # @param [true, false] is_compressed whether the data of this packet is
+  #        compressed
+  # @param [Fixnum] packet_checksum The CRC32 checksum of the decompressed
+  #        packet data
+  # @raise [SteamCondenserException] if the bz2 gem is not installed
+  # @raise [PacketFormatException] if the calculated CRC32 checksum does not
+  #        match the expected value
+  # @return [SteamPacket] The reassembled packet
+  # @see packet_from_data
   def self.reassemble_packet(split_packets, is_compressed = false, packet_checksum = 0)
     packet_data = split_packets.join ''
 

data/lib/steam/servers/game_server.rb

@@ -1,5 +1,5 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
 # Copyright (c) 2008-2011, Sebastian Staudt
 
@@ -15,6 +15,11 @@ require 'steam/packets/s2a_rules_packet'
 require 'steam/packets/s2c_challenge_packet'
 require 'steam/servers/server'
 
+# This module is included by classes representing different game server
+# implementations and provides the basic functionality to communicate with
+# them using the common query protocol
+#
+# @author Sebastian Staudt
 module GameServer
 
   include Server
@@ -24,7 +29,11 @@ module GameServer
   REQUEST_PLAYER = 2
   REQUEST_RULES = 3
 
-  # Parses the player attribute names supplied by +rcon status+
+  # Parses the player attribute names supplied by `rcon status`
+  #
+  # @param [String] status_header The header line provided by `rcon status`
+  # @return [Array<Symbol>] Split player attribute names
+  # @see .split_player_status
   def self.player_status_attributes(status_header)
     status_header.split.map do |attribute|
       case attribute
@@ -38,7 +47,13 @@ module GameServer
     end
   end
 
-  # Splits the player status obtained with +rcon status+
+  # Splits the player status obtained with `rcon status`
+  #
+  # @param [Array<Symbol>] attributes The attribute names
+  # @param [String] player_status The status line of a single player
+  # @return [Hash<Symbol, String>] The attributes with the corresponding values
+  #         for this player
+  # @see .player_status_attributes
   def self.split_player_status(attributes, player_status)
     player_status.sub! /^\d+ +/, '' if attributes.first != :userid
 
@@ -68,66 +83,119 @@ module GameServer
 
   # Creates a new instance of a game server object
   #
-  # The port defaults to 27015 for game servers
+  # @param [String] address Either an IP address, a DNS name or one of them
+  #        combined with the port number. If a port number is given, e.g.
+  #        'server.example.com:27016' it will override the second argument.
+  # @param [Fixnum] port The port the server is listening on
+  # @raise [SteamCondenserException] if an host name cannot be resolved
   def initialize(address, port = 27015)
     super
   end
 
   # Returns the last measured response time of this server
   #
-  # If there's no data, update_ping is called to measure the current response
-  # time of the server.
+  # If the latency hasn't been measured yet, it is done when calling this
+  # method for the first time.
   #
-  # Whenever you want to get a new value for the ping time call update_ping.
+  # If this information is vital to you, be sure to call {#update_ping}
+  # regularly to stay up-to-date.
+  #
+  # @return [Fixnum] The latency of this server in milliseconds
+  # @see #update_ping
   def ping
     update_ping if @ping.nil?
     @ping
   end
 
-  # Returns an array of the player's currently playing on this server.
+  # Returns a list of players currently playing on this server
   #
-  # If there's no data, update_player_info is called to get the current list of
-  # players.
+  # If the players haven't been fetched yet, it is done when calling this
+  # method for the first time.
   #
   # As the players and their scores change quite often be sure to update this
-  # list regularly by calling update_player_info.
+  # list regularly by calling {#update_players} if you rely on this
+  # information.
+  #
+  # @param [String] rcon_password The RCON password of this server may be
+  #        provided to gather more detailed information on the players, like
+  #        STEAM_IDs.
+  # @return [Hash] The players on this server
+  # @see update_players
   def players(rcon_password = nil)
-    update_player_info(rcon_password) if @player_hash.nil?
+    update_players(rcon_password) if @player_hash.nil?
     @player_hash
   end
 
+  # Authenticates the connection for RCON communication with the server
+  #
+  # @abstract Must be be implemented by including classes to handle the
+  #           authentication
+  # @param [String] password The RCON password of the server
+  # @return [Boolean] whether the authentication was successful
+  # @see #rcon_exec
+  def rcon_auth(password)
+  end
+
   def rcon_authenticated?
     @rcon_authenticated
   end
 
-  # Returns a hash of the settings applied on the server. These settings are
-  # also called rules.
-  # The hash has the format of +rule_name+ => +rule_value+
+  # Remotely executes a command on the server via RCON
   #
-  # If there's no data, update_rules_info is called to get the current list of
+  # @abstract Must be be implemented by including classes to handle the command
+  #           execution
+  # @param [String] command The command to execute on the server
+  # @return [String] The output of the executed command
+  # @see #rcon_auth
+  def rcon_exec(command)
+  end
+
+  # Returns the settings applied on the server. These settings are also called
   # rules.
   #
+  # If the rules haven't been fetched yet, it is done when calling this method
+  # for the first time.
+  #
   # As the rules usually don't change often, there's almost no need to update
   # this hash. But if you need to, you can achieve this by calling
-  # update_rules_info.
+  # {#update_rules}.
+  #
+  # @return [Hash<String, String>] The currently active server rules
+  # @see #update_rules
   def rules
-    update_rules_info if @rules_hash.nil?
+    update_rules if @rules_hash.nil?
     @rules_hash
   end
 
   # Returns a hash with basic information on the server.
   #
-  # If there's no data, update_server_info is called to get up-to-date
-  # information.
+  # If the server information haven't been fetched yet, it is done when
+  # calling this method for the first time.
   #
   # The server information usually only changes on map change and when players
   # join or leave. As the latter changes can be monitored by calling
-  # update_player_info, there's no need to call update_server_info very often.
+  # {#update_players}, there's no need to call {#update_server_info} very
+  # often.
+  #
+  # @return [Hash] Server attributes with their values
+  # @see #update_server_info
   def server_info
     update_server_info if @info_hash.nil?
     @info_hash
   end
 
+  # Sends the specified request to the server and handles the returned response
+  #
+  # Depending on the given request type this will fill the various data
+  # attributes of the server object.
+  #
+  # @param [Fixnum] request_type The type of request to send to the server
+  # @param [Boolean] repeat_on_failure Whether the request should be repeated,
+  #        if the replied packet isn't expected. This is useful to handle
+  #        missing challenge numbers, which will be automatically filled in,
+  #        although not requested explicitly.
+  # @raise [SteamCondenserException] if either the request type or the response
+  #        packet is not known
   def handle_response_for_request(request_type, repeat_on_failure = true)
     begin
       case request_type
@@ -171,13 +239,30 @@ module GameServer
     end
   end
 
+  # Initializes this server object with basic information
+  #
+  # @see #update_challenge_number
+  # @see #update_ping
+  # @see #update_server_info
   def init
     update_ping
     update_server_info
     update_challenge_number
   end
 
-  def update_player_info(rcon_password = nil)
+  # Sends a A2S_PLAYERS request to the server and updates the players' data for
+  # this server
+  #
+  # As the players and their scores change quite often be sure to update this
+  # list regularly by calling this method if you rely on this
+  # information.
+  #
+  # @param [String] rcon_password The RCON password of this server may be
+  #        provided to gather more detailed information on the players, like
+  #        STEAM_IDs.
+  # @see #handle_response_for_request
+  # @see #players
+  def update_players(rcon_password = nil)
     handle_response_for_request GameServer::REQUEST_PLAYER
 
     unless rcon_password.nil? || @player_hash.nil? || @player_hash.empty?
@@ -198,18 +283,52 @@ module GameServer
     end
   end
 
-  def update_rules_info
+  # Sends a A2S_RULES request to the server and updates the rules of this
+  # server
+  #
+  # As the rules usually don't change often, there's almost no need to update
+  # this hash. But if you need to, you can achieve this by calling this method.
+  #
+  # @see #handle_response_for_request
+  # @see #rules
+  def update_rules
     handle_response_for_request GameServer::REQUEST_RULES
   end
 
+  # Sends a A2S_INFO request to the server and updates this server's basic
+  # information
+  #
+  # The server information usually only changes on map change and when players
+  # join or leave. As the latter changes can be monitored by calling
+  # {#update_players}, there's no need to call this method very often.
+  #
+  # @see #handle_response_for_request
+  # @see #server_info
   def update_server_info
     handle_response_for_request GameServer::REQUEST_INFO
   end
 
+  # Sends a A2S_SERVERQUERY_GETCHALLENGE request to the server and updates the
+  # challenge number used to communicate with this server
+  #
+  # There's usually no need to call this method explicitly, because
+  # {#handle_response_for_request} will automatically get the challenge number
+  # when the server assigns a new one.
+  #
+  # @see #handle_response_for_request
+  # @see #init
   def update_challenge_number
     handle_response_for_request GameServer::REQUEST_CHALLENGE
   end
 
+  # Sends a A2S_INFO request to the server and measures the time needed for the
+  # reply
+  #
+  # If this information is vital to you, be sure to call this method regularly
+  # to stay up-to-date.
+  #
+  # @return [Fixnum] The latency of this server in milliseconds
+  # @see #ping
   def update_ping
     send_request A2S_INFO_Packet.new
     start_time = Time.now
@@ -218,6 +337,10 @@ module GameServer
     @ping = (end_time - start_time) * 1000
   end
 
+  # Returns a human-readable text representation of the server
+  #
+  # @return [String] Available information about the server in a human-readable
+  #         format
   def to_s
     return_string = ''
 
@@ -250,11 +373,17 @@ module GameServer
 
   protected
 
+  # Receives a response from the server
+  #
+  # @return [SteamPacket] The response packet replied by the server
   def reply
     @socket.reply
   end
 
-  def send_request packet
+  # Sends a request packet to the server
+  #
+  # @param [SteamPacket] packet The request packet to send to the server
+  def send_request(packet)
     @socket.send packet
   end