<!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"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.9.1"/> <title>Helix Web Services Client: hws::RequestError Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { init_search(); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Helix Web Services Client  <span id="projectnumber">1</span> </div> <div id="projectbrief">Helix Web Services Client SDK for Qt Applications</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.9.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><b>hws</b></li><li class="navelem"><a class="el" href="classhws_1_1_request_error.html">RequestError</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-attribs">Static Public Attributes</a> | <a href="classhws_1_1_request_error-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">hws::RequestError Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Capture errors from different kinds of remote calls. <a href="classhws_1_1_request_error.html#details">More...</a></p> <p><code>#include <<a class="el" href="_request_error_8h_source.html">RequestError.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:afce591cfb45b53f3f3b3ef56684771b6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#afce591cfb45b53f3f3b3ef56684771b6">Severity</a> { <br />   <b>EMPTY</b> = 0, <b>INFO</b> = 1, <b>WARN</b> = 2, <b>ERROR</b> = 3, <br />   <b>FATAL</b> = 4 <br /> }</td></tr> <tr class="separator:afce591cfb45b53f3f3b3ef56684771b6"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a5ff33f349fde24705fd5ced9e2d151bb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ff33f349fde24705fd5ced9e2d151bb"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#a5ff33f349fde24705fd5ced9e2d151bb">RequestError</a> ()</td></tr> <tr class="memdesc:a5ff33f349fde24705fd5ced9e2d151bb"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new request status for a successful operation. <br /></td></tr> <tr class="separator:a5ff33f349fde24705fd5ced9e2d151bb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac0967d3e1be5f7f38cb62f8e87cf45e8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0967d3e1be5f7f38cb62f8e87cf45e8"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#ac0967d3e1be5f7f38cb62f8e87cf45e8">RequestError</a> (const QString &<a class="el" href="classhws_1_1_request_error.html#af45c034abd8aae8846f02ac36085bec5">messageText</a>, const QString &<a class="el" href="classhws_1_1_request_error.html#ae206b0e8d56322d78cf23d7eb2e9b74a">baseMessageText</a>, int <a class="el" href="classhws_1_1_request_error.html#a6669991b7ebe79fc808aa6f90db2def1">code</a>, short <a class="el" href="classhws_1_1_request_error.html#a55c402f9b68437ec8483b80954e4874d">severity</a>)</td></tr> <tr class="memdesc:ac0967d3e1be5f7f38cb62f8e87cf45e8"><td class="mdescLeft"> </td><td class="mdescRight">Create a request status from all fields of a failed request. <br /></td></tr> <tr class="separator:ac0967d3e1be5f7f38cb62f8e87cf45e8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a91c5a76203780ea29296e418964c0bbe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91c5a76203780ea29296e418964c0bbe"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#a91c5a76203780ea29296e418964c0bbe">RequestError</a> (const <a class="el" href="classhws_1_1_request_error.html">RequestError</a> &error)</td></tr> <tr class="memdesc:a91c5a76203780ea29296e418964c0bbe"><td class="mdescLeft"> </td><td class="mdescRight">Copy the request error. <br /></td></tr> <tr class="separator:a91c5a76203780ea29296e418964c0bbe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aec458dcc0e372dd6a574ad1244a7fabe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec458dcc0e372dd6a574ad1244a7fabe"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#aec458dcc0e372dd6a574ad1244a7fabe">~RequestError</a> ()</td></tr> <tr class="memdesc:aec458dcc0e372dd6a574ad1244a7fabe"><td class="mdescLeft"> </td><td class="mdescRight">Typical destructor. <br /></td></tr> <tr class="separator:aec458dcc0e372dd6a574ad1244a7fabe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3288bc3163fbbac58460b770f376c193"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3288bc3163fbbac58460b770f376c193"></a> <a class="el" href="classhws_1_1_request_error.html">RequestError</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#a3288bc3163fbbac58460b770f376c193">operator=</a> (const <a class="el" href="classhws_1_1_request_error.html">RequestError</a> &e)</td></tr> <tr class="memdesc:a3288bc3163fbbac58460b770f376c193"><td class="mdescLeft"> </td><td class="mdescRight">Copy state from an existing <a class="el" href="classhws_1_1_request_error.html" title="Capture errors from different kinds of remote calls. ">RequestError</a>. <br /></td></tr> <tr class="separator:a3288bc3163fbbac58460b770f376c193"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af45c034abd8aae8846f02ac36085bec5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af45c034abd8aae8846f02ac36085bec5"></a> const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#af45c034abd8aae8846f02ac36085bec5">messageText</a> () const </td></tr> <tr class="memdesc:af45c034abd8aae8846f02ac36085bec5"><td class="mdescLeft"> </td><td class="mdescRight">Possibly localized string coming from the server. <br /></td></tr> <tr class="separator:af45c034abd8aae8846f02ac36085bec5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac451bbad0e7c3f0061739608ce93d56d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac451bbad0e7c3f0061739608ce93d56d"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#ac451bbad0e7c3f0061739608ce93d56d">setMessageText</a> (const QString &t)</td></tr> <tr class="memdesc:ac451bbad0e7c3f0061739608ce93d56d"><td class="mdescLeft"> </td><td class="mdescRight">Set the localized string. <br /></td></tr> <tr class="separator:ac451bbad0e7c3f0061739608ce93d56d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae206b0e8d56322d78cf23d7eb2e9b74a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae206b0e8d56322d78cf23d7eb2e9b74a"></a> const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#ae206b0e8d56322d78cf23d7eb2e9b74a">baseMessageText</a> () const </td></tr> <tr class="memdesc:ae206b0e8d56322d78cf23d7eb2e9b74a"><td class="mdescLeft"> </td><td class="mdescRight">Underling message, suitable for logging. <br /></td></tr> <tr class="separator:ae206b0e8d56322d78cf23d7eb2e9b74a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2a0db5af48b8351ab6eceec22aa7341e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a0db5af48b8351ab6eceec22aa7341e"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#a2a0db5af48b8351ab6eceec22aa7341e">setBaseMessageText</a> (const QString &t)</td></tr> <tr class="memdesc:a2a0db5af48b8351ab6eceec22aa7341e"><td class="mdescLeft"> </td><td class="mdescRight">Underling message, suitable for logging. <br /></td></tr> <tr class="separator:a2a0db5af48b8351ab6eceec22aa7341e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6669991b7ebe79fc808aa6f90db2def1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6669991b7ebe79fc808aa6f90db2def1"></a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#a6669991b7ebe79fc808aa6f90db2def1">code</a> () const </td></tr> <tr class="memdesc:a6669991b7ebe79fc808aa6f90db2def1"><td class="mdescLeft"> </td><td class="mdescRight">See error code constants defined in <a class="el" href="_request_error_8h_source.html">RequestError.h</a>. <br /></td></tr> <tr class="separator:a6669991b7ebe79fc808aa6f90db2def1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a330db84e957c7ae11b90f0659e8fd800"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a330db84e957c7ae11b90f0659e8fd800"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#a330db84e957c7ae11b90f0659e8fd800">setCode</a> (int c)</td></tr> <tr class="memdesc:a330db84e957c7ae11b90f0659e8fd800"><td class="mdescLeft"> </td><td class="mdescRight">See error code constants defined in <a class="el" href="_request_error_8h_source.html">RequestError.h</a>. <br /></td></tr> <tr class="separator:a330db84e957c7ae11b90f0659e8fd800"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a55c402f9b68437ec8483b80954e4874d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55c402f9b68437ec8483b80954e4874d"></a> short </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#a55c402f9b68437ec8483b80954e4874d">severity</a> () const </td></tr> <tr class="memdesc:a55c402f9b68437ec8483b80954e4874d"><td class="mdescLeft"> </td><td class="mdescRight">Current severity, probably ERROR. <br /></td></tr> <tr class="separator:a55c402f9b68437ec8483b80954e4874d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1523cf6428f001dc9e2cee24288a4c51"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1523cf6428f001dc9e2cee24288a4c51"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#a1523cf6428f001dc9e2cee24288a4c51">setSeverity</a> (short s)</td></tr> <tr class="memdesc:a1523cf6428f001dc9e2cee24288a4c51"><td class="mdescLeft"> </td><td class="mdescRight">Set the severity. <br /></td></tr> <tr class="separator:a1523cf6428f001dc9e2cee24288a4c51"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> Static Public Attributes</h2></td></tr> <tr class="memitem:af4181ea5a067b892202c7ed2d48401da"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4181ea5a067b892202c7ed2d48401da"></a> static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#af4181ea5a067b892202c7ed2d48401da">NETWORK_ERROR</a> = 16000</td></tr> <tr class="memdesc:af4181ea5a067b892202c7ed2d48401da"><td class="mdescLeft"> </td><td class="mdescRight">A generic networking problem (flagged by Qt) <br /></td></tr> <tr class="separator:af4181ea5a067b892202c7ed2d48401da"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae5ee6a64d9f93e08ab06d9b316c206d7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae5ee6a64d9f93e08ab06d9b316c206d7"></a> static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#ae5ee6a64d9f93e08ab06d9b316c206d7">SSL_ERROR</a> = 16001</td></tr> <tr class="memdesc:ae5ee6a64d9f93e08ab06d9b316c206d7"><td class="mdescLeft"> </td><td class="mdescRight">A networking problem with SSL (flagged by Qt subsystem) <br /></td></tr> <tr class="separator:ae5ee6a64d9f93e08ab06d9b316c206d7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af17ca3059816097e20b88cd23e27ca90"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af17ca3059816097e20b88cd23e27ca90"></a> static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#af17ca3059816097e20b88cd23e27ca90">JSON_ERROR</a> = 16002</td></tr> <tr class="memdesc:af17ca3059816097e20b88cd23e27ca90"><td class="mdescLeft"> </td><td class="mdescRight">A problem parsing JSON. <br /></td></tr> <tr class="separator:af17ca3059816097e20b88cd23e27ca90"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a15a346ad7e43c6893bd05ccd09b632c0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15a346ad7e43c6893bd05ccd09b632c0"></a> static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#a15a346ad7e43c6893bd05ccd09b632c0">AUTHENTICATION_ERROR</a> = 16003</td></tr> <tr class="memdesc:a15a346ad7e43c6893bd05ccd09b632c0"><td class="mdescLeft"> </td><td class="mdescRight">The session is likely invalid. <br /></td></tr> <tr class="separator:a15a346ad7e43c6893bd05ccd09b632c0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4228e1998c2e476761cabe08c8a579ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4228e1998c2e476761cabe08c8a579ee"></a> static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_request_error.html#a4228e1998c2e476761cabe08c8a579ee">WEB_SOCKET_ERROR</a> = 16004</td></tr> <tr class="memdesc:a4228e1998c2e476761cabe08c8a579ee"><td class="mdescLeft"> </td><td class="mdescRight">Problems connecting to the notifications server. <br /></td></tr> <tr class="separator:a4228e1998c2e476761cabe08c8a579ee"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Capture errors from different kinds of remote calls. </p> <p>Each request of the system might result in an error. Some errors - those typically in the 400 range - might have diagnostic information for the user. This mostly encapsulates the diagnostic information.</p> <p>See our internal documentation page: <a href="https://confluence.perforce.com:8443/display/WS/Web+Services+Home">https://confluence.perforce.com:8443/display/WS/Web+Services+Home</a> </p> </div><h2 class="groupheader">Member Enumeration Documentation</h2> <a class="anchor" id="afce591cfb45b53f3f3b3ef56684771b6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classhws_1_1_request_error.html#afce591cfb45b53f3f3b3ef56684771b6">hws::RequestError::Severity</a></td> </tr> </table> </div><div class="memdoc"> <p>The severity of the problem.</p> <p>For completeness, we include EMPTY, INFO, and WARN, which map to the severity of errors potentially reported by the underlying p4d instance. In practice, these should almost never happen.</p> <p>Most errors will have ERROR level, which means you should not retry what you just did.</p> <p>Errors at a FATAL level may require your client to stop accessing the server. Something very bad has occurred. </p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li>hws/<a class="el" href="_request_error_8h_source.html">RequestError.h</a></li> <li>hws/RequestError.cpp</li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Mon Aug 31 2015 09:11:40 for Helix Web Services Client by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.9.1 </small></address> </body> </html>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 15741 | ptomiak | Branch HWS for my use. | ||
//guest/perforce_software/helix-web-services/main/build/doc/helix_web_services_client_qt/html/classhws_1_1_request_error.html | |||||
#8 | 15578 | tjuricek |
Removing QSettings* usage from hws::Client. The way QSettings was being used only is relevant for one connection at a time, and, it didn't seem to work on windows nicely anyway. |
||
#7 | 15544 | tjuricek | Explain that the QSettings handle for hws::Client should only be used on connections you don't specify a P4PORT for. | ||
#6 | 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. |
||
#5 | 15423 | tjuricek |
Revised HWS Qt API. This is a major revision of the API, which removes most of the "typed" data, replacing it with a more generic "executeMethodDone" callback. The main benefit here is to allow the API to interop with different versions of p4d, and not restrict the methods it can call. We may add more helpers in the future. |
||
#4 | 14054 | tjuricek |
Allowing the Qt client to select 'all' vs 'my' projects. Right now, it should default to using "my" projects as a rule. |
||
#3 | 14049 | tjuricek |
Add methods to generate client workspaces for a user. The Qt SDK was updated based on immediate need. Also, add Ruby client SDK documentation to the docs site. Everything is early, but there's *some* reference available at least. |
||
#2 | 14026 | tjuricek | Revise example code on main page of Qt SDK | ||
#1 | 14025 | tjuricek |
Revise Qt SDK to a single 'helix_web_services_client' project. Most references to "Phoenix" have now been removed. Additionally, this is more similar to the other platform client SDKs in Ruby and JavaScript. Documentation via Doxygen is now available, and will be how much of the SDK reference should occur. |