iodine 0.5.2 → 0.6.0

data/ext/iodine/rb-registry.h

@@ -1,34 +0,0 @@
-/*
-Copyright: Boaz segev, 2016-2017
-License: MIT
-
-Feel free to copy, use and enjoy according to the license provided.
-*/
-#ifndef RB_REGISTRY_HELPER_H
-#define RB_REGISTRY_HELPER_H
-#include <ruby.h>
-
-/**
-This is a "Registry" helper for Ruby extentions.
-
-The registry allows "registering" Ruby objects to be marked by the Ruby's GC.
-This prevents the need for global variables such as Ruby arrays or Hashes
-with Ruby objects and allows easy management of Ruby objects owned by C code.
-
-GC requires a callback "mark" to inform it which objects are still
-referenced.
-
-Our library creates, holds and releases myriad Ruby objects.
-
-Hence, our server class needs to include an object binary tree to
-handle ruby registry and keep references to the Ruby objects.
-*/
-extern struct ___RegistryClass___ {
-  void (*init)(VALUE owner);
-  void (*remove)(VALUE obj);
-  VALUE (*add)(VALUE obj);
-  void (*print)(void);
-  void (*on_fork)(void);
-} Registry;
-
-#endif // RB_REGISTRY_HELPER_H

data/lib/iodine/cli.rb

@@ -1,89 +0,0 @@
-require 'iodine'
-require 'rack'
-
-module Iodine
-  # The Iodine::Base namespace is reserved for internal use and is NOT part of the public API.
-  module Base
-    # Command line interface. The Ruby CLI might be changed in future versions.
-    module CLI
-
-      def print_help
-        puts <<-EOS
-
-Iodine's HTTP/Websocket server version #{Iodine::VERSION}
-
-Use:
-
-    iodine <options> <filename>
-
-Both <options> and <filename> are optional.
-
-Available options:
- -b          Binding address. Default: nil (same as 0.0.0.0).
- -p          Port number. Default: 3000.
- -t          Number of threads. Default: CPU core count.
- -w          Number of worker processes. Default: CPU core count.
- -www        Public folder for static file serving. Default: nil (none).
- -v          Log responses. Default: never log responses.
- -warmup     Warmup invokes autoloading (lazy loading) during server startup.
- -tout       HTTP inactivity connection timeout. Default: 40 seconds.
- -maxhead    Maximum total headers length per HTTP request. Default: 32Kb.
- -maxbd      Maximum Mb per HTTP message (max body size). Default: 50Mb.
- -maxms      Maximum Bytes per Websocket message. Default: 250Kb.
- -ping       Websocket ping interval in seconds. Default: 40 seconds.
- <filename>  Defaults to: config.ru
-
-Example:
-
-    iodine -p 80
-
-    iodine -p 8080 path/to/app/conf.ru
-
-    iodine -p 8080 -w 4 -t 16
-
-EOS
-      end
-
-
-      def try_file filename
-        return nil unless File.exist? filename
-        return ::Rack::Builder.parse_file filename
-      end
-
-      def call
-        if ARGV[0] =~ /(\-\?)|(help)|(\?)|(h)|(\-h)$/
-          return print_help
-        end
-
-        app, opt = nil, nil
-        filename = ((ARGV[-2].to_s[0] != '-' || ARGV[-2].to_s == '-warmup' || ARGV[-2].to_s == '-v' || ARGV[-2].to_s == '-q') && ARGV[-1].to_s[0] != '-' && ARGV[-1])
-        if filename
-          app, opt = try_file filename;
-          unless opt
-            puts "* Couldn't find #{filename}\n  testing for config.ru\n"
-            app, opt = try_file "config.ru"
-          end
-        else
-          app, opt = try_file "config.ru";
-        end
-
-        unless opt
-          puts "WARNING: Ruby application not found#{ filename ? " - missing both #{filename} and config.ru" : " - missing config.ru"}."
-          if ARGV.index('-www') && ARGV[ARGV.index('-www') + 1]
-            puts "         Running only static file service."
-            opt = ::Rack::Server::Options.new.parse!([])
-          else
-            puts "For help run:"
-            puts "       iodine -?"
-            return
-          end
-        end
-
-        Iodine.warmup(app) if ARGV.index('-warmup')
-        Iodine::Rack.run(app, opt)
-      end
-
-      extend self
-    end
-  end
-end

data/lib/iodine/monkeypatch.rb

@@ -1,46 +0,0 @@
-module Iodine
-  # The Iodine::Base namespace is reserved for internal use and is NOT part of the public API.
-  module Base
-    # Iodine does NOT monkey patch automatically at this time.
-    #
-    # This may change in future releases, but that's unlikely.
-    module MonkeyPatch
-      # Iodine does NOT monkey patch Rack automatically. However, it's possible to
-      # moneky patch Rack::Utils using this module.
-      #
-      # Choosing to monkey patch Rack::Utils could offer significant performance gains for some applications. i.e. (on my machine):
-      #
-      #       require 'iodine'
-      #       require 'rack'
-      #       # a String in need of decoding
-      #       s = '%E3%83%AB%E3%83%93%E3%82%A4%E3%82%B9%E3%81%A8'
-      #       Benchmark.bm do |bm|
-      #         # Pre-Patch
-      #         bm.report("   Rack.unescape")    {1_000_000.times { Rack::Utils.unescape s } }
-      #         bm.report("    Rack.rfc2822")    {1_000_000.times { Rack::Utils.rfc2822(Time.now) } }
-      #         bm.report("    Rack.rfc2109")    {1_000_000.times { Rack::Utils.rfc2109(Time.now) } }
-      #         # Perform Patch
-      #         Iodine.patch_rack
-      #         puts "            --- Monkey Patching Rack ---"
-      #         # Post Patch
-      #         bm.report("Patched.unescape")    {1_000_000.times { Rack::Utils.unescape s } }
-      #         bm.report(" Patched.rfc2822")    {1_000_000.times { Rack::Utils.rfc2822(Time.now) } }
-      #         bm.report(" Patched.rfc2109")    {1_000_000.times { Rack::Utils.rfc2109(Time.now) } }
-      #       end && nil
-      #
-      # Results:
-      #         user     system      total        real
-      #         Rack.unescape  8.660000   0.010000   8.670000 (  8.687807)
-      #         Rack.rfc2822  3.730000   0.000000   3.730000 (  3.727732)
-      #         Rack.rfc2109  3.020000   0.010000   3.030000 (  3.031940)
-      #                      --- Monkey Patching Rack ---
-      #         Patched.unescape  0.340000   0.000000   0.340000 (  0.341506)
-      #         Patched.rfc2822  0.740000   0.000000   0.740000 (  0.737796)
-      #         Patched.rfc2109  0.690000   0.010000   0.700000 (  0.700155)
-      #
-      module RackUtils
-      end
-    end
-  end
-end
-\

data/lib/iodine/protocol.rb

@@ -1,42 +0,0 @@
-module Iodine
-  # The Protocol class is used only for documenting the Protocol API, it will not be included when requiring `iodine`.
-  #
-  # A dynamic (stateful) protocol is defined as a Ruby class instance which is in control of one single connection.
-  #
-  # It is called dynamic because it is dynamically allocated for each connection and then discarded,
-  # also it sounded better then calling it "the stateful protocol", even though that's what it actually is.
-  #
-  # It is (mostly) thread-safe as long as it's operations are limited to the scope
-  # of the object.
-  #
-  # <b>The Callbacks</b>
-  #
-  # A protocol class <b>MUST</b> contain ONE of the following callbacks:
-  #
-  # on_data:: called whened there's data available to be read, but no data was read just yet. `on_data` will not be called again untill all the existing network buffer was read (edge triggered event).
-  # on_message(buffer):: the default `on_data` implementation creates a 1Kb buffer and reads data while recycling the same String memory space. The buffer is forwarded to the `on_message` callback before being recycled. The buffer object will be over-written once `on_message` returns, so creating a persistent copy requires `buffer.dup`.
-  #
-  # A protocol class <b>MAY</b> contain any of the following optional callbacks:
-  #
-  # on_open:: called after a new connection was accepted and the protocol was linked with Iodine's Protocol API. Initialization should be performed here.
-  # ping:: called whenever timeout was reached. The default implementation will close the connection unless a protocol task ({Protocol#defer}, `on_data` or `on_message`) are busy in the background.
-  # on_shutdown:: called if the connection is still open while the server is shutting down. This allows the protocol to send a "going away" frame before the connection is closed and `on_close` is called.
-  # on_close:: called after a connection was closed, for any cleanup (if any).
-  #
-  # WARNING: for thread safety and connection management, `on_open`, `on_shutdown`, `on_close` and `ping` will all be performed within the reactor's main thread.
-  # Do not run long running tasks within these callbacks, or the server might block while you do.
-  # Use {#defer} to run protocol related tasks (this locks the connection, preventing it from running more then one task at a time and offering thread safety),
-  # or {#run} to run asynchronous tasks that aren't protocol related.
-  #
-  # <b>Connection timeouts</b>
-  #
-  # By setting a class variable called `@timeout` it is possible to define a default timeout for new connections. However, changing this default timeout should be performed using the {#timeout} methods.
-  #
-  # <b>The API:</b>
-  #
-  # After a new connection is accepted and a new protocol object is created, the protocol will be linked with Iodine's Protocol API.
-  # Only the main protocol will be able to access the API within `initialize`, so it's best to use `on_open` for any Initialization required.
-  #
-  module Protocol
-  end
-end

data/lib/iodine/websocket.rb

@@ -1,16 +0,0 @@
-module Iodine
-  # This module lists the available API for WebSocket and EventSource (SSE) connections.
-  #
-  # This module is mixed in (using `extend` and `include`) with the WebSocket Callback Object (as specified by the {file:SPEC-Websocket-Draft.md proposed Rack specification}.
-  #
-  # The server performs `extend` to allow the application to be namespace agnostic (so the server can be replaced without effecting the application).
-  #
-  # The websocket API is divided into three main groups:
-  # * Server <=> Client relations ({Iodine::Websocket#write}, {Iodine::Websocket#close} etc')
-  # * Client <=> Server <=> Pub/Sub relations ({Iodine::Websocket#subscribe}, {Iodine::Websocket#publish}.
-  # * Task scheduling ({Iodine::Websocket.defer}, {Iodine::Websocket#defer}, {Iodine::Websocket.each}).
-  #
-  # Notice that Websocket callback objects (as specified by the {file:SPEC-Websocket-Draft.md proposed Rack specification} *MUST* provide an `on_message(data)` callback.
-  module Websocket
-  end
-end