Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.document
.gitignore
Gemfile
Gemfile.lock
LICENSE.txt
README.rdoc
Rakefile
VERSION
faye-server.gemspec

README.rdoc

faye-server

Extend FayServer in your class and you will get the following accessors for the class:

- messaging_server_options - passes in options to the faye server, can include faye extensions here
- messaging_server_port - sets the port your faye server will listen on

With these you can customize your server, including the mount point, timeout, and any extension you want to add.

This is just a basic wrapper for the Faye::RackAdatper. It does, however, spawn the Faye server into another thread where it can be monitored and controlled but not lock up your main thread, be it in Rails or any project.

There are also two more accessors for your class not mentioned above:

- messaging_server_thread - Simply the thread running the faye server
- messaging_server - the faye server itself

In your class you can call :start, :stop, :publish. Start/Stop are pretty straight forward, they start and stop the faye server.

Publish publishes a message to your channel and takes an options hash, requiring a :channel and a :message

Contributing to faye-server

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.

  • Fork the project.

  • Start a feature/bugfix branch.

  • Commit and push until you are happy with your contribution.

  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.

  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright © 2012 Brian Goff. See LICENSE.txt for further details.

Something went wrong with that request. Please try again.