### Home Classes Methods

### In Files

- lib/mcollective/agents.rb

### Parent

Object

### Methods

- ::agentlist
- ::new
- #activate_agent?
- #class_for_agent
- #clear!
- #dispatch
- #findagentfile
- #include?
- #loadagent
- #loadagents

### Files

- COPYING
- README
- Rakefile
- PLACEHOLDER
- PLACEHOLDER

### Class/Module Index

Quicksearch

- MCollective
- MCollective::Agent
- MCollective::Agents
- MCollective::Aggregate
- MCollective::Aggregate::Base
- MCollective::Aggregate::Result
- MCollective::Aggregate::Result::Base
- MCollective::Aggregate::Result::CollectionResult
- MCollective::Aggregate::Result::NumericResult
- MCollective::Application
- MCollective::Applications
- MCollective::Client
- MCollective::Config
- MCollective::Connector
- MCollective::Connector::Base
- MCollective::DDL
- MCollective::DDLValidationError
- MCollective::Data
- MCollective::Data::Base
- MCollective::Data::Result
- MCollective::Discovery
- MCollective::Facts
- MCollective::Facts::Base
- MCollective::Generators
- MCollective::Generators::AgentGenerator
- MCollective::Generators::Base
- MCollective::Generators::DataGenerator
- MCollective::InvalidRPCData
- MCollective::Log
- MCollective::Logger
- MCollective::Logger::Base
- MCollective::Logger::Console_logger
- MCollective::Logger::File_logger
- MCollective::Logger::Syslog_logger
- MCollective::Matcher
- MCollective::Matcher::Parser
- MCollective::Matcher::Scanner
- MCollective::Message
- MCollective::MissingRPCData
- MCollective::MsgDoesNotMatchRequestID
- MCollective::MsgTTLExpired
- MCollective::NotTargettedAtUs
- MCollective::Optionparser
- MCollective::PluginManager
- MCollective::PluginPackager
- MCollective::PluginPackager::AgentDefinition
- MCollective::PluginPackager::StandardDefinition
- MCollective::RPC
- MCollective::RPC::ActionRunner
- MCollective::RPC::Agent
- MCollective::RPC::Audit
- MCollective::RPC::Client
- MCollective::RPC::Helpers
- MCollective::RPC::Progress
- MCollective::RPC::Reply
- MCollective::RPC::Request
- MCollective::RPC::Result
- MCollective::RPC::Stats
- MCollective::RPCAborted
- MCollective::RPCError
- MCollective::Registration
- MCollective::Registration::Base
- MCollective::Runner
- MCollective::RunnerStats
- MCollective::SSL
- MCollective::Security
- MCollective::Security::Base
- MCollective::SecurityValidationFailed
- MCollective::Shell
- MCollective::UnixDaemon
- MCollective::UnknownRPCAction
- MCollective::UnknownRPCError
- MCollective::Util
- MCollective::WindowsDaemon
- Array
- Dir
- Object
- String
- Symbol

No matching classes.

# MCollective::Agents

A collection of agents, loads them, reloads them and dispatches messages to them. It uses the PluginManager to store, load and manage instances of plugins.

### Public Instance Methods

activate_agent?(agent) click to toggle source

Checks if a plugin should be activated by calling #activate? on it if it responds to that method else always activate it

    # File lib/mcollective/agents.rb, line 85
    def activate_agent?(agent)
      klass = Kernel.const_get("MCollective").const_get("Agent").const_get(agent.capitalize)

      if klass.respond_to?("activate?")
        return klass.activate?
      else
        Log.debug("#{klass} does not have an activate? method, activating as default")
        return true
      end
    rescue Exception => e
      Log.warn("Agent activation check for #{agent} failed: #{e.class}: #{e}")
      return false
    end

class_for_agent(agent) click to toggle source

Builds a class name string given a Agent name

    # File lib/mcollective/agents.rb, line 78
    def class_for_agent(agent)
      "MCollective::Agent::#{agent.capitalize}"
    end

clear!() click to toggle source

Deletes all agents

    # File lib/mcollective/agents.rb, line 15
    def clear!
      @@agents.each_key do |agent|
        PluginManager.delete "#{agent}_agent"
        Util.unsubscribe(Util.make_subscriptions(agent, :broadcast))
      end

      @@agents = {}
    end

dispatch(request, connection) click to toggle source

Dispatches a message to an agent, accepts a block that will get run if there are any replies to process from the agent

    # File lib/mcollective/agents.rb, line 118
    def dispatch(request, connection)
      Log.debug("Dispatching a message to agent #{request.agent}")

      Thread.new do
        begin
          agent = PluginManager["#{request.agent}_agent"]

          Timeout::timeout(agent.timeout) do
            replies = agent.handlemsg(request.payload, connection)

            # Agents can decide if they wish to reply or not,
            # returning nil will mean nothing goes back to the
            # requestor
            unless replies == nil
              yield(replies)
            end
          end
        rescue Timeout::Error => e
          Log.warn("Timeout while handling message for #{request.agent}")
        rescue Exception => e
          Log.error("Execution of #{request.agent} failed: #{e}")
          Log.error(e.backtrace.join("\n\t\t"))
        end
      end
    end

findagentfile(agentname) click to toggle source

searches the libdirs for agents

    # File lib/mcollective/agents.rb, line 100
    def findagentfile(agentname)
      @config.libdir.each do |libdir|
        agentfile = File.join([libdir, "mcollective", "agent", "#{agentname}.rb"])
        if File.exist?(agentfile)
          Log.debug("Found #{agentname} at #{agentfile}")
          return agentfile
        end
      end
      return false
    end

include?(agentname) click to toggle source

Determines if we have an agent with a certain name

    # File lib/mcollective/agents.rb, line 112
    def include?(agentname)
      PluginManager.include?("#{agentname}_agent")
    end

loadagent(agentname) click to toggle source

Loads a specified agent from disk if available

    # File lib/mcollective/agents.rb, line 42
    def loadagent(agentname)
      agentfile = findagentfile(agentname)
      return false unless agentfile
      classname = class_for_agent(agentname)

      PluginManager.delete("#{agentname}_agent")

      begin
        single_instance = ["registration", "discovery"].include?(agentname)

        PluginManager.loadclass(classname)

        if activate_agent?(agentname)
          PluginManager << {:type => "#{agentname}_agent", :class => classname, :single_instance => single_instance}

          # Attempt to instantiate the agent once so any validation and hooks get run
          # this does a basic sanity check on the agent as a whole, if this fails it
          # will be removed from the plugin list
          PluginManager["#{agentname}_agent"]

          Util.subscribe(Util.make_subscriptions(agentname, :broadcast)) unless @@agents.include?(agentname)

          @@agents[agentname] = {:file => agentfile}
          return true
        else
          Log.debug("Not activating agent #{agentname} due to agent policy in activate? method")
          return false
        end
      rescue Exception => e
        Log.error("Loading agent #{agentname} failed: #{e}")
        PluginManager.delete("#{agentname}_agent")
        return false
      end
    end

loadagents() click to toggle source

Loads all agents from disk

    # File lib/mcollective/agents.rb, line 25
    def loadagents
      Log.debug("Reloading all agents from disk")

      clear!

      @config.libdir.each do |libdir|
        agentdir = "#{libdir}/mcollective/agent"
        next unless File.directory?(agentdir)

        Dir.new(agentdir).grep(/\.rb$/).each do |agent|
          agentname = File.basename(agent, ".rb")
          loadagent(agentname) unless PluginManager.include?("#{agentname}_agent")
        end
      end
    end

### Public Class Methods

agentlist() click to toggle source

Get a list of agents that we have

    # File lib/mcollective/agents.rb, line 145
    def self.agentlist
      @@agents.keys
    end

new(agents = {}) click to toggle source

    # File lib/mcollective/agents.rb, line 5
    def initialize(agents = {})
      @config = Config.instance
      raise ("Configuration has not been loaded, can't load agents") unless @config.configured

      @@agents = agents

      loadagents
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.