Strelka: A Ruby Web Framework

WebSocket (RFC 6455) Server base class.

class ChatServer < Strelka::WebSocketServer

    # Set up a Hash for participating users
    def initialize( * )
        super
        @users = {}
    end

    # Disconnect clients that don't answer a ping
    plugin :heartbeat
    heartbeat_rate 5.0
    idle_timeout 15.0

    # When a websocket is set up, add a new user to the table, but without a nick.
    on_handshake do |frame|
        @users[ frame.socket_id ] = nil
        return frame.response # accept the connection
    end

    # Handle incoming commands, which should be text frames
    on_text do |frame|
        senderid = frame.socket_id
        data = frame.payload.read

        # If the input starts with '/', it's a command (e.g., /quit, /nick, etc.)
        output = nil
        if data.start_with?( '/' )
            output = self.command( senderid, data[1..-1] )
        else
            output = self.say( senderid, data )
        end

        response = frame.response
        response.puts( output )
        return response
    end

end # class ChatServer

Public Instance Methods

anchor

handle_disconnect( request )

Handle a disconnect notice from Mongrel2 via the given request. Its return value is ignored.

# File lib/strelka/websocketserver.rb, line 88
def handle_disconnect( request )
        self.log.info "Unhandled disconnect notice."
        return nil
end

anchor

handle_websocket( frame )

Handle a WebSocket frame in request. If not overridden, WebSocket connections are closed with a policy error status.

# File lib/strelka/websocketserver.rb, line 66
def handle_websocket( frame )
        response = nil

        # Dispatch the frame
        response = catch( :close_websocket ) do
                self.log.debug "Incoming WEBSOCKET frame (%p):%s" % [ frame, frame.headers.path ]
                self.handle_frame( frame )
        end

        return response
end

anchor

handle_websocket_handshake( handshake )

Handle a WebSocket handshake HTTP request.

# File lib/strelka/websocketserver.rb, line 80
def handle_websocket_handshake( handshake )
        self.log.warn "Incoming WEBSOCKET_HANDSHAKE request (%p)" % [ request.headers.path ]
        return handshake.response( handshake.protocols.first )
end

Protected Instance Methods

anchor

close_with( frame, reason )

Throw a :close_websocket frame that will close the current connection.

# File lib/strelka/websocketserver.rb, line 109
def close_with( frame, reason )
        self.log.debug "Closing the connection: %p" % [ reason ]

        # Make a CLOSE frame
        frame = frame.response( :close )
        frame.set_status( reason )

        throw :close_websocket, frame
end

anchor

handle_content_frame( frame )

Handle an incoming content frame.

# File lib/strelka/websocketserver.rb, line 139
def handle_content_frame( frame )
        self.log.warn "Unhandled frame type %p" % [ frame.opcode ]
        self.close_with( frame, CLOSE_BAD_DATA_TYPE )
end

anchor

handle_control_frame( frame )

Handle an incoming control frame.

# File lib/strelka/websocketserver.rb, line 121
def handle_control_frame( frame )
        self.log.debug "Handling control frame: %p" % [ frame ]

        case frame.opcode
        when :ping
                return frame.response
        when :pong
                return nil
        when :close
                self.conn.reply_close( frame )
                return nil
        else
                self.close_with( frame, CLOSE_BAD_DATA_TYPE )
        end
end

anchor

handle_frame( frame )

Default frame handler.

# File lib/strelka/websocketserver.rb, line 99
def handle_frame( frame )
        if frame.control?
                self.handle_control_frame( frame )
        else
                self.handle_content_frame( frame )
        end
end