doc/MCollective/Data/Base.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   3         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
   7
   8         <title>Class: MCollective::Data::Base</title>
   9
  10         <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
  11
  12         <script src="../../js/jquery.js" type="text/javascript"
  13                 charset="utf-8"></script>
  14         <script src="../../js/thickbox-compressed.js" type="text/javascript"
  15                 charset="utf-8"></script>
  16         <script src="../../js/quicksearch.js" type="text/javascript"
  17                 charset="utf-8"></script>
  18         <script src="../../js/darkfish.js" type="text/javascript"
  19                 charset="utf-8"></script>
  20
  21 </head>
  22 <body class="class">
  23
  24         <div id="metadata">
  25                 <div id="file-metadata">
  26                         <div id="file-list-section" class="section">
  27                                 <h3 class="section-header">In Files</h3>
  28                                 <div class="section-body">
  29                                         <ul>
  30
  31                                                 <li><a href="../../lib/mcollective/data/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  32                                                         class="thickbox" title="lib/mcollective/data/base.rb">lib/mcollective/data/base.rb</a></li>
  33
  34                                         </ul>
  35                                 </div>
  36                         </div>
  37
  38
  39                 </div>
  40
  41                 <div id="class-metadata">
  42
  43                         <!-- Parent Class -->
  44
  45                         <div id="parent-class-section" class="section">
  46                                 <h3 class="section-header">Parent</h3>
  47
  48                                 <p class="link"><a href="../../Object.html">Object</a></p>
  49
  50                         </div>
  51
  52
  53                         <!-- Namespace Contents -->
  54
  55
  56                         <!-- Method Quickref -->
  57
  58                         <div id="method-list-section" class="section">
  59                                 <h3 class="section-header">Methods</h3>
  60                                 <ul class="link-list">
  61
  62                                         <li><a href="#M000196">::activate?</a></li>
  63
  64                                         <li><a href="#M000189">::activate_when</a></li>
  65
  66                                         <li><a href="#M000184">::inherited</a></li>
  67
  68                                         <li><a href="#M000185">::new</a></li>
  69
  70                                         <li><a href="#M000187">::query</a></li>
  71
  72                                         <li><a href="#M000188">#ddl_validate</a></li>
  73
  74                                         <li><a href="#M000186">#lookup</a></li>
  75
  76                                         <li><a href="#M000197">#startup_hook</a></li>
  77
  78                                 </ul>
  79                         </div>
  80
  81
  82                         <!-- Included Modules -->
  83
  84                 </div>
  85
  86                 <div id="project-metadata">
  87
  88
  89                         <div id="fileindex-section" class="section project-section">
  90                                 <h3 class="section-header">Files</h3>
  91                                 <ul>
  92
  93                                         <li class="file"><a href="../../COPYING.html">COPYING</a></li>
  94
  95                                         <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
  96
  97                                         <li class="file"><a href="../../README.html">README</a></li>
  98
  99                                         <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
 100
 101                                         <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
 102
 103                                         <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
 104
 105                                         <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
 106
 107                                         <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
 108
 109                                         <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
 110
 111                                         <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
 112
 113                                         <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
 114
 115                                         <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
 116
 117                                         <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
 118
 119                                         <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
 120
 121                                         <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
 122
 123                                         <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
 124
 125                                         <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
 126
 127                                         <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
 128
 129                                         <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
 130
 131                                         <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
 132
 133                                 </ul>
 134                         </div>
 135
 136
 137                         <div id="classindex-section" class="section project-section">
 138                                 <h3 class="section-header">Class Index
 139                                         <span class="search-toggle"><img src="../../images/find.png"
 140                                                 height="16" width="16" alt="[+]"
 141                                                 title="show/hide quicksearch" /></span></h3>
 142                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
 143                                 <fieldset>
 144                                         <legend>Quicksearch</legend>
 145                                         <input type="text" name="quicksearch" value=""
 146                                                 class="quicksearch-field" />
 147                                 </fieldset>
 148                                 </form>
 149
 150                                 <ul class="link-list">
 151
 152                                         <li><a href="../../MCollective.html">MCollective</a></li>
 153
 154                                         <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
 155
 156                                         <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
 157
 158                                         <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
 159
 160                                         <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
 161
 162                                         <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
 163
 164                                         <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
 165
 166                                         <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
 167
 168                                         <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
 169
 170                                         <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
 171
 172                                         <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
 173
 174                                         <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
 175
 176                                         <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
 177
 178                                         <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
 179
 180                                         <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
 181
 182                                         <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
 183
 184                                         <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
 185
 186                                         <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
 187
 188                                         <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
 189
 190                                         <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
 191
 192                                         <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
 193
 194                                         <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
 195
 196                                         <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
 197
 198                                         <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
 199
 200                                         <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
 201
 202                                         <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
 203
 204                                         <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
 205
 206                                         <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
 207
 208                                         <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
 209
 210                                         <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
 211
 212                                         <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
 213
 214                                         <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
 215
 216                                         <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
 217
 218                                         <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
 219
 220                                         <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
 221
 222                                         <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
 223
 224                                         <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
 225
 226                                         <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
 227
 228                                         <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
 229
 230                                         <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
 231
 232                                         <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
 233
 234                                         <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
 235
 236                                         <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
 237
 238                                         <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
 239
 240                                         <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
 241
 242                                         <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
 243
 244                                         <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
 245
 246                                         <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
 247
 248                                         <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
 249
 250                                         <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
 251
 252                                         <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
 253
 254                                         <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
 255
 256                                         <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
 257
 258                                         <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
 259
 260                                         <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
 261
 262                                         <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
 263
 264                                         <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
 265
 266                                         <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
 267
 268                                         <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
 269
 270                                         <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
 271
 272                                         <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
 273
 274                                         <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
 275
 276                                         <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
 277
 278                                         <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
 279
 280                                         <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
 281
 282                                         <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
 283
 284                                         <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
 285
 286                                         <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
 287
 288                                         <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
 289
 290                                         <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
 291
 292                                         <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
 293
 294                                         <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
 295
 296                                         <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
 297
 298                                         <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
 299
 300                                         <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
 301
 302                                         <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
 303
 304                                         <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
 305
 306                                         <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
 307
 308                                         <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
 309
 310                                         <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
 311
 312                                         <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
 313
 314                                         <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
 315
 316                                         <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
 317
 318                                         <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
 319
 320                                         <li><a href="../../Array.html">Array</a></li>
 321
 322                                         <li><a href="../../Dir.html">Dir</a></li>
 323
 324                                         <li><a href="../../Object.html">Object</a></li>
 325
 326                                         <li><a href="../../String.html">String</a></li>
 327
 328                                         <li><a href="../../Symbol.html">Symbol</a></li>
 329
 330                                 </ul>
 331                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 332                         </div>
 333
 334
 335                 </div>
 336         </div>
 337
 338         <div id="documentation">
 339                 <h1 class="class">MCollective::Data::Base</h1>
 340
 341                 <div id="description">
 342
 343                 </div>
 344
 345                 <!-- Constants -->
 346
 347
 348                 <!-- Attributes -->
 349
 350                 <div id="attribute-method-details" class="method-section section">
 351                         <h3 class="section-header">Attributes</h3>
 352
 353
 354                         <div id="name-attribute-method" class="method-detail">
 355                                 <a name="name"></a>
 356
 357                                 <div class="method-heading attribute-method-heading">
 358                                         <span class="method-name">name</span><span
 359                                                 class="attribute-access-type">[R]</span>
 360                                 </div>
 361
 362                                 <div class="method-description">
 363
 364                                 <p class="missing-docs">(Not documented)</p>
 365
 366                                 </div>
 367                         </div>
 368
 369                         <div id="result-attribute-method" class="method-detail">
 370                                 <a name="result"></a>
 371
 372                                 <div class="method-heading attribute-method-heading">
 373                                         <span class="method-name">result</span><span
 374                                                 class="attribute-access-type">[R]</span>
 375                                 </div>
 376
 377                                 <div class="method-description">
 378
 379                                 <p class="missing-docs">(Not documented)</p>
 380
 381                                 </div>
 382                         </div>
 383
 384                         <div id="ddl-attribute-method" class="method-detail">
 385                                 <a name="ddl"></a>
 386
 387                                 <div class="method-heading attribute-method-heading">
 388                                         <span class="method-name">ddl</span><span
 389                                                 class="attribute-access-type">[R]</span>
 390                                 </div>
 391
 392                                 <div class="method-description">
 393
 394                                 <p class="missing-docs">(Not documented)</p>
 395
 396                                 </div>
 397                         </div>
 398
 399                         <div id="timeout-attribute-method" class="method-detail">
 400                                 <a name="timeout"></a>
 401
 402                                 <div class="method-heading attribute-method-heading">
 403                                         <span class="method-name">timeout</span><span
 404                                                 class="attribute-access-type">[R]</span>
 405                                 </div>
 406
 407                                 <div class="method-description">
 408
 409                                 <p class="missing-docs">(Not documented)</p>
 410
 411                                 </div>
 412                         </div>
 413
 414                 </div>
 415
 416
 417                 <!-- Methods -->
 418
 419                 <div id="public-class-method-details" class="method-section section">
 420                         <h3 class="section-header">Public Class Methods</h3>
 421
 422
 423                         <div id="activate--method" class="method-detail ">
 424                                 <a name="M000196"></a>
 425
 426                                 <div class="method-heading">
 427
 428                                         <span class="method-name">activate?</span><span
 429                                                 class="method-args">()</span>
 430                                         <span class="method-click-advice">click to toggle source</span>
 431
 432                                 </div>
 433
 434                                 <div class="method-description">
 435
 436                                         <p>
 437 Always be active unless a specific block is given with <a
 438 href="Base.html#M000189">activate_when</a>
 439 </p>
 440
 441
 442
 443                                         <div class="method-source-code"
 444                                                 id="activate--source">
 445 <pre>
 446     <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 60</span>
 447 60:       <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">activate?</span>
 448 61:         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
 449 62:       <span class="ruby-keyword kw">end</span></pre>
 450                                         </div>
 451
 452                                 </div>
 453
 454
 455                         </div>
 456
 457
 458                         <div id="activate-when-method" class="method-detail ">
 459                                 <a name="M000189"></a>
 460
 461                                 <div class="method-heading">
 462
 463                                         <span class="method-name">activate_when</span><span
 464                                                 class="method-args">(&block)</span>
 465                                         <span class="method-click-advice">click to toggle source</span>
 466
 467                                 </div>
 468
 469                                 <div class="method-description">
 470
 471                                         <p>
 472 <a href="Base.html#M000189">activate_when</a> do
 473 </p>
 474 <pre>
 475    file.exist?(&quot;/usr/bin/puppet&quot;)
 476 </pre>
 477 <p>
 478 end
 479 </p>
 480
 481
 482
 483                                         <div class="method-source-code"
 484                                                 id="activate-when-source">
 485 <pre>
 486     <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 53</span>
 487 53:       <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">activate_when</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
 488 54:         (<span class="ruby-keyword kw">class</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-keyword kw">self</span>; <span class="ruby-keyword kw">self</span>; <span class="ruby-keyword kw">end</span>).<span class="ruby-identifier">instance_eval</span> <span class="ruby-keyword kw">do</span>
 489 55:           <span class="ruby-identifier">define_method</span>(<span class="ruby-value str">&quot;activate?&quot;</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
 490 56:         <span class="ruby-keyword kw">end</span>
 491 57:       <span class="ruby-keyword kw">end</span></pre>
 492                                         </div>
 493
 494                                 </div>
 495
 496
 497                         </div>
 498
 499
 500                         <div id="inherited-method" class="method-detail ">
 501                                 <a name="M000184"></a>
 502
 503                                 <div class="method-heading">
 504
 505                                         <span class="method-name">inherited</span><span
 506                                                 class="method-args">(klass)</span>
 507                                         <span class="method-click-advice">click to toggle source</span>
 508
 509                                 </div>
 510
 511                                 <div class="method-description">
 512
 513                                         <p>
 514 Register plugins that inherits base
 515 </p>
 516
 517
 518
 519                                         <div class="method-source-code"
 520                                                 id="inherited-source">
 521 <pre>
 522     <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 7</span>
 523  7:       <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inherited</span>(<span class="ruby-identifier">klass</span>)
 524  8:         <span class="ruby-identifier">type</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">&quot;::&quot;</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
 525  9:
 526 10:         <span class="ruby-constant">PluginManager</span> <span class="ruby-operator">&lt;&lt;</span> {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">type</span>, <span class="ruby-identifier">:class</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">:single_instance</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">false</span>}
 527 11:       <span class="ruby-keyword kw">end</span></pre>
 528                                         </div>
 529
 530                                 </div>
 531
 532
 533                         </div>
 534
 535
 536                         <div id="new-method" class="method-detail ">
 537                                 <a name="M000185"></a>
 538
 539                                 <div class="method-heading">
 540
 541                                         <span class="method-name">new</span><span
 542                                                 class="method-args">()</span>
 543                                         <span class="method-click-advice">click to toggle source</span>
 544
 545                                 </div>
 546
 547                                 <div class="method-description">
 548
 549                                         <p class="missing-docs">(Not documented)</p>
 550
 551
 552
 553                                         <div class="method-source-code"
 554                                                 id="new-source">
 555 <pre>
 556     <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 13</span>
 557 13:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
 558 14:         <span class="ruby-ivar">@name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">&quot;::&quot;</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>
 559 15:         <span class="ruby-ivar">@ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@name</span>, <span class="ruby-identifier">:data</span>)
 560 16:         <span class="ruby-ivar">@result</span> = <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">dataquery_interface</span>[<span class="ruby-identifier">:output</span>])
 561 17:         <span class="ruby-ivar">@timeout</span> = <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">meta</span>[<span class="ruby-identifier">:timeout</span>] <span class="ruby-operator">||</span> <span class="ruby-value">1</span>
 562 18:
 563 19:         <span class="ruby-identifier">startup_hook</span>
 564 20:       <span class="ruby-keyword kw">end</span></pre>
 565                                         </div>
 566
 567                                 </div>
 568
 569
 570                         </div>
 571
 572
 573                         <div id="query-method" class="method-detail ">
 574                                 <a name="M000187"></a>
 575
 576                                 <div class="method-heading">
 577
 578                                         <span class="method-name">query</span><span
 579                                                 class="method-args">(&block)</span>
 580                                         <span class="method-click-advice">click to toggle source</span>
 581
 582                                 </div>
 583
 584                                 <div class="method-description">
 585
 586                                         <p class="missing-docs">(Not documented)</p>
 587
 588
 589
 590                                         <div class="method-source-code"
 591                                                 id="query-source">
 592 <pre>
 593     <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 42</span>
 594 42:       <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">query</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
 595 43:         <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">module_eval</span> { <span class="ruby-identifier">define_method</span>(<span class="ruby-value str">&quot;query_data&quot;</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) }
 596 44:       <span class="ruby-keyword kw">end</span></pre>
 597                                         </div>
 598
 599                                 </div>
 600
 601
 602                         </div>
 603
 604
 605                 </div>
 606
 607                 <div id="public-instance-method-details" class="method-section section">
 608                         <h3 class="section-header">Public Instance Methods</h3>
 609
 610
 611                         <div id="ddl-validate-method" class="method-detail ">
 612                                 <a name="M000188"></a>
 613
 614                                 <div class="method-heading">
 615
 616                                         <span class="method-name">ddl_validate</span><span
 617                                                 class="method-args">(what)</span>
 618                                         <span class="method-click-advice">click to toggle source</span>
 619
 620                                 </div>
 621
 622                                 <div class="method-description">
 623
 624                                         <p class="missing-docs">(Not documented)</p>
 625
 626
 627
 628                                         <div class="method-source-code"
 629                                                 id="ddl-validate-source">
 630 <pre>
 631     <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 46</span>
 632 46:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ddl_validate</span>(<span class="ruby-identifier">what</span>)
 633 47:         <span class="ruby-constant">Data</span>.<span class="ruby-identifier">ddl_validate</span>(<span class="ruby-ivar">@ddl</span>, <span class="ruby-identifier">what</span>)
 634 48:       <span class="ruby-keyword kw">end</span></pre>
 635                                         </div>
 636
 637                                 </div>
 638
 639
 640                         </div>
 641
 642
 643                         <div id="lookup-method" class="method-detail ">
 644                                 <a name="M000186"></a>
 645
 646                                 <div class="method-heading">
 647
 648                                         <span class="method-name">lookup</span><span
 649                                                 class="method-args">(what)</span>
 650                                         <span class="method-click-advice">click to toggle source</span>
 651
 652                                 </div>
 653
 654                                 <div class="method-description">
 655
 656                                         <p class="missing-docs">(Not documented)</p>
 657
 658
 659
 660                                         <div class="method-source-code"
 661                                                 id="lookup-source">
 662 <pre>
 663     <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 22</span>
 664 22:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lookup</span>(<span class="ruby-identifier">what</span>)
 665 23:         <span class="ruby-identifier">ddl_validate</span>(<span class="ruby-identifier">what</span>)
 666 24:
 667 25:         <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">&quot;Doing data query %s for '%s'&quot;</span> <span class="ruby-operator">%</span> [ <span class="ruby-ivar">@name</span>, <span class="ruby-identifier">what</span> ])
 668 26:
 669 27:         <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-identifier">timeout</span>(<span class="ruby-ivar">@timeout</span>) <span class="ruby-keyword kw">do</span>
 670 28:           <span class="ruby-identifier">query_data</span>(<span class="ruby-identifier">what</span>)
 671 29:         <span class="ruby-keyword kw">end</span>
 672 30:
 673 31:         <span class="ruby-ivar">@result</span>
 674 32:       <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>
 675 33:         <span class="ruby-comment cmt"># Timeout::Error is a inherited from Interrupt which seems a really</span>
 676 34:         <span class="ruby-comment cmt"># strange choice, making it an equivelant of ^C and such.  Catch it</span>
 677 35:         <span class="ruby-comment cmt"># and raise something less critical that will not the runner to just</span>
 678 36:         <span class="ruby-comment cmt"># give up the ghost</span>
 679 37:         <span class="ruby-identifier">msg</span> = <span class="ruby-value str">&quot;Data plugin %s timed out on query '%s'&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@name</span>, <span class="ruby-identifier">what</span>]
 680 38:         <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">msg</span>)
 681 39:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">MsgTTLExpired</span>, <span class="ruby-identifier">msg</span>
 682 40:       <span class="ruby-keyword kw">end</span></pre>
 683                                         </div>
 684
 685                                 </div>
 686
 687
 688                         </div>
 689
 690
 691                         <div id="startup-hook-method" class="method-detail ">
 692                                 <a name="M000197"></a>
 693
 694                                 <div class="method-heading">
 695
 696                                         <span class="method-name">startup_hook</span><span
 697                                                 class="method-args">()</span>
 698                                         <span class="method-click-advice">click to toggle source</span>
 699
 700                                 </div>
 701
 702                                 <div class="method-description">
 703
 704                                         <p class="missing-docs">(Not documented)</p>
 705
 706
 707
 708                                         <div class="method-source-code"
 709                                                 id="startup-hook-source">
 710 <pre>
 711     <span class="ruby-comment cmt"># File lib/mcollective/data/base.rb, line 64</span>
 712 64:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">startup_hook</span>;<span class="ruby-keyword kw">end</span></pre>
 713                                         </div>
 714
 715                                 </div>
 716
 717
 718                         </div>
 719
 720
 721                 </div>
 722
 723
 724         </div>
 725
 726
 727         <div id="rdoc-debugging-section-dump" class="debugging-section">
 728
 729                 <p>Disabled; run with --debug to generate this.</p>
 730
 731         </div>
 732
 733         <div id="validator-badges">
 734                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 735                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 736                         Rdoc Generator</a> 1.1.6</small>.</p>
 737         </div>
 738
 739 </body>
 740 </html>
 741