doc/MCollective/RPC/Reply.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::RPC::Reply</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/rpc/reply_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  32                                                         class="thickbox" title="lib/mcollective/rpc/reply.rb">lib/mcollective/rpc/reply.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="#M000383">::new</a></li>
  63
  64                                         <li><a href="#M000388">#[]</a></li>
  65
  66                                         <li><a href="#M000387">#[]=</a></li>
  67
  68                                         <li><a href="#M000385">#fail</a></li>
  69
  70                                         <li><a href="#M000386">#fail!</a></li>
  71
  72                                         <li><a href="#M000389">#fetch</a></li>
  73
  74                                         <li><a href="#M000384">#initialize_data</a></li>
  75
  76                                         <li><a href="#M000390">#to_hash</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::RPC::Reply</h1>
 340
 341                 <div id="description">
 342                         <p>
 343 Simple class to manage compliant replies to <a
 344 href="../RPC.html">MCollective::RPC</a>
 345 </p>
 346
 347                 </div>
 348
 349                 <!-- Constants -->
 350
 351
 352                 <!-- Attributes -->
 353
 354                 <div id="attribute-method-details" class="method-section section">
 355                         <h3 class="section-header">Attributes</h3>
 356
 357
 358                         <div id="statuscode-attribute-method" class="method-detail">
 359                                 <a name="statuscode"></a>
 360
 361                                 <a name="statuscode="></a>
 362
 363                                 <div class="method-heading attribute-method-heading">
 364                                         <span class="method-name">statuscode</span><span
 365                                                 class="attribute-access-type">[RW]</span>
 366                                 </div>
 367
 368                                 <div class="method-description">
 369
 370                                 <p class="missing-docs">(Not documented)</p>
 371
 372                                 </div>
 373                         </div>
 374
 375                         <div id="statusmsg-attribute-method" class="method-detail">
 376                                 <a name="statusmsg"></a>
 377
 378                                 <a name="statusmsg="></a>
 379
 380                                 <div class="method-heading attribute-method-heading">
 381                                         <span class="method-name">statusmsg</span><span
 382                                                 class="attribute-access-type">[RW]</span>
 383                                 </div>
 384
 385                                 <div class="method-description">
 386
 387                                 <p class="missing-docs">(Not documented)</p>
 388
 389                                 </div>
 390                         </div>
 391
 392                         <div id="data-attribute-method" class="method-detail">
 393                                 <a name="data"></a>
 394
 395                                 <a name="data="></a>
 396
 397                                 <div class="method-heading attribute-method-heading">
 398                                         <span class="method-name">data</span><span
 399                                                 class="attribute-access-type">[RW]</span>
 400                                 </div>
 401
 402                                 <div class="method-description">
 403
 404                                 <p class="missing-docs">(Not documented)</p>
 405
 406                                 </div>
 407                         </div>
 408
 409                 </div>
 410
 411
 412                 <!-- Methods -->
 413
 414                 <div id="public-class-method-details" class="method-section section">
 415                         <h3 class="section-header">Public Class Methods</h3>
 416
 417
 418                         <div id="new-method" class="method-detail ">
 419                                 <a name="M000383"></a>
 420
 421                                 <div class="method-heading">
 422
 423                                         <span class="method-name">new</span><span
 424                                                 class="method-args">(action, ddl)</span>
 425                                         <span class="method-click-advice">click to toggle source</span>
 426
 427                                 </div>
 428
 429                                 <div class="method-description">
 430
 431                                         <p class="missing-docs">(Not documented)</p>
 432
 433
 434
 435                                         <div class="method-source-code"
 436                                                 id="new-source">
 437 <pre>
 438     <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 7</span>
 439  7:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">ddl</span>)
 440  8:         <span class="ruby-ivar">@data</span> = {}
 441  9:         <span class="ruby-ivar">@statuscode</span> = <span class="ruby-value">0</span>
 442 10:         <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-value str">&quot;OK&quot;</span>
 443 11:         <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">ddl</span>
 444 12:         <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
 445 13:
 446 14:         <span class="ruby-keyword kw">begin</span>
 447 15:           <span class="ruby-identifier">initialize_data</span>
 448 16:         <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>
 449 17:           <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-value str">&quot;Could not pre-populate reply data from the DDL: %s: %s&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span> ])
 450 18:         <span class="ruby-keyword kw">end</span>
 451 19:       <span class="ruby-keyword kw">end</span></pre>
 452                                         </div>
 453
 454                                 </div>
 455
 456
 457                         </div>
 458
 459
 460                 </div>
 461
 462                 <div id="public-instance-method-details" class="method-section section">
 463                         <h3 class="section-header">Public Instance Methods</h3>
 464
 465
 466                         <div id="--method" class="method-detail ">
 467                                 <a name="M000388"></a>
 468
 469                                 <div class="method-heading">
 470
 471                                         <span class="method-name">[]</span><span
 472                                                 class="method-args">(key)</span>
 473                                         <span class="method-click-advice">click to toggle source</span>
 474
 475                                 </div>
 476
 477                                 <div class="method-description">
 478
 479                                         <p>
 480 Read from the data hash
 481 </p>
 482
 483
 484
 485                                         <div class="method-source-code"
 486                                                 id="--source">
 487 <pre>
 488     <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 70</span>
 489 70:       <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
 490 71:         <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>]
 491 72:       <span class="ruby-keyword kw">end</span></pre>
 492                                         </div>
 493
 494                                 </div>
 495
 496
 497                         </div>
 498
 499
 500                         <div id="--method" class="method-detail ">
 501                                 <a name="M000387"></a>
 502
 503                                 <div class="method-heading">
 504
 505                                         <span class="method-name">[]=</span><span
 506                                                 class="method-args">(key, val)</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 Write to the data hash
 515 </p>
 516
 517
 518
 519                                         <div class="method-source-code"
 520                                                 id="--source">
 521 <pre>
 522     <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 65</span>
 523 65:       <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span>)
 524 66:         <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">val</span>
 525 67:       <span class="ruby-keyword kw">end</span></pre>
 526                                         </div>
 527
 528                                 </div>
 529
 530
 531                         </div>
 532
 533
 534                         <div id="fail-method" class="method-detail ">
 535                                 <a name="M000385"></a>
 536
 537                                 <div class="method-heading">
 538
 539                                         <span class="method-name">fail</span><span
 540                                                 class="method-args">(msg, code=1)</span>
 541                                         <span class="method-click-advice">click to toggle source</span>
 542
 543                                 </div>
 544
 545                                 <div class="method-description">
 546
 547                                         <p>
 548 Helper to fill in statusmsg and code on failure
 549 </p>
 550
 551
 552
 553                                         <div class="method-source-code"
 554                                                 id="fail-source">
 555 <pre>
 556     <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 36</span>
 557 36:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fail</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">code</span>=<span class="ruby-value">1</span>)
 558 37:         <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-identifier">msg</span>
 559 38:         <span class="ruby-ivar">@statuscode</span> = <span class="ruby-identifier">code</span>
 560 39:       <span class="ruby-keyword kw">end</span></pre>
 561                                         </div>
 562
 563                                 </div>
 564
 565
 566                         </div>
 567
 568
 569                         <div id="fail--method" class="method-detail ">
 570                                 <a name="M000386"></a>
 571
 572                                 <div class="method-heading">
 573
 574                                         <span class="method-name">fail!</span><span
 575                                                 class="method-args">(msg, code=1)</span>
 576                                         <span class="method-click-advice">click to toggle source</span>
 577
 578                                 </div>
 579
 580                                 <div class="method-description">
 581
 582                                         <p>
 583 Helper that fills in statusmsg and code but also raises an appropriate
 584 error
 585 </p>
 586
 587
 588
 589                                         <div class="method-source-code"
 590                                                 id="fail--source">
 591 <pre>
 592     <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 42</span>
 593 42:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fail!</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">code</span>=<span class="ruby-value">1</span>)
 594 43:         <span class="ruby-ivar">@statusmsg</span> = <span class="ruby-identifier">msg</span>
 595 44:         <span class="ruby-ivar">@statuscode</span> = <span class="ruby-identifier">code</span>
 596 45:
 597 46:         <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">code</span>
 598 47:           <span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span>
 599 48:             <span class="ruby-identifier">raise</span> <span class="ruby-constant">RPCAborted</span>, <span class="ruby-identifier">msg</span>
 600 49:
 601 50:           <span class="ruby-keyword kw">when</span> <span class="ruby-value">2</span>
 602 51:             <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownRPCAction</span>, <span class="ruby-identifier">msg</span>
 603 52:
 604 53:           <span class="ruby-keyword kw">when</span> <span class="ruby-value">3</span>
 605 54:             <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingRPCData</span>, <span class="ruby-identifier">msg</span>
 606 55:
 607 56:           <span class="ruby-keyword kw">when</span> <span class="ruby-value">4</span>
 608 57:             <span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidRPCData</span>, <span class="ruby-identifier">msg</span>
 609 58:
 610 59:           <span class="ruby-keyword kw">else</span>
 611 60:             <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnknownRPCError</span>, <span class="ruby-identifier">msg</span>
 612 61:         <span class="ruby-keyword kw">end</span>
 613 62:       <span class="ruby-keyword kw">end</span></pre>
 614                                         </div>
 615
 616                                 </div>
 617
 618
 619                         </div>
 620
 621
 622                         <div id="fetch-method" class="method-detail ">
 623                                 <a name="M000389"></a>
 624
 625                                 <div class="method-heading">
 626
 627                                         <span class="method-name">fetch</span><span
 628                                                 class="method-args">(key, default)</span>
 629                                         <span class="method-click-advice">click to toggle source</span>
 630
 631                                 </div>
 632
 633                                 <div class="method-description">
 634
 635                                         <p class="missing-docs">(Not documented)</p>
 636
 637
 638
 639                                         <div class="method-source-code"
 640                                                 id="fetch-source">
 641 <pre>
 642     <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 74</span>
 643 74:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
 644 75:         <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">default</span>)
 645 76:       <span class="ruby-keyword kw">end</span></pre>
 646                                         </div>
 647
 648                                 </div>
 649
 650
 651                         </div>
 652
 653
 654                         <div id="initialize-data-method" class="method-detail ">
 655                                 <a name="M000384"></a>
 656
 657                                 <div class="method-heading">
 658
 659                                         <span class="method-name">initialize_data</span><span
 660                                                 class="method-args">()</span>
 661                                         <span class="method-click-advice">click to toggle source</span>
 662
 663                                 </div>
 664
 665                                 <div class="method-description">
 666
 667                                         <p class="missing-docs">(Not documented)</p>
 668
 669
 670
 671                                         <div class="method-source-code"
 672                                                 id="initialize-data-source">
 673 <pre>
 674     <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 21</span>
 675 21:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize_data</span>
 676 22:         <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">actions</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@action</span>)
 677 23:           <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;No action '%s' defined for agent '%s' in the DDL&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-ivar">@action</span>, <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">pluginname</span>]
 678 24:         <span class="ruby-keyword kw">end</span>
 679 25:
 680 26:         <span class="ruby-identifier">interface</span> = <span class="ruby-ivar">@ddl</span>.<span class="ruby-identifier">action_interface</span>(<span class="ruby-ivar">@action</span>)
 681 27:
 682 28:         <span class="ruby-identifier">interface</span>[<span class="ruby-identifier">:output</span>].<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span><span class="ruby-operator">|</span>
 683 29:           <span class="ruby-comment cmt"># must deep clone this data to avoid accidental updates of the DDL in cases where the</span>
 684 30:           <span class="ruby-comment cmt"># default is for example a string and someone does &lt;&lt; on it</span>
 685 31:           <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">output</span>] = <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">interface</span>[<span class="ruby-identifier">:output</span>][<span class="ruby-identifier">output</span>].<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:default</span>, <span class="ruby-keyword kw">nil</span>)))
 686 32:         <span class="ruby-keyword kw">end</span>
 687 33:       <span class="ruby-keyword kw">end</span></pre>
 688                                         </div>
 689
 690                                 </div>
 691
 692
 693                         </div>
 694
 695
 696                         <div id="to-hash-method" class="method-detail ">
 697                                 <a name="M000390"></a>
 698
 699                                 <div class="method-heading">
 700
 701                                         <span class="method-name">to_hash</span><span
 702                                                 class="method-args">()</span>
 703                                         <span class="method-click-advice">click to toggle source</span>
 704
 705                                 </div>
 706
 707                                 <div class="method-description">
 708
 709                                         <p>
 710 Returns a compliant Hash of the reply that should be sent over the
 711 middleware
 712 </p>
 713
 714
 715
 716                                         <div class="method-source-code"
 717                                                 id="to-hash-source">
 718 <pre>
 719     <span class="ruby-comment cmt"># File lib/mcollective/rpc/reply.rb, line 80</span>
 720 80:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
 721 81:         <span class="ruby-keyword kw">return</span> {<span class="ruby-identifier">:statuscode</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@statuscode</span>,
 722 82:                 <span class="ruby-identifier">:statusmsg</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@statusmsg</span>,
 723 83:                 <span class="ruby-identifier">:data</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@data</span>}
 724 84:       <span class="ruby-keyword kw">end</span></pre>
 725                                         </div>
 726
 727                                 </div>
 728
 729
 730                         </div>
 731
 732
 733                 </div>
 734
 735
 736         </div>
 737
 738
 739         <div id="rdoc-debugging-section-dump" class="debugging-section">
 740
 741                 <p>Disabled; run with --debug to generate this.</p>
 742
 743         </div>
 744
 745         <div id="validator-badges">
 746                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 747                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 748                         Rdoc Generator</a> 1.1.6</small>.</p>
 749         </div>
 750
 751 </body>
 752 </html>
 753