Subversion Info

Rev
437
Last Checked In
2008-03-28 00:49:20 (2 weeks ago)
Checked in by
deveiant

Parent

Class Index

Quicksearch

Arrow::Monitor

Instance of this class are used to monitor activity within an Arrow system..

Constants

SVNRev
SVN Revision
SVNId
SVN Id

Attributes

instances[RW]

(Not documented)

Public Class Methods

new( mod, subjectHash ) click to toggle source

Initialize an Arrow::Monitor object for the specified mod and subjectHash.

     # File /Users/ged/source/ruby/Arrow/lib/arrow/monitor.rb, line 113
113:     def initialize( mod, subjectHash )
114:         @module = mod
115:         @subjects = {}
116: 
117:         subjectHash.each {|sym,config|
118:             subject = Monitor::Subject.create( config )
119:             @subjects[ sym ] = subject
120:         }
121:     end
register( mod, subjectHash ) click to toggle source

Register a module with the monitoring system, specifying the available monitoring subjects in the subjectHash.

     # File /Users/ged/source/ruby/Arrow/lib/arrow/monitor.rb, line 102
102:     def self::register( mod, subjectHash )
103:         @instances[ mod ] = new( subjectHash )
104:     end
startBackend( config ) click to toggle source

Start the backend monitor server

    # File /Users/ged/source/ruby/Arrow/lib/arrow/monitor.rb, line 94
94:     def self::startBackend( config )
95:         # No-op currently
96:         return false
97:     end

secsequence

--- SEC00084

seccomment

--- ""

attributes

--- 
- name: instances
  rw: RW
  a_desc: ""

method_list

--- 
- methods: 
  - visibility: public
    aref: M000529
    name: new
    sourcecode: "     <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/monitor.rb, line 113</span>\n\
      113:     <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">initialize</span>( <span class=\"ruby-identifier\">mod</span>, <span class=\"ruby-identifier\">subjectHash</span> )\n\
      114:         <span class=\"ruby-ivar\">@module</span> = <span class=\"ruby-identifier\">mod</span>\n\
      115:         <span class=\"ruby-ivar\">@subjects</span> = {}\n\
      116: \n\
      117:         <span class=\"ruby-identifier\">subjectHash</span>.<span class=\"ruby-identifier\">each</span> {<span class=\"ruby-operator\">|</span><span class=\"ruby-identifier\">sym</span>,<span class=\"ruby-identifier\">config</span><span class=\"ruby-operator\">|</span>\n\
      118:             <span class=\"ruby-identifier\">subject</span> = <span class=\"ruby-constant\">Monitor</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">Subject</span>.<span class=\"ruby-identifier\">create</span>( <span class=\"ruby-identifier\">config</span> )\n\
      119:             <span class=\"ruby-ivar\">@subjects</span>[ <span class=\"ruby-identifier\">sym</span> ] = <span class=\"ruby-identifier\">subject</span>\n\
      120:         }\n\
      121:     <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Initialize an <a href="Monitor.html">Arrow::Monitor</a> object for the
      specified <tt>mod</tt> and <tt>subjectHash</tt>.
      </p>
    params: ( mod, subjectHash )
  - visibility: public
    aref: M000528
    name: register
    sourcecode: "     <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/monitor.rb, line 102</span>\n\
      102:     <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-keyword kw\">self</span><span class=\"ruby-operator\">::</span><span class=\"ruby-identifier\">register</span>( <span class=\"ruby-identifier\">mod</span>, <span class=\"ruby-identifier\">subjectHash</span> )\n\
      103:         <span class=\"ruby-ivar\">@instances</span>[ <span class=\"ruby-identifier\">mod</span> ] = <span class=\"ruby-identifier\">new</span>( <span class=\"ruby-identifier\">subjectHash</span> )\n\
      104:     <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Register a <tt>module</tt> with the monitoring system, specifying the
      available monitoring subjects in the <tt>subjectHash</tt>.
      </p>
    params: ( mod, subjectHash )
  - visibility: public
    aref: M000527
    name: startBackend
    sourcecode: "    <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/monitor.rb, line 94</span>\n\
      94:     <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-keyword kw\">self</span><span class=\"ruby-operator\">::</span><span class=\"ruby-identifier\">startBackend</span>( <span class=\"ruby-identifier\">config</span> )\n\
      95:         <span class=\"ruby-comment cmt\"># No-op currently</span>\n\
      96:         <span class=\"ruby-keyword kw\">return</span> <span class=\"ruby-keyword kw\">false</span>\n\
      97:     <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Start the backend monitor server
      </p>
    params: ( config )
  category: Class
  type: Public

sectitle

--- 

constants

--- 
- name: SVNRev
  desc: |+
    
    SVN Revision
    
  value: "%q$Rev: 437 $"
- name: SVNId
  desc: |+
    
    SVN Id
    
  value: "%q$Id: monitor.rb 437 2008-03-28 00:49:20Z deveiant $"

[Validate]

Generated with the Darkfish Rdoc Generator.