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">
6 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8 <title>Class: MCollective::CodedError</title>
10 <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
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>
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">
31 <li><a href="../lib/mcollective/exception_rb.html?TB_iframe=true&height=550&width=785"
32 class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.rb</a></li>
41 <div id="class-metadata">
45 <div id="parent-class-section" class="section">
46 <h3 class="section-header">Parent</h3>
48 <p class="link">RuntimeError</p>
53 <!-- Namespace Contents -->
56 <!-- Method Quickref -->
58 <div id="method-list-section" class="section">
59 <h3 class="section-header">Methods</h3>
60 <ul class="link-list">
62 <li><a href="#M000506">::new</a></li>
64 <li><a href="#M000508">#log</a></li>
66 <li><a href="#M000507">#set_backtrace</a></li>
72 <!-- Included Modules -->
76 <div id="project-metadata">
79 <div id="fileindex-section" class="section project-section">
80 <h3 class="section-header">Files</h3>
83 <li class="file"><a href="../COPYING.html">COPYING</a></li>
85 <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
87 <li class="file"><a href="../README.html">README</a></li>
89 <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
91 <li class="file"><a href="../etc/client_cfg_dist.html">client.cfg.dist</a></li>
93 <li class="file"><a href="../etc/data-help_erb.html">data-help.erb</a></li>
95 <li class="file"><a href="../etc/discovery-help_erb.html">discovery-help.erb</a></li>
97 <li class="file"><a href="../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
99 <li class="file"><a href="../etc/metadata-help_erb.html">metadata-help.erb</a></li>
101 <li class="file"><a href="../etc/msg-help_erb.html">msg-help.erb</a></li>
103 <li class="file"><a href="../etc/rpc-help_erb.html">rpc-help.erb</a></li>
105 <li class="file"><a href="../etc/server_cfg_dist.html">server.cfg.dist</a></li>
107 <li class="file"><a href="../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
109 <li class="file"><a href="../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
111 <li class="file"><a href="../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
113 <li class="file"><a href="../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
115 <li class="file"><a href="../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
117 <li class="file"><a href="../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
119 <li class="file"><a href="../lib/mcollective/locales/en_yml.html">en.yml</a></li>
121 <li class="file"><a href="../mcollective_init.html">mcollective.init</a></li>
127 <div id="classindex-section" class="section project-section">
128 <h3 class="section-header">Class Index
129 <span class="search-toggle"><img src="../images/find.png"
130 height="16" width="16" alt="[+]"
131 title="show/hide quicksearch" /></span></h3>
132 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
134 <legend>Quicksearch</legend>
135 <input type="text" name="quicksearch" value=""
136 class="quicksearch-field" />
140 <ul class="link-list">
142 <li><a href="../MCollective.html">MCollective</a></li>
144 <li><a href="../MCollective/Agent.html">MCollective::Agent</a></li>
146 <li><a href="../MCollective/Agents.html">MCollective::Agents</a></li>
148 <li><a href="../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
150 <li><a href="../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
152 <li><a href="../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
154 <li><a href="../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
156 <li><a href="../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
158 <li><a href="../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
160 <li><a href="../MCollective/Application.html">MCollective::Application</a></li>
162 <li><a href="../MCollective/Applications.html">MCollective::Applications</a></li>
164 <li><a href="../MCollective/Cache.html">MCollective::Cache</a></li>
166 <li><a href="../MCollective/Client.html">MCollective::Client</a></li>
168 <li><a href="../MCollective/CodedError.html">MCollective::CodedError</a></li>
170 <li><a href="../MCollective/Config.html">MCollective::Config</a></li>
172 <li><a href="../MCollective/Connector.html">MCollective::Connector</a></li>
174 <li><a href="../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
176 <li><a href="../MCollective/DDL.html">MCollective::DDL</a></li>
178 <li><a href="../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
180 <li><a href="../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
182 <li><a href="../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
184 <li><a href="../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
186 <li><a href="../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
188 <li><a href="../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
190 <li><a href="../MCollective/Data.html">MCollective::Data</a></li>
192 <li><a href="../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
194 <li><a href="../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
196 <li><a href="../MCollective/Discovery.html">MCollective::Discovery</a></li>
198 <li><a href="../MCollective/Facts.html">MCollective::Facts</a></li>
200 <li><a href="../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
202 <li><a href="../MCollective/Generators.html">MCollective::Generators</a></li>
204 <li><a href="../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
206 <li><a href="../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
208 <li><a href="../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
210 <li><a href="../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
212 <li><a href="../MCollective/Log.html">MCollective::Log</a></li>
214 <li><a href="../MCollective/Logger.html">MCollective::Logger</a></li>
216 <li><a href="../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
218 <li><a href="../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
220 <li><a href="../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
222 <li><a href="../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
224 <li><a href="../MCollective/Matcher.html">MCollective::Matcher</a></li>
226 <li><a href="../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
228 <li><a href="../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
230 <li><a href="../MCollective/Message.html">MCollective::Message</a></li>
232 <li><a href="../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
234 <li><a href="../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
236 <li><a href="../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
238 <li><a href="../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
240 <li><a href="../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
242 <li><a href="../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
244 <li><a href="../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
246 <li><a href="../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
248 <li><a href="../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
250 <li><a href="../MCollective/RPC.html">MCollective::RPC</a></li>
252 <li><a href="../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
254 <li><a href="../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
256 <li><a href="../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
258 <li><a href="../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
260 <li><a href="../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
262 <li><a href="../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
264 <li><a href="../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
266 <li><a href="../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
268 <li><a href="../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
270 <li><a href="../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
272 <li><a href="../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
274 <li><a href="../MCollective/RPCError.html">MCollective::RPCError</a></li>
276 <li><a href="../MCollective/Registration.html">MCollective::Registration</a></li>
278 <li><a href="../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
280 <li><a href="../MCollective/Runner.html">MCollective::Runner</a></li>
282 <li><a href="../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
284 <li><a href="../MCollective/SSL.html">MCollective::SSL</a></li>
286 <li><a href="../MCollective/Security.html">MCollective::Security</a></li>
288 <li><a href="../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
290 <li><a href="../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
292 <li><a href="../MCollective/Shell.html">MCollective::Shell</a></li>
294 <li><a href="../MCollective/Translatable.html">MCollective::Translatable</a></li>
296 <li><a href="../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
298 <li><a href="../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
300 <li><a href="../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
302 <li><a href="../MCollective/Util.html">MCollective::Util</a></li>
304 <li><a href="../MCollective/Validator.html">MCollective::Validator</a></li>
306 <li><a href="../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
308 <li><a href="../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
310 <li><a href="../Array.html">Array</a></li>
312 <li><a href="../Dir.html">Dir</a></li>
314 <li><a href="../Object.html">Object</a></li>
316 <li><a href="../String.html">String</a></li>
318 <li><a href="../Symbol.html">Symbol</a></li>
321 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
328 <div id="documentation">
329 <h1 class="class">MCollective::CodedError</h1>
331 <div id="description">
340 <div id="attribute-method-details" class="method-section section">
341 <h3 class="section-header">Attributes</h3>
344 <div id="code-attribute-method" class="method-detail">
347 <div class="method-heading attribute-method-heading">
348 <span class="method-name">code</span><span
349 class="attribute-access-type">[R]</span>
352 <div class="method-description">
354 <p class="missing-docs">(Not documented)</p>
359 <div id="args-attribute-method" class="method-detail">
362 <div class="method-heading attribute-method-heading">
363 <span class="method-name">args</span><span
364 class="attribute-access-type">[R]</span>
367 <div class="method-description">
369 <p class="missing-docs">(Not documented)</p>
374 <div id="log-level-attribute-method" class="method-detail">
375 <a name="log_level"></a>
377 <div class="method-heading attribute-method-heading">
378 <span class="method-name">log_level</span><span
379 class="attribute-access-type">[R]</span>
382 <div class="method-description">
384 <p class="missing-docs">(Not documented)</p>
389 <div id="default-attribute-method" class="method-detail">
390 <a name="default"></a>
392 <div class="method-heading attribute-method-heading">
393 <span class="method-name">default</span><span
394 class="attribute-access-type">[R]</span>
397 <div class="method-description">
399 <p class="missing-docs">(Not documented)</p>
409 <div id="public-class-method-details" class="method-section section">
410 <h3 class="section-header">Public Class Methods</h3>
413 <div id="new-method" class="method-detail ">
414 <a name="M000506"></a>
416 <div class="method-heading">
418 <span class="method-name">new</span><span
419 class="method-args">(msgid, default, level=:debug, args={})</span>
420 <span class="method-click-advice">click to toggle source</span>
424 <div class="method-description">
426 <p class="missing-docs">(Not documented)</p>
430 <div class="method-source-code"
433 <span class="ruby-comment cmt"># File lib/mcollective/exception.rb, line 5</span>
434 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>=<span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">args</span>={})
435 6: <span class="ruby-ivar">@code</span> = <span class="ruby-identifier">msgid</span>
436 7: <span class="ruby-ivar">@log_level</span> = <span class="ruby-identifier">level</span>
437 8: <span class="ruby-ivar">@args</span> = <span class="ruby-identifier">args</span>
438 9: <span class="ruby-ivar">@default</span> = <span class="ruby-identifier">default</span>
440 11: <span class="ruby-identifier">msg</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-ivar">@code</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-ivar">@args</span>))
442 13: <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">msg</span>)
443 14: <span class="ruby-keyword kw">end</span></pre>
454 <div id="public-instance-method-details" class="method-section section">
455 <h3 class="section-header">Public Instance Methods</h3>
458 <div id="log-method" class="method-detail ">
459 <a name="M000508"></a>
461 <div class="method-heading">
463 <span class="method-name">log</span><span
464 class="method-args">(level, log_backtrace=false)</span>
465 <span class="method-click-advice">click to toggle source</span>
469 <div class="method-description">
471 <p class="missing-docs">(Not documented)</p>
475 <div class="method-source-code"
478 <span class="ruby-comment cmt"># File lib/mcollective/exception.rb, line 21</span>
479 21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">log_backtrace</span>=<span class="ruby-keyword kw">false</span>)
480 22: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">logexception</span>(<span class="ruby-ivar">@code</span>, <span class="ruby-identifier">level</span>, <span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">log_backtrace</span>)
481 23: <span class="ruby-keyword kw">end</span></pre>
490 <div id="set-backtrace-method" class="method-detail ">
491 <a name="M000507"></a>
493 <div class="method-heading">
495 <span class="method-name">set_backtrace</span><span
496 class="method-args">(trace)</span>
497 <span class="method-click-advice">click to toggle source</span>
501 <div class="method-description">
503 <p class="missing-docs">(Not documented)</p>
507 <div class="method-source-code"
508 id="set-backtrace-source">
510 <span class="ruby-comment cmt"># File lib/mcollective/exception.rb, line 16</span>
511 16: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_backtrace</span>(<span class="ruby-identifier">trace</span>)
512 17: <span class="ruby-keyword kw">super</span>
513 18: <span class="ruby-identifier">log</span>(<span class="ruby-ivar">@log_level</span>)
514 19: <span class="ruby-keyword kw">end</span></pre>
529 <div id="rdoc-debugging-section-dump" class="debugging-section">
531 <p>Disabled; run with --debug to generate this.</p>
535 <div id="validator-badges">
536 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
537 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
538 Rdoc Generator</a> 1.1.6</small>.</p>