Class: Protocol
- Inherits:
-
Object
- Object
- Protocol
- Includes:
- Logging, REXML::StreamListener
- Defined in:
- lib/software_challenge_client/protocol.rb
Overview
This class handles communication to the server over the XML communication protocol. Messages from the server are parsed and moves are serialized and send back.
Instance Attribute Summary collapse
-
#client ⇒ ClientInterface
readonly
Current client.
-
#gamestate ⇒ Gamestate
readonly
Current gamestate.
-
#roomId ⇒ String
Current room id.
Instance Method Summary collapse
-
#initialize(network, client) ⇒ Protocol
constructor
A new instance of Protocol.
-
#move_to_xml(move) ⇒ Object
Converts a move to XML for sending to the server.
-
#parsePlayer(attributes) ⇒ Player
Converts XML attributes for a Player to a new Player object.
-
#process_string(text) ⇒ Object
starts xml-string parsing.
-
#sendString(string) ⇒ Object
send a string.
-
#sendXml(document) ⇒ Object
send a xml document.
-
#tag_end(name) ⇒ Object
called if an end-tag is read.
-
#tag_start(name, attrs) ⇒ Object
called if a start tag is read Depending on the tag the gamestate is updated or the client will be asked for a move.
Methods included from Logging
Constructor Details
#initialize(network, client) ⇒ Protocol
Returns a new instance of Protocol.
30 31 32 33 34 35 36 |
# File 'lib/software_challenge_client/protocol.rb', line 30 def initialize(network, client) @gamestate = GameState.new @network = network @client = client @context = {} # for saving context when stream-parsing the XML @client.gamestate = @gamestate end |
Instance Attribute Details
#client ⇒ ClientInterface (readonly)
Returns current client.
28 29 30 |
# File 'lib/software_challenge_client/protocol.rb', line 28 def client @client end |
#gamestate ⇒ Gamestate (readonly)
Returns current gamestate.
22 23 24 |
# File 'lib/software_challenge_client/protocol.rb', line 22 def gamestate @gamestate end |
#roomId ⇒ String
Returns current room id.
25 26 27 |
# File 'lib/software_challenge_client/protocol.rb', line 25 def roomId @roomId end |
Instance Method Details
#move_to_xml(move) ⇒ Object
Converts a move to XML for sending to the server.
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/software_challenge_client/protocol.rb', line 177 def move_to_xml(move) builder = Builder::XmlMarkup.new(indent: 2) builder.data(class: 'move') do |data| move.actions.each_with_index do |action, index| # Converting every action type here instead of requiring the Action # class interface to supply a method which returns the action hash # because XML-generation should be decoupled from internal data # structures. attribute = case action.type when :acceleration { acc: action.acceleration } when :push { direction: action.direction.key } when :turn { direction: action.turn_steps } when :advance { distance: action.distance } when default raise "unknown action type: #{action.type.inspect}. "\ "Can't convert to XML!" end attribute[:order] = index data.tag!(action.type, attribute) end end move.hints.each do |hint| data.hint(content: hint.content) end builder.target! end |
#parsePlayer(attributes) ⇒ Player
Converts XML attributes for a Player to a new Player object
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/software_challenge_client/protocol.rb', line 144 def parsePlayer(attributes) player = Player.new( PlayerColor.find_by_key(attributes['color'].to_sym), attributes['displayName'] ) player.points = attributes['points'].to_i player.direction = Direction.find_by_key(attributes['direction'].to_sym) player.x = attributes['x'].to_i player.y = attributes['y'].to_i player.passengers = attributes['passenger'].to_i player.coal = attributes['coal'].to_i player.velocity = attributes['speed'].to_i player.movement = player.velocity player end |
#process_string(text) ⇒ Object
starts xml-string parsing
41 42 43 44 |
# File 'lib/software_challenge_client/protocol.rb', line 41 def process_string(text) logger.debug "Parse XML:\n#{text}\n----END XML" REXML::Document.parse_stream(text, self) end |
#sendString(string) ⇒ Object
send a string
170 171 172 |
# File 'lib/software_challenge_client/protocol.rb', line 170 def sendString(string) @network.sendString("<room roomId=\"#{@roomId}\">#{string}</room>") end |
#sendXml(document) ⇒ Object
send a xml document
163 164 165 |
# File 'lib/software_challenge_client/protocol.rb', line 163 def sendXml(document) @network.sendXML(document) end |
#tag_end(name) ⇒ Object
called if an end-tag is read
49 50 51 52 53 54 55 56 57 |
# File 'lib/software_challenge_client/protocol.rb', line 49 def tag_end(name) case name when 'board' logger.debug @gamestate.board.to_s when 'result' logger.info 'Got game result' @network.disconnect end end |
#tag_start(name, attrs) ⇒ Object
called if a start tag is read Depending on the tag the gamestate is updated or the client will be asked for a move
65 66 67 68 69 70 71 72 73 74 75 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 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/software_challenge_client/protocol.rb', line 65 def tag_start(name, attrs) case name when 'room' @roomId = attrs['roomId'] logger.info 'roomId : ' + @roomId when 'data' logger.debug "data(class) : #{attrs['class']}" @context[:data_class] = attrs['class'] if attrs['class'] == 'sc.framework.plugins.protocol.MoveRequest' @client.gamestate = gamestate move = @client.move_requested sendString(move_to_xml(move)) end if attrs['class'] == 'error' logger.info "Game ended - ERROR: #{attrs['message']}" @network.disconnect end when 'state' logger.debug 'new gamestate' @gamestate = GameState.new @gamestate.turn = attrs['turn'].to_i @gamestate.start_player_color = attrs['startPlayer'] == 'RED' ? PlayerColor::RED : PlayerColor::BLUE @gamestate.current_player_color = attrs['currentPlayer'] == 'RED' ? PlayerColor::RED : PlayerColor::BLUE @gamestate.additional_free_turn_after_push = attrs['freeTurn'] == 'true' logger.debug "Turn: #{@gamestate.turn}" when 'red' logger.debug 'new red player' player = parsePlayer(attrs) if player.color != PlayerColor::RED throw new IllegalArgumentException("expected #{PlayerColor::RED} Player but got #{player.color}") end @gamestate.add_player(player) when 'blue' logger.debug 'new blue player' player = parsePlayer(attrs) if player.color != PlayerColor::BLUE throw new IllegalArgumentException("expected #{PlayerColor::BLUE} Player but got #{player.color}") end @gamestate.add_player(player) when 'board' logger.debug 'new board' @gamestate.board = Board.new @context[:current_tile_index] = nil @context[:current_tile_direction] = nil when 'tile' @context[:current_tile_index] = attrs['index'].to_i @context[:current_tile_direction] = attrs['direction'].to_i when 'field' type = FieldType.find_by_key(attrs['type'].to_sym) raise "unexpected field type: #{attrs['type']}. Known types are #{FieldType.map { |t| t.key.to_s }}" if type.nil? x = attrs['x'].to_i y = attrs['y'].to_i points = attrs['points'].to_i index = @context[:current_tile_index] direction = @context[:current_tile_direction] @gamestate.board.fields[[x, y]] = Field.new(type, x, y, index, direction, points) when 'lastMove' @gamestate.lastMove = Move.new when 'acceleration' @gamestate.lastMove.add_action_with_order(Acceleration.new(attrs['acc'].to_i), attrs['order'].to_i) when 'advance' @gamestate.lastMove.add_action_with_order(Advance.new(attrs['distance'].to_i), attrs['order'].to_i) when 'turn' @gamestate.lastMove.add_action_with_order(Turn.new(attrs['direction'].to_i), attrs['order'].to_i) when 'push' @gamestate.lastMove.add_action_with_order(Push.new(Direction.find_by_key(attrs['direction'].to_sym)), attrs['order'].to_i) when 'winner' @gamestate.condition = Condition.new(parsePlayer(attrs)) when 'left' logger.debug 'got left event, terminating' @network.disconnect end end |