back_pressure 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cdc962be27f2aaa28ea3d057516d1e1073f053e71bbe231ecffd9b952a1c6f1e
+  data.tar.gz: f0aba0b93e5457bbab21db5f604d9da0f73e1e9fed20dccfff83a0f00ca0ec30
+SHA512:
+  metadata.gz: b2a940dde8f7f26ef05eebe9a0d91f0b9022b43ce0926b630643645a878ca2614f60e30e5ca475868b825f2ce9502d0b56b40ab6b72caf58ea788d4bf2343675
+  data.tar.gz: 7a5fd47d2f819cbcd972f69ed52679f23d2b4c3c413e12d4d9280d181eb60dfc85623e45aa34d3284c118458155a93a6ba2d80b202f5d1fcc54674c21390ae91

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/Gemfile.lock
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+
+matrix:
+  include:
+    - jdk: openjdk8
+      rvm: jruby-9.1.17.0
+    - jdk: openjdk11
+      rvm: jruby-9.2.7.0
+    - rvm: 2.6
+before_install: gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+ - Added `Executor` interface
+ - Implemented `GatedExecutor`

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at conduct@yaauie.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in back_pressure.gemspec
+gemspec

data/LICENSE-APACHE2.md

@@ -0,0 +1,194 @@
+Apache License
+==============
+
+_Version 2.0, January 2004_  
+_&lt;<http://www.apache.org/licenses/>&gt;_
+
+### Terms and Conditions for use, reproduction, and distribution
+
+#### 1. Definitions
+
+“License” shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+“Licensor” shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+“Legal Entity” shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, “control” means **(i)** the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
+outstanding shares, or **(iii)** beneficial ownership of such entity.
+
+“You” (or “Your”) shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+“Source” form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+“Object” form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+“Work” shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+“Derivative Works” shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+“Contribution” shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+“submitted” means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as “Not a Contribution.”
+
+“Contributor” shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+#### 2. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+#### 3. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+#### 4. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+* **(a)** You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+* **(b)** You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+* **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+#### 5. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+#### 6. Trademarks
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+#### 7. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+#### 8. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+#### 9. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+_END OF TERMS AND CONDITIONS_
+
+### APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets `[]` replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same “printed page” as the copyright notice for easier identification within
+third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

data/README.md

@@ -0,0 +1,101 @@
+# BackPressure
+
+The `back_pressure` gem provides a small set of tools for providing back-pressure in Ruby.
+
+This project is designed to be zero-dependency and API-stable at `1.x`, making it a safe dependency that will not lead to transitive-dependency conflicts.
+
+It is licensed under the [Apache License, Version 2.0](./LICENSE-APACHE2.md), which grants you the freedom to use and modify it and limits the liability of the contributors.
+
+## Status
+ - [![Build Status](https://travis-ci.org/yaauie/ruby_back_pressure.svg?branch=master)](https://travis-ci.org/yaauie/ruby_back_pressure)
+ - [![Apache License](https://img.shields.io/badge/license-Apache%202-green.svg)](https://www.rubydoc.info/github/yaauie/ruby_back_pressure/master)
+ - ![API: Stable](https://img.shields.io/badge/API-stable-green.svg)
+ - ![Runtime Dependencies: Zero](https://img.shields.io/badge/runtime%20dependencies-0-green.svg)
+
+
+## Installation
+
+### Using Bundler
+
+Either this line to your application's Gemfile:
+
+~~~ruby
+gem 'back_pressure', '~> 1.0'
+~~~
+
+Or to your library project's `gemspec`:
+
+~~~ruby
+  spec.add_runtime_dependency 'back_pressure', '~> 1.0`
+~~~
+
+And then execute:
+
+    $ bundle
+
+### Manual Installation
+
+This gem can be installed manually with the `gem install` command:
+
+    $ gem install back_pressure
+
+## Usage
+
+### `BackPressure::Executor`
+
+Implementations of `BackPressure::Executor` provide a way to execute a block of code once it is safe to do so.
+
+#### Example: `BackPressure::GatedExecutor`
+
+Suppose we have a non-blocking API client that will fire hooks when its underlying connection is blocked (e.g., on a two-way stream when the receiver indicates that it is temporarily unable or unwilling to read from the stream).
+Continuing to push data to a non-blocking API in this state is dangerous, because if the connection is lost we are liable to lose data.
+We can use a `GatedExecutor` to ensure that we propagate the blockage to the code that is attempting to push to the non-blocking API client:
+
+~~~ruby
+gated_executor = BackPressure::GatedExecutor.new
+
+non_blocking_api_client.on_connection_blocked   { gated_executor.engage_back_pressure }
+non_blocking_api_client.on_connection_unblocked { gated_executor.remove_back_pressure }
+
+16.times do
+  Thread.new do
+    loop do
+      message = queue.pop
+      gated_executor.execute { non_blocking_api_client.push(message) }
+    end
+  end
+end
+~~~
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yaauie/ruby_back_pressure.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+### Project Priorities
+
+Contributions to this project will be assessed by the following priorities, _in order_.
+
+0. **Zero Breaking Changes**: This project is designed to be API-stable, enabling users to add it as a dependency of their own projects without risk of introducing transitive-dependency conflicts. If a change is desired that cannot be implemented within the existing promises made, it _MUST_ be implemented distinctly and separately.
+1. **Zero Runtime Dependencies**: In order to eliminate transitive-dependency conflicts, contributions _MUST NOT_ introduce runtime dependencies.
+2. **Zero Mutation**: Tools in this project _MUST NOT_ mutate any objects that they do not explicitly own.
+3. **Clarity and Validation of Promises Made**: In order to ensure future development doesn't accidentally break real-world usage, contributions _MUST_ clearly and explicitly document and verify the promises they make.
+4. **Ease of Use**: In order to ensure that users can safely consume the tools provided by this gem, usage patterns _SHOULD_ be clear and concise.
+5. **Composable Components over Complete Solutions**: In order to provide API-stability, tools _SHOULD_ be implemented in their simplest possible form.
+
+### Versioning
+
+This project follows the [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard, and is API-stable at `1.x`:
+ - MAJOR: will always be 1.x, since this project is API-stable by design.
+ - MINOR: new backward-compatible features and abstractions will be available in minor releases.
+ - PATCH: fixes to existing features will be made available in patch-level releases.
+
+## Code of Conduct
+
+Everyone interacting in the BackPressure project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/back_pressure/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/back_pressure.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "back_pressure/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "back_pressure"
+  spec.version       = BackPressure::VERSION
+  spec.authors       = ["Ry Biesemeyer"]
+  spec.email         = ["identity@yaauie.com"]
+  spec.license       = 'Apache-2.0'
+
+  spec.summary       = %q{Tools for providing blocking back-pressure}
+  spec.description   = %q{BackPressure is a zero-dependency collection of stable-API tools } +
+                       %q{for safely and efficiently providing blocking back-pressure.}
+  spec.homepage      = "https://github.com/yaauie/ruby_back_pressure"
+
+  spec.metadata      = {
+      "source_code_uri" => "https://github.com/yaauie/ruby_back_pressure",
+      "bug_tracker_uri" => "https://github.com/yaauie/ruby_back_pressure/issues",
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version =  '>= 2.0'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.0"
+  spec.add_development_dependency "yard",    "~> 0.9.20"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "back_pressure"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/back_pressure.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+# Copyright 2019 Ry Biesemeyer <identity@yaauie.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative "back_pressure/version"
+require_relative "back_pressure/gated_executor"

data/lib/back_pressure/execution_expired.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+# Copyright 2019 Ry Biesemeyer <identity@yaauie.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module BackPressure
+  ##
+  # @since 1.0.0
+  ExecutionExpired = Class.new(RuntimeError)
+end

data/lib/back_pressure/executor.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+# Copyright 2019 Ry Biesemeyer <identity@yaauie.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative "execution_expired"
+
+module BackPressure
+  ##
+  # Implementations of `BackPressure::Executor` are capable of providing
+  # blocking back-pressure to callers using their `execute` or `execute!`
+  # methods.
+  #
+  # This interface makes no guarantees about how implementations go about
+  # controlling back-pressure or the order in which execution will occur
+  # in the presence or absence of blocking back-pressure.
+  #
+  # @abstract
+  #
+  # @author Ry Biesemeyer <identity@yaauue.com>
+  # @since 1.0.0
+  class Executor
+    ##
+    # Executes the provided block, _after_ waiting out any back-pressure,
+    # returning `true` IFF the block was executed.
+    #
+    # @param blocking_time_limit [Number]: the maximum time to wait, in
+    #                                      seconds, when back-pressure is
+    #                                      being applied, before aborting
+    #                                      (optional).
+    # @return [Boolean]: returns `true` if block was successfully executed,
+    #                    and `false` if tht `blocking_time_limit` was
+    #                    reached before it could be executed.
+    #
+    # @yieldreturn [void]: the value returned by the block is ignored by
+    #                      this method.
+    def execute(blocking_time_limit: nil)
+      fail NotImplementedError
+    end
+
+    ##
+    # Executes the provided block, _after_ waiting out any back-pressure,
+    # returning the result of the block or raising an `ExecutionExpired`
+    # exception if the provided limit was reached before execution could
+    # begin.
+    #
+    # @param blocking_time_limit [Number]: the maximum time to wait, in
+    #                                      seconds, when back-pressure is
+    #                                      being applied, before aborting
+    #                                      (optional).
+    # @return [Object]: returns the unmodified value of the result of
+    #                   executing the provided block.
+    # @raise [ExecutionExpired]
+    # @yieldreturn [Object]: the value returned from the block is returned
+    #                        by this method
+    def execute!(blocking_time_limit: nil)
+      fail NotImplementedError
+    end
+
+    ##
+    # Helper method for observing which threads, if any, are blocked at
+    # the instant the method is invoked. The returned value is a frozen
+    # snapshot, and the included threads are not guaranteed to be still
+    # blocking by the time they are accessed.
+    #
+    # @api observation
+    # @note This method should be used only for observation-based tooling.
+    #
+    # @return [Set{Thread}]
+    def blocked_threads
+      fail NotImplementedError
+    end
+
+    ##
+    # Helper method for determining if any threads are currently blocked
+    # by back-pressure.
+    #
+    # @api observation
+    # @note This method should be used only for observation-based tooling.
+    #
+    # @return [Boolean]
+    def blocked?
+      fail NotImplementedError
+    end
+  end
+end

data/lib/back_pressure/gated_executor.rb

@@ -0,0 +1,213 @@
+# encoding: utf-8
+
+# Copyright 2019 Ry Biesemeyer <identity@yaauie.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative 'executor'
+
+module BackPressure
+  ##
+  # A {GatedExecutor} is an implementation of {BackPressure::Executor} that
+  # allows external control of back-pressure state, and is useful when
+  # non-blocking APIs provide hooks for identifying when they _should_ block.
+  #
+  # @author Ry Biesemeyer <identity@yaauie.com>
+  # @since 1.0.0
+  #
+  # @example Using a GatedExecutor with a non-blocking API
+  #   gated_executor = BackPressure::GatedExecutor.new
+  #
+  #   non_blocking_api_client.on_connection_blocked   { gated_executor.engage_back_pressure }
+  #   non_blocking_api_client.on_connection_unblocked { gated_executor.remove_back_pressure }
+  #
+  #   16.times do
+  #     Thread.new do
+  #       loop do
+  #         message = queue.pop
+  #         gated_executor.execute { non_blocking_api_client.push(message) }
+  #       end
+  #     end
+  #   end
+  class GatedExecutor < Executor
+
+    DEFAULT_REASON = "reason not given".freeze
+    private_constant :DEFAULT_REASON
+
+    ##
+    # @param logger [Logger]: logger on which to emit (optional)
+    # @param description [String]: description for logs (optional)
+    # @param log_threshold [Number]: silences blockage warnings for durations
+    #                                less than the provided value
+    #                                (default `0`).
+    #
+    # @yield [gated_executor] if a block is provided, the newly-created
+    #                         instance is yielded to the given block after
+    #                         being initialised.
+    # @yieldparam [self]
+    # @yieldreturn [void]
+    def initialize(logger:        nil,
+                   description:   nil,
+                   log_threshold: 1)
+
+      @logger = logger
+      @desc = (description ? description.dup : "#{self.class.name}<#{__id__}>").freeze
+      @log_threshold = log_threshold
+
+      @control_mutex = Mutex.new
+      @control_condv = ConditionVariable.new
+
+      @blocked_threads = Set.new
+      @blocked_threads_mutex = Mutex.new
+
+      yield(self) if block_given?
+    end
+
+    ##
+    # Engages back-pressure and immediately returns; threads that send this
+    # instance `GatedExecutor#execute` will be blocked until back-pressure is
+    # removed.
+    #
+    # @param reason [String]: the reason back-pressure is being applied, to be
+    #                         included in the log message (optional).
+    # @return [void]
+    def engage_back_pressure(reason=DEFAULT_REASON)
+      @control_mutex.synchronize do
+        if !@back_pressure_engaged
+          @back_pressure_engaged = true
+          @logger && @logger.info("#{@desc} back-pressure engaged (#{reason})")
+        else
+          @logger && @logger.debug("#{@desc} attempted to engage back-pressure when it is already engaged (#{reason})")
+        end
+      end
+    end
+
+    ##
+    # Removes back-pressure, waking any threads that are currently blocked
+    # by back-pressure, and immediately returns.
+    #
+    # @note No guarantee of ordering are made with regard to threads that
+    #       are blocked at the instant back-pressure is removed.
+    #
+    # @return [void]
+    def remove_back_pressure(reason=DEFAULT_REASON)
+      @control_mutex.synchronize do
+        if @back_pressure_engaged
+          @back_pressure_engaged = false
+          @logger && @logger.info("#{@desc} back-pressure removed (#{reason})")
+          @control_condv.broadcast # wakeup _all_ waiting threads
+        else
+          @logger && @logger.debug("#{@desc} attempted to remove back-pressure when it not engaged (#{reason})")
+        end
+      end
+    end
+
+    ##
+    # Helper method for determining if back-pressure is currently engaged.
+    #
+    # @return [Boolean]
+    def back_pressure_engaged?
+      @control_mutex.synchronize { @back_pressure_engaged }
+    end
+
+    ##
+    # (see Executor#execute)
+    #
+    # @note Care must be taken to ensure that back-pressure control is executed
+    #       outside of this block, as the block provided is not executed while
+    #       back-pressure is engaged.
+    def execute(blocking_time_limit=nil)
+      fail(ArgumentError, 'block required!') unless block_given?
+
+      if !@back_pressure_engaged || block_until_back_pressure_removed(blocking_time_limit)
+        yield
+        return true
+      else
+        return false
+      end
+    end
+
+    ##
+    # (see Executor#execute!)
+    #
+    # @note Care must be taken to ensure that back-pressure control is executed
+    #       outside of this block, as the block provided is not executed while
+    #       back-pressure is engaged.
+    def execute!(blocking_time_limit=nil)
+      execute(blocking_time_limit) do
+        return yield
+      end
+
+      fail(ExecutionExpired)
+    end
+
+    ##
+    # (see Executor#blocked_threads)
+    def blocked_threads
+      @blocked_threads_mutex.synchronize { @blocked_threads.dup.freeze }
+    end
+
+    ##
+    # (see Executor#blocked?)
+    def blocked?
+      blocked_threads.any?
+    end
+
+    private
+
+    ##
+    # Blocks while back-pressure is engaged, immediately unblocking all threads
+    # as soon as the back-pressure is removed.
+    #
+    # @api private
+    #
+    # @param blocking_time_limit [Number]: the maximum time to wait, in seconds,
+    #                             when back-pressure is being applied,
+    #                             before aborting (optional).
+    #
+    # @return [Boolean] returns `true` as soon as back-pressure is released,
+    #                   or `false` if a provided `blocking_time_limit` was
+    #                   reached before back-ressure could be released.
+    def block_until_back_pressure_removed(blocking_time_limit=nil)
+      @blocked_threads_mutex.synchronize { @blocked_threads.add(Thread.current) }
+
+      timeout = [0.5, blocking_time_limit].compact.min
+      start = Time.now
+      thread_id = Thread.current.to_s
+
+      loop do
+        should_block = @control_mutex.synchronize do
+          @control_condv.wait(@control_mutex, timeout)
+          @back_pressure_engaged
+        end
+        break unless should_block
+
+        block_duration = Time.now - start
+        if @logger && block_duration > @log_threshold
+          @logger.warn("#{@desc} has been blocked for #{block_duration.round(2)}s... (#{thread_id})")
+        end
+
+        if blocking_time_limit && block_duration > blocking_time_limit
+          @logger && @logger.warn("#{@desc} blocking back-pressure exceeded limit of #{blocking_time_limit}s (#{thread_id})")
+          return false
+        end
+
+        timeout = [30, (timeout * 2), blocking_time_limit && (blocking_time_limit-block_duration)].compact.min
+      end
+
+      return true
+    ensure
+      @blocked_threads_mutex.synchronize { @blocked_threads.delete(Thread.current) }
+    end
+  end
+end

data/lib/back_pressure/version.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+# Copyright 2019 Ry Biesemeyer <identity@yaauie.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module BackPressure
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: back_pressure
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ry Biesemeyer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+description: BackPressure is a zero-dependency collection of stable-API tools for
+  safely and efficiently providing blocking back-pressure.
+email:
+- identity@yaauie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE-APACHE2.md
+- README.md
+- Rakefile
+- back_pressure.gemspec
+- bin/console
+- bin/setup
+- lib/back_pressure.rb
+- lib/back_pressure/execution_expired.rb
+- lib/back_pressure/executor.rb
+- lib/back_pressure/gated_executor.rb
+- lib/back_pressure/version.rb
+homepage: https://github.com/yaauie/ruby_back_pressure
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/yaauie/ruby_back_pressure
+  bug_tracker_uri: https://github.com/yaauie/ruby_back_pressure/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Tools for providing blocking back-pressure
+test_files: []