process_shared 0.2.1b → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83d9a90ae2f4158f41b0e0ffc996d978fac0acfc
-  data.tar.gz: f9ff3cc8f623e99723efcd4150d30f42ea5d8042
+  metadata.gz: a23ff1b1fbc2944e69e66f89d2db7dc0210cfd95
+  data.tar.gz: d361bd34750fc4ee8f099fbc7d7be73fb753002d
 SHA512:
-  metadata.gz: 9b83fe2042d36fd665e0c6558df40037ecd371c6805a920da5eb486b265916a702580c0bd7b411769c617577556f5e5bec0b1b1ca50cc1fa58fea91ee0d1a0b8
-  data.tar.gz: ffe25c4ca0f8615e81ddf495d00e53e976d6dcd17fb393e14597944c767a7b75a62363817afc755153add83fb35a0390d243c5e4c72e7e8624cba8177308e001
+  metadata.gz: f4fd2807a7fa4bf0863ba329a45cc3e05fb3abb74ccd7492dfa53c214bf7493eeb75d3646143e63aee3f8fae484ab162d0ef7cdf4fbfc38f252824f7f878d597
+  data.tar.gz: 1079a54be971d445ef46eaa06fd228616668a49a79dfdac25ea56eab111a10b30e75b5dd628aeab1fc5d1401ef82bd0d5526870363cf741791605da5e7f5b3a8

data/README.md

@@ -14,26 +14,57 @@
 process_shared
 ==============
 
-Concurrency primitives that may be used in a cross-process way to
-coordinate share memory between processes.
+Cross-process concurrency primitives that may be used to coordinate
+shared memory between processes.
+
+```ruby
+require 'process_shared'
+
+mutex = ProcessShared::Mutex.new
+cond = ProcessShared::ConditionVariable.new
+
+mem = ProcessShared::SharedMemory.new(:int32, 2)  # extends FFI::Pointer
+
+pid1 = fork do
+  nums = mutex.synchronize do
+    cond.wait(mutex)
+    mem.get_array_of_int(0, 2)
+  end
+  puts "process #{Process.pid} received #{nums}"
+end
+
+pid2 = fork do
+  nums = [12345, 67890]
+  mutex.synchronize do
+    puts "process #{Process.pid} sending #{nums}"
+    mem.put_array_of_int(0, nums)
+    cond.signal
+  end
+end
+
+Process.waitall
+```
+
+[API Documentation](http://www.rubydoc.info/github/pmahoney/process_shared/master)
 
 FFI is used to access POSIX semaphore on Linux or Mach semaphores on
-Mac.  Atop these semaphores are implemented ProcessShared::Semaphore,
-ProcessShared::Mutex.  POSIX shared memory is used to implement
-ProcessShared::SharedMemory.
+Mac. Atop these semaphores are implemented `ProcessShared::Semaphore`,
+`ProcessShared::Mutex`. POSIX shared memory is used to implement
+`ProcessShared::SharedMemory`.
 
 On Linux, POSIX semaphores support `sem_timedwait()` which can wait on
 a semaphore but stop waiting after a timeout.
 
 Mac OS X's implementation of POSIX semaphores does not support
-timeouts.  But, the Mach layer in Mac OS X has its own semaphores that
-do support timeouts.  Thus, process_shared implements a moderate
-subset of the Mach API, which is quite a bit different from POSIX.
-Namely, semaphores created in one process are not available in child
-processes created via `fork()`.  Mach does provide the means to copy
-capabilities between tasks (Mach equivalent to processes).
-process_shared overrides Ruby's `fork` methods so that semaphores are
-copied from parent to child to emulate the POSIX behavior.
+timeouts. But, the Mach layer in Mac OS X has its own semaphores that
+do support timeouts. Thus, process_shared implements a moderate subset
+of the Mach API, which is quite a bit different from POSIX. Namely,
+semaphores created in one process are not available in child processes
+created via `fork()`. Mach does provide the means to copy capabilities
+between tasks (Mach equivalent to processes). In a giant hack, **on OS
+X, `process_shared` overrides Ruby's `fork`** methods so that
+semaphores are copied from parent to child to emulate the POSIX
+behavior.
 
 This is an incomplete work in progress.
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_shared
 version: !ruby/object:Gem::Version
-  version: 0.2.1b
+  version: 0.2.1
 platform: ruby
 authors:
 - Patrick Mahoney
@@ -28,16 +28,16 @@ dependencies:
   name: ci_reporter_minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: flog
   requirement: !ruby/object:Gem::Requirement
@@ -213,9 +213,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.0
@@ -223,4 +223,3 @@ signing_key:
 specification_version: 4
 summary: process-shared synchronization primitives
 test_files: []
-has_rdoc: true