| <!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.6"/> |
| <title>GRPC C++: include/grpc++/status.h Source File</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/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </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">GRPC C++ |
|  <span id="projectnumber">0.10.0.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.6 --> |
| <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><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Data Structures</span></a></li> |
| <li class="current"><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="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>Globals</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)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></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"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_f1b2ab2a88927c1e950e43c1cf4b634b.html">grpc++</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">status.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="status_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2015, Google Inc.</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * All rights reserved.</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * modification, are permitted provided that the following conditions are</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * met:</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * * Redistributions of source code must retain the above copyright</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * * Redistributions in binary form must reproduce the above</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * copyright notice, this list of conditions and the following disclaimer</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * in the documentation and/or other materials provided with the</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * distribution.</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * * Neither the name of Google Inc. nor the names of its</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * contributors may be used to endorse or promote products derived from</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * this software without specific prior written permission.</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#ifndef GRPCXX_STATUS_H</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span><span class="preprocessor">#define GRPCXX_STATUS_H</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <<a class="code" href="status__code__enum_8h.html">grpc++/status_code_enum.h</a>></span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include <<a class="code" href="config_8h.html">grpc++/config.h</a>></span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">namespace </span>grpc {</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> |
| <div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classgrpc_1_1_status.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1_status.html">Status</a> {</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classgrpc_1_1_status.html#a46537b45349a95126a16dcd67b5cf54c"> 44</a></span>  <a class="code" href="classgrpc_1_1_status.html#a46537b45349a95126a16dcd67b5cf54c">Status</a>() : code_(<a class="code" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43b">StatusCode</a>::<a class="code" href="classgrpc_1_1_status.html#acbac12f241ad08f449aa1b9086ec7acc">OK</a>) {}</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classgrpc_1_1_status.html#a8419a0b716f961c8d2d781c65f03def6"> 45</a></span>  <a class="code" href="classgrpc_1_1_status.html#a8419a0b716f961c8d2d781c65f03def6">Status</a>(<a class="code" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43b">StatusCode</a> code, <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& details)</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  : code_(code), details_(details) {}</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Pre-defined special status objects.</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classgrpc_1_1_status.html#acbac12f241ad08f449aa1b9086ec7acc"> 49</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classgrpc_1_1_status.html">Status</a>& <a class="code" href="classgrpc_1_1_status.html#acbac12f241ad08f449aa1b9086ec7acc">OK</a>;</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classgrpc_1_1_status.html#a9994ffe95a0495915d82481c2ec594ab"> 50</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classgrpc_1_1_status.html">Status</a>& <a class="code" href="classgrpc_1_1_status.html#a9994ffe95a0495915d82481c2ec594ab">CANCELLED</a>;</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classgrpc_1_1_status.html#a78b50cb074bcd9f1dd50e8f212f7e181"> 52</a></span>  <a class="code" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43b">StatusCode</a> <a class="code" href="classgrpc_1_1_status.html#a78b50cb074bcd9f1dd50e8f212f7e181">error_code</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code_; }</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classgrpc_1_1_status.html#a87888a7acefced58302f89a295940f16"> 53</a></span>  <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> <a class="code" href="classgrpc_1_1_status.html#a87888a7acefced58302f89a295940f16">error_message</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> details_; }</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> |
| <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classgrpc_1_1_status.html#a1f5b65c54d4e6dd502897e36040714dc"> 55</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classgrpc_1_1_status.html#a1f5b65c54d4e6dd502897e36040714dc">ok</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code_ == <a class="code" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43baf6f3078af147d683afc70e09695c7a65">StatusCode::OK</a>; }</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43b">StatusCode</a> code_;</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> details_;</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> };</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> } <span class="comment">// namespace grpc</span></div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#endif // GRPCXX_STATUS_H</span></div> |
| <div class="ttc" id="status__code__enum_8h_html"><div class="ttname"><a href="status__code__enum_8h.html">status_code_enum.h</a></div></div> |
| <div class="ttc" id="classgrpc_1_1_status_html_a87888a7acefced58302f89a295940f16"><div class="ttname"><a href="classgrpc_1_1_status.html#a87888a7acefced58302f89a295940f16">grpc::Status::error_message</a></div><div class="ttdeci">grpc::string error_message() const </div><div class="ttdef"><b>Definition:</b> status.h:53</div></div> |
| <div class="ttc" id="namespacegrpc_html_ab04a87625da3bf85cdaf5e7856b00203"><div class="ttname"><a href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a></div><div class="ttdeci">std::string string</div><div class="ttdef"><b>Definition:</b> config.h:112</div></div> |
| <div class="ttc" id="classgrpc_1_1_status_html_a9994ffe95a0495915d82481c2ec594ab"><div class="ttname"><a href="classgrpc_1_1_status.html#a9994ffe95a0495915d82481c2ec594ab">grpc::Status::CANCELLED</a></div><div class="ttdeci">static const Status & CANCELLED</div><div class="ttdef"><b>Definition:</b> status.h:50</div></div> |
| <div class="ttc" id="namespacegrpc_html_aff1730578c90160528f6a8d67ef5c43baf6f3078af147d683afc70e09695c7a65"><div class="ttname"><a href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43baf6f3078af147d683afc70e09695c7a65">grpc::OK</a></div><div class="ttdef"><b>Definition:</b> status_code_enum.h:41</div></div> |
| <div class="ttc" id="config_8h_html"><div class="ttname"><a href="config_8h.html">config.h</a></div></div> |
| <div class="ttc" id="namespacegrpc_html_aff1730578c90160528f6a8d67ef5c43b"><div class="ttname"><a href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43b">grpc::StatusCode</a></div><div class="ttdeci">StatusCode</div><div class="ttdef"><b>Definition:</b> status_code_enum.h:39</div></div> |
| <div class="ttc" id="classgrpc_1_1_status_html_a46537b45349a95126a16dcd67b5cf54c"><div class="ttname"><a href="classgrpc_1_1_status.html#a46537b45349a95126a16dcd67b5cf54c">grpc::Status::Status</a></div><div class="ttdeci">Status()</div><div class="ttdef"><b>Definition:</b> status.h:44</div></div> |
| <div class="ttc" id="classgrpc_1_1_status_html_a8419a0b716f961c8d2d781c65f03def6"><div class="ttname"><a href="classgrpc_1_1_status.html#a8419a0b716f961c8d2d781c65f03def6">grpc::Status::Status</a></div><div class="ttdeci">Status(StatusCode code, const grpc::string &details)</div><div class="ttdef"><b>Definition:</b> status.h:45</div></div> |
| <div class="ttc" id="classgrpc_1_1_status_html_a78b50cb074bcd9f1dd50e8f212f7e181"><div class="ttname"><a href="classgrpc_1_1_status.html#a78b50cb074bcd9f1dd50e8f212f7e181">grpc::Status::error_code</a></div><div class="ttdeci">StatusCode error_code() const </div><div class="ttdef"><b>Definition:</b> status.h:52</div></div> |
| <div class="ttc" id="classgrpc_1_1_status_html_a1f5b65c54d4e6dd502897e36040714dc"><div class="ttname"><a href="classgrpc_1_1_status.html#a1f5b65c54d4e6dd502897e36040714dc">grpc::Status::ok</a></div><div class="ttdeci">bool ok() const </div><div class="ttdef"><b>Definition:</b> status.h:55</div></div> |
| <div class="ttc" id="classgrpc_1_1_status_html"><div class="ttname"><a href="classgrpc_1_1_status.html">grpc::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:42</div></div> |
| <div class="ttc" id="classgrpc_1_1_status_html_acbac12f241ad08f449aa1b9086ec7acc"><div class="ttname"><a href="classgrpc_1_1_status.html#acbac12f241ad08f449aa1b9086ec7acc">grpc::Status::OK</a></div><div class="ttdeci">static const Status & OK</div><div class="ttdef"><b>Definition:</b> status.h:49</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Wed Aug 5 2015 08:17:06 for GRPC C++ by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.6 |
| </small></address> |
| </body> |
| </html> |