Contents

require "backport/version"
require 'socket'

module Backport
  autoload :Adapter, 'backport/adapter'
  autoload :Machine, 'backport/machine'
  autoload :Server,  'backport/server'
  autoload :Client,  'backport/client'

  class << self
    # Prepare a STDIO server to run in Backport.
    #
    # @param adapter [Adapter]
    # @return [void]
    def prepare_stdio_server adapter: Adapter
      machine.prepare Backport::Server::Stdio.new(adapter: adapter)
    end

    # Prepare a TCP server to run in Backport.
    #
    # @param host [String]
    # @param port [Integer]
    # @param adapter [Adapter]
    # @return [void]
    def prepare_tcp_server host: 'localhost', port: 1117, adapter: Adapter
      machine.prepare Backport::Server::Tcpip.new(host: host, port: port, adapter: adapter)
    end

    # Prepare an interval server to run in Backport.
    #
    # @param period [Float] Seconds between intervals
    # @return [void]
    def prepare_interval period, &block
      machine.prepare Backport::Server::Interval.new(period, &block)
    end

    # Run the Backport machine. The provided block will be executed before the
    # machine starts. Program execution is halted until the machine stops.
    #
    # @example Print "tick" once per second
    #   Backport.run do
    #     Backport.prepare_interval 1 do
    #       puts "tick"
    #     end
    #   end
    #
    # @return [void]
    def run &block
      machine.run &block
    end

    # Stop the Backport machine.
    #
    # @return [void]
    def stop
      machine.stop
    end

    private

    # @return [Machine]
    def machine
      @machine ||= Machine.new
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
backport-0.2.0	lib/backport.rb