Contents

# Author::    Eric Crane  (mailto:[e-mail])
# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
#
# Quit the running gloo engine.
#

module Gloo
  module Verbs
    class Quit < Gloo::Core::Verb

      KEYWORD = 'quit'.freeze
      KEYWORD_SHORT = 'q'.freeze

      #
      # Run the verb.
      #
      # We'll mark the application as not running and let the
      # engine stop gracefully next time through the loop.
      #
      def run
        $engine.stop_running
      end

      #
      # Get the Verb's keyword.
      #
      def self.keyword
        return KEYWORD
      end

      #
      # Get the Verb's keyword shortcut.
      #
      def self.keyword_shortcut
        return KEYWORD_SHORT
      end

      # ---------------------------------------------------------------------
      #    Help
      # ---------------------------------------------------------------------

      #
      # Get help for this verb.
      #
      def self.help
        return <<~TEXT
          QUIT VERB
            NAME: quit
            SHORTCUT: q

          DESCRIPTION
            Stop running the gloo application.
            Cleanup and shutdown.

          SYNTAX
            quit

          PARAMETERS
            None

          RESULT
            None

          ERRORS
            None
        TEXT
      end

    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
gloo-0.6.1	lib/gloo/verbs/quit.rb
gloo-0.6.0	lib/gloo/verbs/quit.rb
gloo-0.5.4	lib/gloo/verbs/quit.rb
gloo-0.5.3	lib/gloo/verbs/quit.rb
gloo-0.5.2	lib/gloo/verbs/quit.rb
gloo-0.5.1	lib/gloo/verbs/quit.rb
gloo-0.5.0	lib/gloo/verbs/quit.rb
gloo-0.4.0	lib/gloo/verbs/quit.rb