doc/MCollective/Registration/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::Registration::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/registration/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  32                                                         class="thickbox" title="lib/mcollective/registration/base.rb">lib/mcollective/registration/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="#M000151">::inherited</a></li>
  63
  64                                         <li><a href="#M000153">#config</a></li>
  65
  66                                         <li><a href="#M000158">#interval</a></li>
  67
  68                                         <li><a href="#M000154">#msg_filter</a></li>
  69
  70                                         <li><a href="#M000159">#publish</a></li>
  71
  72                                         <li><a href="#M000152">#run</a></li>
  73
  74                                         <li><a href="#M000157">#target_collective</a></li>
  75
  76                                 </ul>
  77                         </div>
  78
  79
  80                         <!-- Included Modules -->
  81
  82                 </div>
  83
  84                 <div id="project-metadata">
  85
  86
  87                         <div id="fileindex-section" class="section project-section">
  88                                 <h3 class="section-header">Files</h3>
  89                                 <ul>
  90
  91                                         <li class="file"><a href="../../COPYING.html">COPYING</a></li>
  92
  93                                         <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
  94
  95                                         <li class="file"><a href="../../README.html">README</a></li>
  96
  97                                         <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
  98
  99                                         <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
 100
 101                                         <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
 102
 103                                         <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
 104
 105                                         <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
 106
 107                                         <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
 108
 109                                         <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
 110
 111                                         <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
 112
 113                                         <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
 114
 115                                         <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
 116
 117                                         <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
 118
 119                                         <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
 120
 121                                         <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
 122
 123                                         <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
 124
 125                                         <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
 126
 127                                         <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
 128
 129                                         <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
 130
 131                                 </ul>
 132                         </div>
 133
 134
 135                         <div id="classindex-section" class="section project-section">
 136                                 <h3 class="section-header">Class Index
 137                                         <span class="search-toggle"><img src="../../images/find.png"
 138                                                 height="16" width="16" alt="[+]"
 139                                                 title="show/hide quicksearch" /></span></h3>
 140                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
 141                                 <fieldset>
 142                                         <legend>Quicksearch</legend>
 143                                         <input type="text" name="quicksearch" value=""
 144                                                 class="quicksearch-field" />
 145                                 </fieldset>
 146                                 </form>
 147
 148                                 <ul class="link-list">
 149
 150                                         <li><a href="../../MCollective.html">MCollective</a></li>
 151
 152                                         <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
 153
 154                                         <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
 155
 156                                         <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
 157
 158                                         <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
 159
 160                                         <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
 161
 162                                         <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
 163
 164                                         <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
 165
 166                                         <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
 167
 168                                         <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
 169
 170                                         <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
 171
 172                                         <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
 173
 174                                         <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
 175
 176                                         <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
 177
 178                                         <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
 179
 180                                         <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
 181
 182                                         <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
 183
 184                                         <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
 185
 186                                         <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
 187
 188                                         <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
 189
 190                                         <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
 191
 192                                         <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
 193
 194                                         <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
 195
 196                                         <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
 197
 198                                         <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
 199
 200                                         <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
 201
 202                                         <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
 203
 204                                         <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
 205
 206                                         <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
 207
 208                                         <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
 209
 210                                         <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
 211
 212                                         <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
 213
 214                                         <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
 215
 216                                         <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
 217
 218                                         <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
 219
 220                                         <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
 221
 222                                         <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
 223
 224                                         <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
 225
 226                                         <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
 227
 228                                         <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
 229
 230                                         <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
 231
 232                                         <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
 233
 234                                         <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
 235
 236                                         <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
 237
 238                                         <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
 239
 240                                         <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
 241
 242                                         <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
 243
 244                                         <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
 245
 246                                         <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
 247
 248                                         <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
 249
 250                                         <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
 251
 252                                         <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
 253
 254                                         <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
 255
 256                                         <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
 257
 258                                         <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
 259
 260                                         <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
 261
 262                                         <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
 263
 264                                         <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
 265
 266                                         <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
 267
 268                                         <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
 269
 270                                         <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
 271
 272                                         <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
 273
 274                                         <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
 275
 276                                         <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
 277
 278                                         <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
 279
 280                                         <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
 281
 282                                         <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
 283
 284                                         <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
 285
 286                                         <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
 287
 288                                         <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
 289
 290                                         <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
 291
 292                                         <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
 293
 294                                         <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
 295
 296                                         <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
 297
 298                                         <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
 299
 300                                         <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
 301
 302                                         <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
 303
 304                                         <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
 305
 306                                         <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
 307
 308                                         <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
 309
 310                                         <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
 311
 312                                         <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
 313
 314                                         <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
 315
 316                                         <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
 317
 318                                         <li><a href="../../Array.html">Array</a></li>
 319
 320                                         <li><a href="../../Dir.html">Dir</a></li>
 321
 322                                         <li><a href="../../Object.html">Object</a></li>
 323
 324                                         <li><a href="../../String.html">String</a></li>
 325
 326                                         <li><a href="../../Symbol.html">Symbol</a></li>
 327
 328                                 </ul>
 329                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 330                         </div>
 331
 332
 333                 </div>
 334         </div>
 335
 336         <div id="documentation">
 337                 <h1 class="class">MCollective::Registration::Base</h1>
 338
 339                 <div id="description">
 340                         <p>
 341 This is a base class that other registration plugins can use to handle
 342 regular announcements to the mcollective
 343 </p>
 344 <p>
 345 The configuration file determines how often registration messages gets sent
 346 using the <em>registerinterval</em> option, the plugin runs in the
 347 background in a thread.
 348 </p>
 349
 350                 </div>
 351
 352                 <!-- Constants -->
 353
 354
 355                 <!-- Attributes -->
 356
 357
 358                 <!-- Methods -->
 359
 360                 <div id="public-class-method-details" class="method-section section">
 361                         <h3 class="section-header">Public Class Methods</h3>
 362
 363
 364                         <div id="inherited-method" class="method-detail ">
 365                                 <a name="M000151"></a>
 366
 367                                 <div class="method-heading">
 368
 369                                         <span class="method-name">inherited</span><span
 370                                                 class="method-args">(klass)</span>
 371                                         <span class="method-click-advice">click to toggle source</span>
 372
 373                                 </div>
 374
 375                                 <div class="method-description">
 376
 377                                         <p>
 378 Register plugins that inherits base
 379 </p>
 380
 381
 382
 383                                         <div class="method-source-code"
 384                                                 id="inherited-source">
 385 <pre>
 386     <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 11</span>
 387 11:       <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>)
 388 12:         <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-value str">&quot;registration_plugin&quot;</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>}
 389 13:       <span class="ruby-keyword kw">end</span></pre>
 390                                         </div>
 391
 392                                 </div>
 393
 394
 395                         </div>
 396
 397
 398                 </div>
 399
 400                 <div id="public-instance-method-details" class="method-section section">
 401                         <h3 class="section-header">Public Instance Methods</h3>
 402
 403
 404                         <div id="config-method" class="method-detail ">
 405                                 <a name="M000153"></a>
 406
 407                                 <div class="method-heading">
 408
 409                                         <span class="method-name">config</span><span
 410                                                 class="method-args">()</span>
 411                                         <span class="method-click-advice">click to toggle source</span>
 412
 413                                 </div>
 414
 415                                 <div class="method-description">
 416
 417                                         <p class="missing-docs">(Not documented)</p>
 418
 419
 420
 421                                         <div class="method-source-code"
 422                                                 id="config-source">
 423 <pre>
 424     <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 36</span>
 425 36:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">config</span>
 426 37:         <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
 427 38:       <span class="ruby-keyword kw">end</span></pre>
 428                                         </div>
 429
 430                                 </div>
 431
 432
 433                         </div>
 434
 435
 436                         <div id="interval-method" class="method-detail ">
 437                                 <a name="M000158"></a>
 438
 439                                 <div class="method-heading">
 440
 441                                         <span class="method-name">interval</span><span
 442                                                 class="method-args">()</span>
 443                                         <span class="method-click-advice">click to toggle source</span>
 444
 445                                 </div>
 446
 447                                 <div class="method-description">
 448
 449                                         <p class="missing-docs">(Not documented)</p>
 450
 451
 452
 453                                         <div class="method-source-code"
 454                                                 id="interval-source">
 455 <pre>
 456     <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 59</span>
 457 59:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">interval</span>
 458 60:         <span class="ruby-identifier">config</span>.<span class="ruby-identifier">registerinterval</span>
 459 61:       <span class="ruby-keyword kw">end</span></pre>
 460                                         </div>
 461
 462                                 </div>
 463
 464
 465                         </div>
 466
 467
 468                         <div id="msg-filter-method" class="method-detail ">
 469                                 <a name="M000154"></a>
 470
 471                                 <div class="method-heading">
 472
 473                                         <span class="method-name">msg_filter</span><span
 474                                                 class="method-args">()</span>
 475                                         <span class="method-click-advice">click to toggle source</span>
 476
 477                                 </div>
 478
 479                                 <div class="method-description">
 480
 481                                         <p class="missing-docs">(Not documented)</p>
 482
 483
 484
 485                                         <div class="method-source-code"
 486                                                 id="msg-filter-source">
 487 <pre>
 488     <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 40</span>
 489 40:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">msg_filter</span>
 490 41:         <span class="ruby-identifier">filter</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">empty_filter</span>
 491 42:         <span class="ruby-identifier">filter</span>[<span class="ruby-value str">&quot;agent&quot;</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;registration&quot;</span>
 492 43:         <span class="ruby-identifier">filter</span>
 493 44:       <span class="ruby-keyword kw">end</span></pre>
 494                                         </div>
 495
 496                                 </div>
 497
 498
 499                         </div>
 500
 501
 502                         <div id="publish-method" class="method-detail ">
 503                                 <a name="M000159"></a>
 504
 505                                 <div class="method-heading">
 506
 507                                         <span class="method-name">publish</span><span
 508                                                 class="method-args">(message)</span>
 509                                         <span class="method-click-advice">click to toggle source</span>
 510
 511                                 </div>
 512
 513                                 <div class="method-description">
 514
 515                                         <p class="missing-docs">(Not documented)</p>
 516
 517
 518
 519                                         <div class="method-source-code"
 520                                                 id="publish-source">
 521 <pre>
 522     <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 63</span>
 523 63:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">publish</span>(<span class="ruby-identifier">message</span>)
 524 64:         <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">message</span>
 525 65:           <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">&quot;Skipping registration due to nil body&quot;</span>)
 526 66:         <span class="ruby-keyword kw">else</span>
 527 67:           <span class="ruby-identifier">req</span> = <span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">message</span>, <span class="ruby-keyword kw">nil</span>, {<span class="ruby-identifier">:type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:request</span>, <span class="ruby-identifier">:agent</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;registration&quot;</span>, <span class="ruby-identifier">:collective</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">target_collective</span>, <span class="ruby-identifier">:filter</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">msg_filter</span>})
 528 68:           <span class="ruby-identifier">req</span>.<span class="ruby-identifier">encode!</span>
 529 69:
 530 70:           <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">&quot;Sending registration #{req.requestid} to collective #{req.collective}&quot;</span>)
 531 71:
 532 72:           <span class="ruby-identifier">req</span>.<span class="ruby-identifier">publish</span>
 533 73:         <span class="ruby-keyword kw">end</span>
 534 74:       <span class="ruby-keyword kw">end</span></pre>
 535                                         </div>
 536
 537                                 </div>
 538
 539
 540                         </div>
 541
 542
 543                         <div id="run-method" class="method-detail ">
 544                                 <a name="M000152"></a>
 545
 546                                 <div class="method-heading">
 547
 548                                         <span class="method-name">run</span><span
 549                                                 class="method-args">(connection)</span>
 550                                         <span class="method-click-advice">click to toggle source</span>
 551
 552                                 </div>
 553
 554                                 <div class="method-description">
 555
 556                                         <p>
 557 Creates a background thread that periodically send a registration notice.
 558 </p>
 559 <p>
 560 The actual registration notices comes from the &#8216;body&#8217; method of
 561 the registration plugins.
 562 </p>
 563
 564
 565
 566                                         <div class="method-source-code"
 567                                                 id="run-source">
 568 <pre>
 569     <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 19</span>
 570 19:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>(<span class="ruby-identifier">connection</span>)
 571 20:         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">interval</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
 572 21:
 573 22:         <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span>
 574 23:           <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
 575 24:             <span class="ruby-keyword kw">begin</span>
 576 25:               <span class="ruby-identifier">publish</span>(<span class="ruby-identifier">body</span>)
 577 26:
 578 27:               <span class="ruby-identifier">sleep</span> <span class="ruby-identifier">interval</span>
 579 28:             <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
 580 29:               <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">&quot;Sending registration message failed: #{e}&quot;</span>)
 581 30:               <span class="ruby-identifier">sleep</span> <span class="ruby-identifier">interval</span>
 582 31:             <span class="ruby-keyword kw">end</span>
 583 32:           <span class="ruby-keyword kw">end</span>
 584 33:         <span class="ruby-keyword kw">end</span>
 585 34:       <span class="ruby-keyword kw">end</span></pre>
 586                                         </div>
 587
 588                                 </div>
 589
 590
 591                         </div>
 592
 593
 594                         <div id="target-collective-method" class="method-detail ">
 595                                 <a name="M000157"></a>
 596
 597                                 <div class="method-heading">
 598
 599                                         <span class="method-name">target_collective</span><span
 600                                                 class="method-args">()</span>
 601                                         <span class="method-click-advice">click to toggle source</span>
 602
 603                                 </div>
 604
 605                                 <div class="method-description">
 606
 607                                         <p class="missing-docs">(Not documented)</p>
 608
 609
 610
 611                                         <div class="method-source-code"
 612                                                 id="target-collective-source">
 613 <pre>
 614     <span class="ruby-comment cmt"># File lib/mcollective/registration/base.rb, line 46</span>
 615 46:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">target_collective</span>
 616 47:         <span class="ruby-identifier">main_collective</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">main_collective</span>
 617 48:
 618 49:         <span class="ruby-identifier">collective</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">registration_collective</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">main_collective</span>
 619 50:
 620 51:         <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">collectives</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">collective</span>)
 621 52:           <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">&quot;Sending registration to #{main_collective}: #{collective} is not a valid collective&quot;</span>)
 622 53:           <span class="ruby-identifier">collective</span> = <span class="ruby-identifier">main_collective</span>
 623 54:         <span class="ruby-keyword kw">end</span>
 624 55:
 625 56:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">collective</span>
 626 57:       <span class="ruby-keyword kw">end</span></pre>
 627                                         </div>
 628
 629                                 </div>
 630
 631
 632                         </div>
 633
 634
 635                 </div>
 636
 637
 638         </div>
 639
 640
 641         <div id="rdoc-debugging-section-dump" class="debugging-section">
 642
 643                 <p>Disabled; run with --debug to generate this.</p>
 644
 645         </div>
 646
 647         <div id="validator-badges">
 648                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 649                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 650                         Rdoc Generator</a> 1.1.6</small>.</p>
 651         </div>
 652
 653 </body>
 654 </html>
 655