async-io 1.28.0 → 1.31.0

data/.editorconfig

@@ -1,6 +0,0 @@
-root = true
-
-[*]
-indent_style = tab
-indent_size = 2
-

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -1,26 +0,0 @@
-language: ruby
-dist: xenial
-cache: bundler
-
-script: bundle exec rspec
-
-matrix:
-  include:
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.7
-    - rvm: 2.6
-      env: COVERAGE=PartialSummary,Coveralls
-    - rvm: truffleruby
-    - rvm: jruby-head
-      env: JRUBY_OPTS="--debug -X+O"
-    - rvm: ruby-head
-    - rvm: 2.6
-      os: osx
-    - rvm: 2.6
-      os: osx
-      gemfile: gems/nio4r-2.3.gemfile
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: truffleruby
-    - rvm: jruby-head

data/.yardopts

@@ -1,2 +0,0 @@
---markup markdown
-

data/Gemfile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in async-io.gemspec
-gemspec
-
-group :test do
-	gem 'benchmark-ips'
-	gem 'ruby-prof', platforms: :mri
-	
-	gem 'http'
-end

data/README.md

@@ -1,171 +0,0 @@
-# Async::IO
-
-Async::IO provides builds on [async] and provides asynchronous wrappers for `IO`, `Socket`, and related classes.
-
-[async]: https://github.com/socketry/async
-
-[![Build Status](https://travis-ci.com/socketry/async-io.svg?branch=master)](https://travis-ci.com/socketry/async-io)
-[![Code Climate](https://codeclimate.com/github/socketry/async-io.svg)](https://codeclimate.com/github/socketry/async-io)
-[![Coverage Status](https://coveralls.io/repos/socketry/async-io/badge.svg)](https://coveralls.io/r/socketry/async-io)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'async-io'
-```
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install async-io
-
-## Usage
-
-Basic echo server (from `spec/async/io/echo_spec.rb`):
-
-```ruby
-require 'async/io'
-
-def echo_server(endpoint)
-	Async do |task|
-		# This is a synchronous block within the current task:
-		endpoint.accept do |client|
-			# This is an asynchronous block within the current reactor:
-			data = client.read
-			
-			# This produces out-of-order responses.
-			task.sleep(rand * 0.01)
-			
-			client.write(data.reverse)
-			client.close_write
-		end
-	end
-end
-
-def echo_client(endpoint, data)
-	Async do |task|
-		endpoint.connect do |peer|
-			peer.write(data)
-			peer.close_write
-			
-			message = peer.read
-			
-			puts "Sent #{data}, got response: #{message}"
-		end
-	end
-end
-
-Async do
-	endpoint = Async::IO::Endpoint.tcp('0.0.0.0', 9000)
-	
-	server = echo_server(endpoint)
-	
-	5.times.collect do |i|
-		echo_client(endpoint, "Hello World #{i}")
-	end.each(&:wait)
-	
-	server.stop
-end
-```
-
-### Timeouts
-
-Timeouts add a temporal limit to the execution of your code. If the IO doesn't respond in time, it will fail. Timeouts are high level concerns and you generally shouldn't use them except at the very highest level of your program.
-
-```ruby
-message = task.with_timeout(5) do
-	begin
-		peer.read
-	rescue Async::TimeoutError
-		nil # The timeout was triggered.
-	end
-end
-```
-
-Any `yield` operation can cause a timeout to trigger. Non-`async` functions might not timeout because they are outside the scope of `async`.
-
-#### Wrapper Timeouts
-
-Asynchronous operations may block forever. You can assign a per-wrapper operation timeout duration. All asynchronous operations will be bounded by this timeout.
-
-```ruby
-peer.timeout = 1
-peer.read # If this takes more than 1 second, Async::TimeoutError will be raised.
-```
-
-The benefit of this approach is that it applies to all operations. Typically, this would be configured by the user, and set to something pretty high, e.g. 120 seconds.
-
-### Reading Characters
-
-This example shows how to read one character at a time as the user presses it on the keyboard, and echos it back out as uppercase:
-
-```ruby
-require 'async'
-require 'async/io/stream'
-require 'io/console'
-
-$stdin.raw!
-$stdin.echo = false
-
-Async do |task|
-	stdin = Async::IO::Stream.new(
-		Async::IO::Generic.new($stdin)
-	)
-	
-	while character = stdin.read(1)
-		$stdout.write character.upcase
-	end
-end
-```
-
-### Deferred Buffering
-
-`Async::IO::Stream.new(..., deferred:true)` creates a deferred stream which increases latency slightly, but reduces the number of total packets sent. It does this by combining all calls `Stream#flush` within a single iteration of the reactor. This is typically more useful on the client side, but can also be useful on the server side when individual packets have high latency. It should be preferable to send one 100 byte packet than 10x 10 byte packets.
-
-Servers typically only deal with one request per iteartion of the reactor so it's less useful. Clients which make multiple requests can benefit significantly e.g. HTTP/2 clients can merge many requests into a single packet. Because HTTP/2 recommends disabling Nagle's algorithm, this is often beneficial.
-
-## 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
-
-## See Also
-
-- [async](https://github.com/socketry/async) — Asynchronous event-driven reactor.
-- [async-process](https://github.com/socketry/async-process) — Asynchronous process spawning/waiting.
-- [async-websocket](https://github.com/socketry/async-websocket) — Asynchronous client and server websockets.
-- [async-dns](https://github.com/socketry/async-dns) — Asynchronous DNS resolver and server.
-- [async-rspec](https://github.com/socketry/async-rspec) — Shared contexts for running async specs.
-- [rubydns](https://github.com/ioquatix/rubydns) — A easy to use Ruby DNS server.
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-
-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.

data/async-io.gemspec

@@ -1,30 +0,0 @@
-
-require_relative 'lib/async/io/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "async-io"
-	spec.version       = Async::IO::VERSION
-	spec.licenses      = ["MIT"]
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-
-	spec.summary       = "Provides support for asynchonous TCP, UDP, UNIX and SSL sockets."
-	spec.homepage      = "https://github.com/socketry/async-io"
-
-	spec.files         = `git ls-files`.split($/)
-	spec.executables   = spec.files.grep(%r{^bin/}).map{|f| File.basename(f)}
-	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-	spec.require_paths = ["lib"]
-
-	spec.add_dependency "async", "~> 1.14"
-	spec.add_development_dependency "async-rspec", "~> 1.10"
-
-	spec.required_ruby_version = '~> 2.5'
-	
-	spec.add_development_dependency "async-container", "~> 0.15"
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "bake-bundler"
-	spec.add_development_dependency "rspec", "~> 3.0"
-end

data/examples/allocations/byteslice.rb

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative 'memory'
-
-string = nil
-
-measure_memory("Initial allocation") do
-	string = "a" * 5*1024*1024
-	string.freeze
-end # => 5.0 MB
-
-measure_memory("Byteslice from start to middle") do
-	# Why does this need to allocate memory? Surely it can share the original allocation?
-	x = string.byteslice(0, string.bytesize / 2)
-end # => 2.5 MB
-
-measure_memory("Byteslice from middle to end") do
-	string.byteslice(string.bytesize / 2, string.bytesize)
-end # => 0.0 MB
-
-measure_memory("Slice! from start to middle") do
-	string.dup.slice!(0, string.bytesize / 2)
-end # => 7.5 MB
-
-measure_memory("Byte slice into two halves") do
-	head = string.byteslice(0, string.bytesize / 2) # 2.5 MB
-	remainder = string.byteslice(string.bytesize / 2, string.bytesize) # Shared
-end # 2.5 MB

data/examples/allocations/memory.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-def measure_memory(annotation = "Memory allocated")
-	GC.disable
-	
-	start_memory = `ps -p #{Process::pid} -o rss`.split("\n")[1].chomp.to_i
-
-	yield
-	
-ensure
-	end_memory = `ps -p #{Process::pid} -o rss`.split("\n")[1].chomp.to_i
-	memory_usage = (end_memory - start_memory).to_f / 1024
-	
-	puts "#{memory_usage.round(1)} MB: #{annotation}"
-	GC.enable
-end

data/examples/allocations/read_chunks.rb

@@ -1,18 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative 'memory'
-
-require_relative "../../lib/async/io/stream"
-require "stringio"
-
-measure_memory("Stream setup") do
-	@io = StringIO.new("a" * (50*1024*1024))
-	@stream = Async::IO::Stream.new(@io)
-end # 50.0 MB
-
-measure_memory("Read all chunks") do
-	while chunk = @stream.read_partial
-		chunk.clear
-	end
-end # 0.5 MB

data/examples/chat/client.rb

@@ -1,58 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-$LOAD_PATH << File.expand_path("../../lib", __dir__)
-
-require 'async'
-require 'async/notification'
-require 'async/io/stream'
-require 'async/io/host_endpoint'
-require 'async/io/protocol/line'
-
-class User < Async::IO::Protocol::Line
-end
-
-endpoint = Async::IO::Endpoint.parse(ARGV.pop || "tcp://localhost:7138")
-
-input = Async::IO::Protocol::Line.new(
-	Async::IO::Stream.new(
-		Async::IO::Generic.new($stdin)
-	)
-)
-
-Async do |task|
-	socket = endpoint.connect
-	stream = Async::IO::Stream.new(socket)
-	user = User.new(stream)
-	
-	# This is used to track whether either reading from stdin failed or reading from network failed.
-	finished = Async::Notification.new
-	
-	# Read lines from stdin and write to network.
-	terminal = task.async do
-		while line = input.read_line
-			user.write_lines line
-		end
-	rescue EOFError
-		# It's okay, we are disconnecting, because stdin has closed.
-	ensure
-		finished.signal
-	end
-	
-	# Read lines from network and write to stdout.
-	network = task.async do
-		while line = user.read_line
-			puts line
-		end
-	ensure
-		finished.signal
-	end
-	
-	# Wait for any of the above processes to finish:
-	finished.wait
-ensure
-	# Stop all the nested tasks if we are exiting:
-	network.stop if network
-	terminal.stop if terminal
-	user.close if user
-end

data/examples/chat/server.rb

@@ -1,83 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-$LOAD_PATH << File.expand_path("../../lib", __dir__)
-
-require 'set'
-
-require 'async'
-require 'async/io/host_endpoint'
-require 'async/io/protocol/line'
-
-class User < Async::IO::Protocol::Line
-	attr_accessor :name
-	
-	def login!
-		self.write_lines "Tell me your name, traveller:"
-		self.name = self.read_line
-	end
-	
-	def to_s
-		@name || "unknown"
-	end
-end
-
-class Server
-	def initialize
-		@users = Set.new
-	end
-	
-	def broadcast(*message)
-		puts *message
-		
-		@users.each do |user|
-			begin
-				user.write_lines(*message)
-			rescue EOFError
-				# In theory, it's possible this will fail if the remote end has disconnected. Each user has it's own task running `#connected`, and eventually `user.read_line` will fail. When it does, the disconnection logic will be invoked. A better way to do this would be to have a message queue, but for the sake of keeping this example simple, this is by far the better option.
-			end
-		end
-	end
-	
-	def connected(user)
-		user.login!
-		
-		broadcast("#{user} has joined")
-		
-		user.write_lines("currently connected: #{@users.map(&:to_s).join(', ')}")
-		
-		while message = user.read_line
-			broadcast("#{user.name}: #{message}")
-		end
-	rescue EOFError
-		# It's okay, client has disconnected.
-	ensure
-		disconnected(user)
-	end
-	
-	def disconnected(user, reason = "quit")
-		@users.delete(user)
-		
-		broadcast("#{user} has disconnected: #{reason}")
-	end
-	
-	def run(endpoint)
-		Async do |task|
-			endpoint.accept do |peer|
-				stream = Async::IO::Stream.new(peer)
-				user = User.new(stream)
-				
-				@users << user
-				
-				connected(user)
-			end
-		end
-	end
-end
-
-Async.logger.level = Logger::INFO
-Async.logger.info("Starting server...")
-server = Server.new
-
-endpoint = Async::IO::Endpoint.parse(ARGV.pop || "tcp://localhost:7138")
-server.run(endpoint)