Module: GameServer

Included in:
GoldSrcServer, SourceServer
Defined in:
lib/steam/servers/game_server.rb

Constant Summary collapse

REQUEST_CHALLENGE = 
0
REQUEST_INFO = 
1
REQUEST_PLAYER = 
2
REQUEST_RULES = 
3

Instance Method Summary collapse

Instance Method Details

#handle_response_for_request(request_type, repeat_on_failure = true) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/steam/servers/game_server.rb', line 76

def handle_response_for_request(request_type, repeat_on_failure = true)
  begin
    case request_type
      when GameServer::REQUEST_CHALLENGE then
        request_packet = A2S_SERVERQUERY_GETCHALLENGE_Packet.new
        expected_response = S2C_CHALLENGE_Packet
      when GameServer::REQUEST_INFO then
        request_packet = A2S_INFO_Packet.new
        expected_response = S2A_INFO_BasePacket
      when GameServer::REQUEST_PLAYER then
        request_packet = A2S_PLAYER_Packet.new(@challenge_number)
        expected_response = S2A_PLAYER_Packet
      when GameServer::REQUEST_RULES then
        request_packet = A2S_RULES_Packet.new(@challenge_number)
        expected_response = S2A_RULES_Packet
      else
        raise SteamCondenserException.new("Called with wrong request type.")
    end

    send_request request_packet
    response_packet = reply

    if response_packet.kind_of? S2A_INFO_BasePacket
      @info_hash = response_packet.info_hash
    elsif response_packet.kind_of? S2A_PLAYER_Packet
      @player_hash = response_packet.player_hash
    elsif response_packet.kind_of? S2A_RULES_Packet
      @rules_hash = response_packet.rules_hash
    elsif response_packet.kind_of? S2C_CHALLENGE_Packet
      @challenge_number = response_packet.challenge_number
    else
      raise SteamCondenserException.new("Response of type #{response_packet.class} cannot be handled by this method.")
    end

    unless response_packet.kind_of? expected_response
      puts "Expected #{expected_response}, got #{response_packet.class}." if $DEBUG
      handle_response_for_request(request_type, false) if repeat_on_failure
    end
  rescue TimeoutException
    puts "Expected #{expected_response}, but timed out." if $DEBUG
  end
end

#init ⇒ Object 



119
120
121
122
123
 
# File 'lib/steam/servers/game_server.rb', line 119

def init
  update_ping
  update_server_info
  update_challenge_number
end

#initialize(port_number = 27015) ⇒ Object

Checks whether the listening port number of the server is in a valid range



161
162
163
164
165
 
# File 'lib/steam/servers/game_server.rb', line 161

def initialize(port_number = 27015)
  unless port_number.to_i > 0 and port_number.to_i < 65536
    raise ArgumentError.new('The listening port of the server has to be a number greater than 0 and less than 65536.')
  end
end

#ping ⇒ Object

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.

Whenever you want to get a new value for the ping time call update_ping.



31
32
33
34
 
# File 'lib/steam/servers/game_server.rb', line 31

def ping
  update_ping if @ping.nil?
  @ping
end

#players(rcon_password = nil) ⇒ Object

Returns an array of the player’s currently playing on this server.

If there’s no data, update_player_info is called to get the current list of players.

As the players and their scores change quite often be sure to update this list regularly by calling update_player_info.



43
44
45
46
 
# File 'lib/steam/servers/game_server.rb', line 43

def players(rcon_password = nil)
  update_player_info(rcon_password) if @player_hash.nil?
  @player_hash
end

#rules ⇒ Object

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

If there’s no data, update_rules_info is called to get the current list of rules.

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.



58
59
60
61
 
# File 'lib/steam/servers/game_server.rb', line 58

def rules
  update_rules_info if @rules_hash.nil?
  @rules_hash
end

#server_info ⇒ Object

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.

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.



71
72
73
74
 
# File 'lib/steam/servers/game_server.rb', line 71

def server_info
  update_server_info if @info_hash.nil?
  @info_hash
end

#to_s ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/steam/servers/game_server.rb', line 167

def to_s
  return_string = ''

  return_string << "Ping: #{@ping}\n"
  return_string << "Challenge number: #{@challenge_number}\n"

  unless @info_hash.nil?
    return_string << "Info:\n"
    @info_hash.each do |key, value|
      return_string << "  #{key}: #{value.inspect}\n"
    end
  end

  unless @player_hash.nil?
    return_string << "Players:\n"
    @player_hash.each_value do |player|
      return_string << "  #{player}\n"
    end
  end

  unless @rules_hash.nil?
    return_string << "Rules:\n"
    @rules_hash.each do |key, value|
      return_string << "  #{key}: #{value}\n"
    end
  end

  return_string
end

#update_challenge_number ⇒ Object 



148
149
150
 
# File 'lib/steam/servers/game_server.rb', line 148

def update_challenge_number
  handle_response_for_request GameServer::REQUEST_CHALLENGE
end

#update_ping ⇒ Object 



152
153
154
155
156
157
158
 
# File 'lib/steam/servers/game_server.rb', line 152

def update_ping
  send_request A2A_PING_Packet.new
  start_time = Time.now
  reply
  end_time = Time.now
  @ping = (end_time - start_time) * 1000
end

#update_player_info(rcon_password = nil) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/steam/servers/game_server.rb', line 125

def update_player_info(rcon_password = nil)
  handle_response_for_request GameServer::REQUEST_PLAYER

  unless rcon_password.nil? or @player_hash.empty?
    rcon_auth(rcon_password)
    players = rcon_exec('status').split("\n")[7..-1]
    players.pop if is_a? GoldSrcServer

    players.each do |player|
      player_data = self.class.split_player_status(player)
      @player_hash[player_data[1]].add_info(*player_data) if @player_hash.key?(player_data[1])
    end
  end
end

#update_rules_info ⇒ Object 



140
141
142
 
# File 'lib/steam/servers/game_server.rb', line 140

def update_rules_info
  handle_response_for_request GameServer::REQUEST_RULES
end

#update_server_info ⇒ Object 



144
145
146
 
# File 'lib/steam/servers/game_server.rb', line 144

def update_server_info
  handle_response_for_request GameServer::REQUEST_INFO
end