<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Exception: P4Error
— Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!P4Error.html";
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="_index.html">Index (P)</a> »
<span class="title">P4Error</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Exception: P4Error
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">RuntimeError</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">RuntimeError</li>
<li class="next">P4Error</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/p4_error.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Any error we get from the Perforce server is generally encapsulated in a
P4Error, which allows us to get some basic diagnostic information from the
Perforce server out to the user.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="HelixSync/LockFailed.html" title="HelixSync::LockFailed (class)">HelixSync::LockFailed</a></span>, <span class='object_link'><a href="HelixSync/SubmitFailed.html" title="HelixSync::SubmitFailed (class)">HelixSync::SubmitFailed</a></span></p>
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="ERROR_CODE_BASE-constant" class="">ERROR_CODE_BASE =
<div class="docstring">
<div class="discussion">
<p>All error codes must be greater than this number.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>15_360</span></pre></dd>
</dl>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#message_code-instance_method" title="#message_code (instance method)">- (Object) <strong>message_code</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Note: We use 15_361 for 'unhandled' ruby errors.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#message_severity-instance_method" title="#message_severity (instance method)">- (Object) <strong>message_severity</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Note: We use 15_361 for 'unhandled' ruby errors.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#message_text-instance_method" title="#message_text (instance method)">- (Object) <strong>message_text</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Note: We use 15_361 for 'unhandled' ruby errors.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#default_error-class_method" title="default_error (class method)">+ (Object) <strong>default_error</strong>(message_text) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Class method to create a valid P4Error object from a simple string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#error%3F-class_method" title="error? (class method)">+ (Boolean) <strong>error?</strong>(p4, severity: P4::E_FAILED) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns true if there's an error.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (P4Error) <strong>initialize</strong>(code, severity, text) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of P4Error.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#system_error%3F-instance_method" title="#system_error? (instance method)">- (Boolean) <strong>system_error?</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns true if the exception is truly a system problem.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user_error%3F-instance_method" title="#user_error? (instance method)">- (Boolean) <strong>user_error?</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns true if the exception should actually be considered a user error
instead of a system exception.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="P4Error (class)">P4Error</a></span></tt>) <strong>initialize</strong>(code, severity, text)
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of P4Error</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='id identifier rubyid_severity'>severity</span><span class='comma'>,</span> <span class='id identifier rubyid_text'>text</span><span class='rparen'>)</span>
<span class='ivar'>@message_code</span> <span class='op'>=</span> <span class='id identifier rubyid_code'>code</span>
<span class='ivar'>@message_severity</span> <span class='op'>=</span> <span class='id identifier rubyid_severity'>severity</span>
<span class='ivar'>@message_text</span> <span class='op'>=</span> <span class='id identifier rubyid_text'>text</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="message_code=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="message_code-instance_method">
- (<tt>Object</tt>) <strong>message_code</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Note: We use 15_361 for 'unhandled' ruby errors</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_message_code'>message_code</span>
<span class='ivar'>@message_code</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="message_severity=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="message_severity-instance_method">
- (<tt>Object</tt>) <strong>message_severity</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Note: We use 15_361 for 'unhandled' ruby errors</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_message_severity'>message_severity</span>
<span class='ivar'>@message_severity</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="message_text=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="message_text-instance_method">
- (<tt>Object</tt>) <strong>message_text</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Note: We use 15_361 for 'unhandled' ruby errors</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_message_text'>message_text</span>
<span class='ivar'>@message_text</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="default_error-class_method">
+ (<tt>Object</tt>) <strong>default_error</strong>(message_text)
</h3><div class="docstring">
<div class="discussion">
<p>Class method to create a valid P4Error object from a simple string. Used
when we get errors for which no P4::Message object is available.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
21
22
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 21</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_error'>default_error</span><span class='lparen'>(</span><span class='id identifier rubyid_message_text'>message_text</span><span class='rparen'>)</span>
<span class='const'>P4Error</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>ERROR_CODE_BASE</span><span class='comma'>,</span>
<span class='const'>P4</span><span class='op'>::</span><span class='const'>E_FAILED</span><span class='comma'>,</span>
<span class='id identifier rubyid_message_text'>message_text</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="error?-class_method">
+ (<tt>Boolean</tt>) <strong>error?</strong>(p4, severity: P4::E_FAILED)
</h3><div class="docstring">
<div class="discussion">
<p>Returns true if there's an error</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 28</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_error?'>error?</span><span class='lparen'>(</span><span class='id identifier rubyid_p4'>p4</span><span class='comma'>,</span> <span class='label'>severity:</span> <span class='const'>P4</span><span class='op'>::</span><span class='const'>E_FAILED</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_messages'>messages</span> <span class='op'>&&</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_messages'>messages</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_m'>m</span><span class='op'>|</span> <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_severity'>severity</span> <span class='op'>>=</span> <span class='id identifier rubyid_severity'>severity</span><span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="system_error?-instance_method">
- (<tt>Boolean</tt>) <strong>system_error?</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns true if the exception is truly a system problem.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_system_error?'>system_error?</span>
<span class='kw'>return</span> <span class='ivar'>@message_severity</span> <span class='op'>==</span> <span class='const'>P4</span><span class='op'>::</span><span class='const'>E_FATAL</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_s-instance_method">
- (<tt>Object</tt>) <strong>to_s</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
<span class='ivar'>@message_text</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="user_error?-instance_method">
- (<tt>Boolean</tt>) <strong>user_error?</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns true if the exception should actually be considered a user error
instead of a system exception.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 40</span>
<span class='kw'>def</span> <span class='id identifier rubyid_user_error?'>user_error?</span>
<span class='kw'>return</span> <span class='ivar'>@message_severity</span> <span class='op'>==</span> <span class='const'>P4</span><span class='op'>::</span><span class='const'>E_FAILED</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Oct 12 22:20:51 2015 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.3).
</div>
</body>
</html> | # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #11 | 16275 | Doug Scheirer | Merge from main | ||
| #10 | 16196 | Doug Scheirer | Merge from main | ||
| #9 | 16148 | Doug Scheirer | Merge from main | ||
| #8 | 16114 | Doug Scheirer | Merge from main | ||
| #7 | 16079 | Doug Scheirer | Merge from main | ||
| #6 | 16014 | Doug Scheirer | Merge down from main | ||
| #5 | 15884 | Doug Scheirer | Merge from main | ||
| #4 | 15868 | Doug Scheirer | Merge from main | ||
| #3 | 15845 | Doug Scheirer | Integ from main | ||
| #2 | 15715 | Doug Scheirer | merge changes from main | ||
| #1 | 15688 | Doug Scheirer |
Populate -o //guest/perforce_software/helix-web-services/... //guest/doug_scheirer/helix-web-services/.... |
||
| //guest/perforce_software/helix-web-services/main/build/doc/helix_web_services/P4Error.html | |||||
| #32 | 15676 | tjuricek | HWS/NOARCH/2015.1.main/201509092205 | ||
| #31 | 15589 | tjuricek | Update path to test output and update docs. | ||
| #30 | 15542 | tjuricek |
Add spaces to our basic 'component encode' mechanism, and use it for HVE project IDs. In general, this will make the HVE IDs a bit more readable. |
||
| #29 | 15517 | tjuricek | Do not require changelist ID for submitting Helix Sync pending changelists. | ||
| #28 | 15499 | tjuricek | Naive implementation of helix sync project submit for "helix versioning engine projects". | ||
| #27 | 15487 | tjuricek | Add basic ability to create pending changelists for helix sync projects. | ||
| #26 | 15479 | tjuricek | Added a basic "HVE project" implementation for creating clients. | ||
| #25 | 15447 | tjuricek |
Add simple Example application to list "projects" in a HVE instance. Qt's a little weird to follow, so I may have to find a different kind of example to write. It does work, however. |
||
| #24 | 15240 | tjuricek |
Set api level via request path on all Helix Versioning Engine methods. This will allow migration of applications to different P4D versions. Our internal methods (like project API) should attempt to handle backward compatibility similarly. P4WEBAPI-118 |
||
| #23 | 15228 | tjuricek | Revise triggers implementation, tests, and documentation. | ||
| #22 | 15227 | tjuricek |
Revise implementation, tests, and documentation for protections management. Remove some specs I will not be revising from the helix_web_services project. |
||
| #21 | 15225 | tjuricek |
Revise counter implementation, tests, and documentation Wasn't available in the Ruby client before, so, it's now available. |
||
| #20 | 15222 | tjuricek |
Revise server specs testing and documentation. Note: also fixed issues with setting P4PORT via headers. For whatever reason, the host setting doesn't seem to work like I expect it to, though P4PORT works just fine. |
||
| #19 | 15211 | tjuricek | Implement tests and documentation for label spec management. | ||
| #18 | 15210 | tjuricek | Implement tests and documentation for job spec management. | ||
| #17 | 15209 | tjuricek | Implement tests and documentation for group spec management. | ||
| #16 | 15208 | tjuricek |
Revise 'command' implementation, tests, and documentaiton. This includes a change from a command blacklist to a whitelist. See P4WEBAPI-21 |
||
| #15 | 15205 | tjuricek | Implemented tests and documentation for depot spec editing. | ||
| #14 | 15189 | tjuricek | Update files implementation, testing, and documentation. | ||
| #13 | 15185 | tjuricek | Update user spec management implementation, tests, and documentation. | ||
| #12 | 15144 | tjuricek |
Setup stream spec tests and documentation. Also revised the documentation folder http_p4_web_api -> helix_versioning_engine |
||
| #11 | 15132 | tjuricek | Provde a basic submit -e mechanism on classic perforce workspaces. | ||
| #10 | 15110 | tjuricek | Revise changes methods for new p4 connection handling, add server specs, remove model references in client, and update asciidoc documentation. | ||
| #9 | 15099 | tjuricek | Revise project services to be our simple 'container' for other systems. | ||
| #8 | 15098 | tjuricek |
Revised project services to GET-only forms. With Helix Sync revising to integrate purely with Helix Cloud, this is the only thing we can reasonably define. |
||
| #7 | 15090 | tjuricek |
Update _proposed_ API for project services. This is *very likely* to change, and will not be implemented until reviewed. |
||
| #6 | 15078 | tjuricek |
clients spec method revisions Updated some other documentation. |
||
| #5 | 15077 | tjuricek |
Add new 'model' technique, revised branch spec operations, test Auth::Middleware. The Ruby client now does *not* strictly type anything, but extends OpenStruct with helper methods to help deal with inconsistent data formats. See the OpenModel class documentation for more details. The Auth::Middleware class is also *finally* implemented as well. This does not take into account all possible variations of server behavior (yet), but that will happen in follow-up work. |
||
| #4 | 15073 | tjuricek | Update Auth::Middleware and add spec | ||
| #3 | 15053 | tjuricek |
Revise the client API to use the new login method. The current specs will need to be revised since data normalization is moving out of the server and into the client. |
||
| #2 | 15038 | tjuricek | Document 'login' auth method and client programming overview. | ||
| #1 | 15032 | tjuricek |
Starting config and doc revisions. System is now broken while revisions underway. Configuration of the p4d connection is now done via a single HWSSettings middleware object injected into the Rack env. The HWSP4Cleanup middleware now cleans up any p4 injected into the Rack env. The Auth::App class now mostly just contains one method to generate a p4 ticket. /auth/v1/login. Added yard documentation for the main project. Yard docs have been reconfigured to dump into build/ directories. This should probably be done with each release. Hm... The top level rake file contains a task, 'all:doc', to update our documentation. This should probably be run for each checkin. Hm... Specs are now using Rack::Test on top of a 'live' p4d. I'd suggest you still use the p4util mechanism, which now dumps to a /tmp folder, so we can safely add P4IGNORE rules back into your local .p4config file. Old 'perforce' application now called 'helix_versioning_engine'. Removing cache data. Helix Sync may be slow. It may also get axed. We'll see. |
||