kotovalexarian-likes-github/mperham--sidekiq
1
0
Fork 0
mirror of https://github.com/mperham/sidekiq.git synced 2022-11-09 13:52:34 -05:00
Code Releases Activity

Docs, license

Browse source
This commit is contained in:
Mike Perham 2012-01-23 20:56:06 -08:00
parent 89144133fb
commit f696307b1d
3 changed files with 33 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

20
LICENSE
View file

@ -0,0 +1,20 @@
Copyright (c) Mike Perham
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

17
README.md
View file

@ -6,8 +6,7 @@ Simple, efficient message processing for Ruby.
Sidekiq aims to be a drop-in replacement for Resque. It uses the exact same
message format as Resque so it can slowly replace an existing Resque processing farm.
You can have Sidekiq and Resque run side-by-side at the same time and
use the Resque client to enqueue messages in Redis to be
processed by Sidekiq.
use the Resque client to enqueue messages in Redis to be processed by Sidekiq.
Sidekiq is different from Resque in how it processes messages: it
processes many messages concurrently per process. Resque only processes
@ -44,13 +43,13 @@ Client
The Sidekiq client can be used to enqueue messages for processing:
Sidekiq::Client.push('some_queue', :class => SomeWorker, :args => ['bob', 2, foo: 'bar'])
Sidekiq::Client.push('some_queue', 'class' => SomeWorker, 'args' => ['bob', 2, foo: 'bar'])
How it works
-----------------
Sidekiq assumes you are running a Rails 3 application with workers in app/workers. Each message has a format like:
Sidekiq assumes you are running a Rails 3 application. Each message has a format like:
{ class: 'SomeWorker', args: ['bob', 2, {foo: 'bar'}] }
@ -63,7 +62,9 @@ with args splatted:
end
This is the main API difference between Resque and Sidekiq: the perform
method is an *instance* method, not a *class* method.
method is an *instance* method, not a *class* method. This difference
is here because you, as a developer, must make your workers threadsafe.
I don't want to call a Resque worker which might be non-threadsafe.
Connections
@ -104,3 +105,9 @@ Author
-----------------
Mike Perham, [@mperham](https://twitter.com/mperham), [http://mikeperham.com](http://mikeperham.com)
If your company uses and enjoys sidekiq, click below to support my
open source efforts. I spend hundreds of hours of my spare time working
on projects like this.
<a href='http://www.pledgie.com/campaigns/16623'><img alt='Click here to lend your support to Open Source and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/16623.png?skin_name=chrome' border='0' /></a>

1
TODO.md
View file

@ -1,2 +1,3 @@
- monitoring hooks
- resque-ui web ui?
- graceful shutdown