tastytea
/
mastodonpp
2
1
Fork 0
Code Issues Pull Requests Releases 12 Wiki Activity
mastodonpp/docs/classmastodonpp_1_1CURLExce...

323 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mastodonpp: mastodonpp::CURLException 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>
<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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mastodonpp
&#160;<span id="projectnumber">0.5.7</span>
</div>
<div id="projectbrief">C++ wrapper for the Mastodon and Pleroma APIs.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></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"><a class="el" href="namespacemastodonpp.html">mastodonpp</a></li><li class="navelem"><a class="el" href="classmastodonpp_1_1CURLException.html">CURLException</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classmastodonpp_1_1CURLException-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mastodonpp::CURLException Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Exception for libcurl errors.
<a href="classmastodonpp_1_1CURLException.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="exceptions_8hpp_source.html">mastodonpp/exceptions.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mastodonpp::CURLException:</div>
<div class="dyncontent">
<div class="center"><img src="classmastodonpp_1_1CURLException__inherit__graph.png" border="0" usemap="#amastodonpp_1_1CURLException_inherit__map" alt="Inheritance graph"/></div>
<map name="amastodonpp_1_1CURLException_inherit__map" id="amastodonpp_1_1CURLException_inherit__map">
<area shape="rect" title="Exception for libcurl errors." alt="" coords="5,80,201,107"/>
<area shape="rect" title=" " alt="" coords="51,5,155,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for mastodonpp::CURLException:</div>
<div class="dyncontent">
<div class="center"><img src="classmastodonpp_1_1CURLException__coll__graph.png" border="0" usemap="#amastodonpp_1_1CURLException_coll__map" alt="Collaboration graph"/></div>
<map name="amastodonpp_1_1CURLException_coll__map" id="amastodonpp_1_1CURLException_coll__map">
<area shape="rect" title="Exception for libcurl errors." alt="" coords="5,80,201,107"/>
<area shape="rect" title=" " alt="" coords="51,5,155,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:af43d29b726eceb3f80a71cdd7c3d55d4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLException.html#af43d29b726eceb3f80a71cdd7c3d55d4">CURLException</a> (const CURLcode &amp;error, string message)</td></tr>
<tr class="memdesc:af43d29b726eceb3f80a71cdd7c3d55d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor with error code and message. <a href="classmastodonpp_1_1CURLException.html#af43d29b726eceb3f80a71cdd7c3d55d4">More...</a><br /></td></tr>
<tr class="separator:af43d29b726eceb3f80a71cdd7c3d55d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21a021c5c9ba1631224a6e81e36e242f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLException.html#a21a021c5c9ba1631224a6e81e36e242f">CURLException</a> (const CURLcode &amp;error, string message, string error_buffer)</td></tr>
<tr class="memdesc:a21a021c5c9ba1631224a6e81e36e242f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor with error code, message and error buffer. <a href="classmastodonpp_1_1CURLException.html#a21a021c5c9ba1631224a6e81e36e242f">More...</a><br /></td></tr>
<tr class="separator:a21a021c5c9ba1631224a6e81e36e242f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73b235aa9f6699e126641ae93365a39d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLException.html#a73b235aa9f6699e126641ae93365a39d">CURLException</a> (string message)</td></tr>
<tr class="memdesc:a73b235aa9f6699e126641ae93365a39d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor with message. <a href="classmastodonpp_1_1CURLException.html#a73b235aa9f6699e126641ae93365a39d">More...</a><br /></td></tr>
<tr class="separator:a73b235aa9f6699e126641ae93365a39d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5d6aaec95758bc7db42ef1ee8831ecc"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLException.html#aa5d6aaec95758bc7db42ef1ee8831ecc">what</a> () const noexcept override</td></tr>
<tr class="memdesc:aa5d6aaec95758bc7db42ef1ee8831ecc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the error code, message and error buffer. <a href="classmastodonpp_1_1CURLException.html#aa5d6aaec95758bc7db42ef1ee8831ecc">More...</a><br /></td></tr>
<tr class="separator:aa5d6aaec95758bc7db42ef1ee8831ecc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a91eedb1a1d70015afdb4645d87d10e72"><td class="memItemLeft" align="right" valign="top">const CURLcode&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmastodonpp_1_1CURLException.html#a91eedb1a1d70015afdb4645d87d10e72">error_code</a></td></tr>
<tr class="memdesc:a91eedb1a1d70015afdb4645d87d10e72"><td class="mdescLeft">&#160;</td><td class="mdescRight">The error code returned by libcurl. <a href="classmastodonpp_1_1CURLException.html#a91eedb1a1d70015afdb4645d87d10e72">More...</a><br /></td></tr>
<tr class="separator:a91eedb1a1d70015afdb4645d87d10e72"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Exception for libcurl errors. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af43d29b726eceb3f80a71cdd7c3d55d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af43d29b726eceb3f80a71cdd7c3d55d4">&#9670;&nbsp;</a></span>CURLException() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mastodonpp::CURLException::CURLException </td>
<td>(</td>
<td class="paramtype">const CURLcode &amp;&#160;</td>
<td class="paramname"><em>error</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>message</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor with error code and message. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; : <a class="code" href="classmastodonpp_1_1CURLException.html#a91eedb1a1d70015afdb4645d87d10e72">error_code</a>{error}</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; , _message{move(message)}</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{}</div>
<div class="ttc" id="aclassmastodonpp_1_1CURLException_html_a91eedb1a1d70015afdb4645d87d10e72"><div class="ttname"><a href="classmastodonpp_1_1CURLException.html#a91eedb1a1d70015afdb4645d87d10e72">mastodonpp::CURLException::error_code</a></div><div class="ttdeci">const CURLcode error_code</div><div class="ttdoc">The error code returned by libcurl.</div><div class="ttdef"><b>Definition:</b> exceptions.hpp:73</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a21a021c5c9ba1631224a6e81e36e242f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21a021c5c9ba1631224a6e81e36e242f">&#9670;&nbsp;</a></span>CURLException() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mastodonpp::CURLException::CURLException </td>
<td>(</td>
<td class="paramtype">const CURLcode &amp;&#160;</td>
<td class="paramname"><em>error</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>error_buffer</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor with error code, message and error buffer. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; : <a class="code" href="classmastodonpp_1_1CURLException.html#a91eedb1a1d70015afdb4645d87d10e72">error_code</a>{error}</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; , _message{move(message)}</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; , _error_buffer{move(error_buffer)}</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a73b235aa9f6699e126641ae93365a39d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73b235aa9f6699e126641ae93365a39d">&#9670;&nbsp;</a></span>CURLException() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mastodonpp::CURLException::CURLException </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor with message. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; : <a class="code" href="classmastodonpp_1_1CURLException.html#a91eedb1a1d70015afdb4645d87d10e72">error_code</a>{CURLE_OK}</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; , _message{move(message)}</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;{}</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa5d6aaec95758bc7db42ef1ee8831ecc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5d6aaec95758bc7db42ef1ee8831ecc">&#9670;&nbsp;</a></span>what()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char * mastodonpp::CURLException::what </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the error code, message and error buffer. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;{</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">static</span> <span class="keywordtype">string</span> error_string{<span class="stringliteral">&quot;libCURL error: &quot;</span>};</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classmastodonpp_1_1CURLException.html#a91eedb1a1d70015afdb4645d87d10e72">error_code</a> != CURLE_OK)</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; error_string += to_string(<a class="code" href="classmastodonpp_1_1CURLException.html#a91eedb1a1d70015afdb4645d87d10e72">error_code</a>) + <span class="stringliteral">&quot; - &quot;</span>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; error_string += _message;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">if</span> (!_error_buffer.empty())</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; error_string += <span class="stringliteral">&quot; [&quot;</span> + _error_buffer + <span class="stringliteral">&quot;]&quot;</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; }</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">return</span> error_string.c_str();</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a91eedb1a1d70015afdb4645d87d10e72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91eedb1a1d70015afdb4645d87d10e72">&#9670;&nbsp;</a></span>error_code</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const CURLcode mastodonpp::CURLException::error_code</td>
</tr>
</table>
</div><div class="memdoc">
<p>The error code returned by libcurl. </p>
<p>For more information consult <a href="https://curl.haxx.se/libcurl/c/libcurl-errors.html">libcurl-errors(3)</a>.</p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="exceptions_8hpp_source.html">exceptions.hpp</a></li>
<li>src/exceptions.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink