Project

funnel

0.0
No commit activity in last 3 years
No release in over 3 years
A realtime resource-centric application framework
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 0.12.4
 Project Readme

#funnel - a realtime resource-centric application framework

##Installation

gem install funnel -s http://gemcutter.org

##Creating a project

funnel example
cd example
ruby script/server

##Project Hierarchy

/config
	boot.rb
	routes.rb (define your handler routes)
	settings.yml (host, port, accepted sources, etc)
/handlers -> your real time resource handlers
	game_handler.rb
	chat_handler.rb
/script
	server
/htdocs
	test.html -> a simple page to test that your server is running

your first "handler"

echo_handler.rb

class EchoHandler < Funnel::WebSocket::Connection

  #called when the connection is ready to send
  #and receive data
  def on_ready
  end

  #called on disconnect
  def on_disconnect
  end

  #right back at you
  def on_data msg
    send_message msg
  end

end

set up the route in config/routes.rb

map.connect "/echo" => EchoHandler

##Dependencies

##Coming soon

  • Plugins for various real time things (amqp, xmpp, twitter, etc)
  • Client side libraries to enable cross browser development
  • Client side plugins