8000 GitHub - jamonholmgren/concurrent-ruby: Modern concurrency tools including agents, futures, promises, thread pools, supervisors, and more. Inspired by Erlang, Clojure, Scala, Go, Java, JavaScript, and classic concurrency patterns.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Modern concurrency tools including agents, futures, promises, thread pools, supervisors, and more. Inspired by Erlang, Clojure, Scala, Go, Java, JavaScript, and classic concurrency patterns.

License

Notifications You must be signed in to change notification settings

jamonholmgren/concurrent-ruby

 
 

Repository files navigation

Concurrent Ruby

Gem Version Build Status Coverage Status Code Climate Inline docs Dependency Status License Gitter chat

Modern concurrency tools for Ruby. Inspired by Erlang, Clojure, Scala, Haskell, F#, C#, Java, and classic concurrency patterns.

The design goals of this gem are:

  • Be an 'unopinionated' toolbox that provides useful utilities without debating which is better or why
  • Remain free of external gem dependencies
  • Stay true to the spirit of the languages providing inspiration
  • But implement in a way that makes sense for Ruby
  • Keep the semantics as idiomatic Ruby as possible
  • Support features that make sense in Ruby
  • Exclude features that don't make sense in Ruby
  • Be small, lean, and loosely coupled

Features & Documentation

Please see the Concurrent Ruby Wiki or the API documentation for more information or join our mailing list.

There are many concurrency abstractions in this library. These abstractions can be broadly categorized into several general groups:

Semantic Versioning

This gem adheres to the rules of semantic versioning.

Supported Ruby versions

MRI 1.9.3, 2.0, 2.1, JRuby (1.9 mode), and Rubinius 2.x. This library is pure Ruby and has no gem dependencies. It should be fully compatible with any interpreter that is compliant with Ruby 1.9.3 or newer.

Examples

Many more code examples can be found in the docum 8000 entation for each class (linked above).

Future and ScheduledTask:

require 'concurrent'
require 'thread'   # for Queue
require 'open-uri' # for open(uri)

class Ticker
  def get_year_end_closing(symbol, year)
    uri = "http://ichart.finance.yahoo.com/table.csv?s=#{symbol}&a=11&b=01&c=#{year}&d=11&e=31&f=#{year}&g=m"
    data = open(uri) {|f| f.collect{|line| line.strip } }
    data[1].split(',')[4].to_f
  end
end

# Future
price = Concurrent::Future.execute{ Ticker.new.get_year_end_closing('TWTR', 2013) }
price.state #=> :pending
sleep(1)    # do other stuff
price.value #=> 63.65
price.state #=> :fulfilled

# ScheduledTask
task = Concurrent::ScheduledTask.execute(2){ Ticker.new.get_year_end_closing('INTC', 2013) }
task.state #=> :pending
sleep(3)   # do other stuff
task.value #=> 25.96

Actor:

class Counter < Concurrent::Actor::Context
  # Include context of an actor which gives this class access to reference
  # and other information about the actor

  # use initialize as you wish
  def initialize(initial_value)
    @count = initial_value
  end

  # override on_message to define actor's behaviour
  def on_message(message)
    if Integer === message
      @count += message
    end
  end
end #

# Create new actor naming the instance 'first'.
# Return value is a reference to the actor, the actual actor is never returned.
counter = Counter.spawn(:first, 5)

# Tell a message and forget returning self.
counter.tell(1)
counter << 1
# (First counter now contains 7.)

# Send a messages asking for a result.
counter.ask(0).class
counter.ask(0).value

Installing and Building

This gem includes several platform-specific optimizations. To reduce the possibility of compilation errors, we provide pre-compiled gem packages for several platforms as well as a pure-Ruby build. Installing the gem should be no different than installing any other Rubygems-hosted gem. Rubygems will automatically detect your platform and install the appropriate pre-compiled build. You should never see Rubygems attempt to compile the gem on installation. Additionally, to ensure compatability with the largest possible number of Ruby interpreters, the C extensions will never load under any Ruby other than MRI, even when installed.

The following gem builds will be built at every release:

  • concurrent-ruby-x.y.z.gem (pure Ruby)
  • concurrent-ruby-x.y.z-java.gem (JRuby)
  • concurrent-ruby-x.y.z-x86-linux.gem (Linux 32-bit)
  • concurrent-ruby-x.y.z-x86_64-linux.gem (Linux 64-bit)
  • concurrent-ruby-x.y.z-x86-mingw32.gem (Windows 32-bit)
  • concurrent-ruby-x.y.z-x64-mingw32.gem (Windows 64-bit)
  • concurrent-ruby-x.y.z-x86_64-darwin-13.gem (OS X)
  • concurrent-ruby-x.y.z-x86-solaris-2.11.gem (Solaris)

Installing

gem install concurrent-ruby

or add the following line to Gemfile:

gem 'concurrent-ruby'

and run bundle install from your shell.

Building

Because we provide pre-compiled gem builds, users should never need to build the gem manually. The build process for this gem is completely automated using open source tools. All of the automation components are available in the ruby-concurrency/rake-compiler-dev-box GitHub repository.

This gem will compile native C code under MRI and native Java code under JRuby. It is also possible to build a pure-Ruby version. All builds have identical functionality. The only difference is performance. Additionally, pure-Ruby classes are always available, even when using the native optimizations. Please see the documentation for more details.

To build and package the gem using MRI or JRuby, install the necessary build dependencies and run:

bundle exec rake compile
bundle exec rake build

To build and package a pure-Ruby gem, on any platform and interpreter (including MRI and JRuby), run:

BUILD_PURE_RUBY='true' bundle exec rake build

Maintainers

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License and Copyright

Concurrent Ruby is free software released under the MIT License.

The Concurrent Ruby logo was designed by David Jones. It is Copyright © 2014 Jerry D'Antonio. All Rights Reserved.

About

Modern concurrency tools including agents, futures, promises, thread pools, supervisors, and more. Inspired by Erlang, Clojure, Scala, Go, Java, JavaScript, and classic concurrency patterns.

Resources

License

Stars

Watchers

Forks

Packages

No packages published
0