346 lines
24 KiB
HTML
346 lines
24 KiB
HTML
<!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>
|
|
<title>SFML - Simple and Fast Multimedia Library</title>
|
|
<meta http-equiv="Content-Type" content="text/html;"/>
|
|
<meta charset="utf-8"/>
|
|
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
|
|
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="banner-container">
|
|
<div id="banner">
|
|
<span id="sfml">SFML 2.5.1</span>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</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>
|
|
</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>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>sf</b></li><li class="navelem"><a class="el" href="classsf_1_1Http.html">Http</a></li><li class="navelem"><a class="el" href="classsf_1_1Http_1_1Response.html">Response</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="#friends">Friends</a> |
|
|
<a href="classsf_1_1Http_1_1Response-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">sf::Http::Response Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Define a HTTP response.
|
|
<a href="classsf_1_1Http_1_1Response.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Http_8hpp_source.html">Http.hpp</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:a663e071978e30fbbeb20ed045be874d8"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8">Status</a> { <br />
|
|
  <a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a0158f932254d3f09647dd1f64bd43832">Ok</a> = 200,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a0a6e8bafa9365a0ed10b8a9cbfd0649b">Created</a> = 201,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8ad328945457bd2f0d65107ba6b5ccd443">Accepted</a> = 202,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8aefde9e4abf5682dcd314d63143be42e0">NoContent</a> = 204,
|
|
<br />
|
|
  <a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a77327cc2a5e34cc64030b322e61d12a8">ResetContent</a> = 205,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a0cfae3ab0469b73dfddc54312a5e6a8a">PartialContent</a> = 206,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8add95cbd8fa27516821f763488557f96b">MultipleChoices</a> = 300,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a2f91651db3a09628faf68cbcefa0810a">MovedPermanently</a> = 301,
|
|
<br />
|
|
  <a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a05c50d7b17c844e0b909e5802d5f1587">MovedTemporarily</a> = 302,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a060ebc3af266e6bfe045b89e298e2545">NotModified</a> = 304,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a3f88a714cf5483ee22f9051e5a3c080a">BadRequest</a> = 400,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8ab7a79b7bff50fb1902c19eecbb4e2a2d">Unauthorized</a> = 401,
|
|
<br />
|
|
  <a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a64492842e823ebe12a85539b6b454986">Forbidden</a> = 403,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8affca8a8319a62d98bd3ef90ff5cfc030">NotFound</a> = 404,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a12533d00093b190e6d4c0076577e2239">RangeNotSatisfiable</a> = 407,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8adae2b2a936414349d55b4ed8c583fed1">InternalServerError</a> = 500,
|
|
<br />
|
|
  <a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a6920ba06d7e2bcf0b325da23ee95ef68">NotImplemented</a> = 501,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8aad0cbad4cdaf448beb763e86bc1f747c">BadGateway</a> = 502,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8ac4fffba9d5ad4c14171a1bbe4f6adf87">ServiceNotAvailable</a> = 503,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a215935d823ab44694709a184a71353b0">GatewayTimeout</a> = 504,
|
|
<br />
|
|
  <a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8aeb32a1a087d5fcf1a42663eb40c3c305">VersionNotSupported</a> = 505,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a0af0090420e60bf54da4860749345c95">InvalidResponse</a> = 1000,
|
|
<a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8a7f307376f13bdc06b24fc274ecd2aa60">ConnectionFailed</a> = 1001
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a663e071978e30fbbeb20ed045be874d8"><td class="mdescLeft"> </td><td class="mdescRight">Enumerate all the valid status codes for a response. <a href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8">More...</a><br /></td></tr>
|
|
<tr class="separator:a663e071978e30fbbeb20ed045be874d8"><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:a2e51c89356fe6a007c448a841a9ec08c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Http_1_1Response.html#a2e51c89356fe6a007c448a841a9ec08c">Response</a> ()</td></tr>
|
|
<tr class="memdesc:a2e51c89356fe6a007c448a841a9ec08c"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a2e51c89356fe6a007c448a841a9ec08c">More...</a><br /></td></tr>
|
|
<tr class="separator:a2e51c89356fe6a007c448a841a9ec08c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6dedeaeea13b5ebf0c41fc7a1c1885e5"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Http_1_1Response.html#a6dedeaeea13b5ebf0c41fc7a1c1885e5">getField</a> (const std::string &field) const</td></tr>
|
|
<tr class="memdesc:a6dedeaeea13b5ebf0c41fc7a1c1885e5"><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a field. <a href="#a6dedeaeea13b5ebf0c41fc7a1c1885e5">More...</a><br /></td></tr>
|
|
<tr class="separator:a6dedeaeea13b5ebf0c41fc7a1c1885e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4271651703764fd9a7d2c0315aff20de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Http_1_1Response.html#a4271651703764fd9a7d2c0315aff20de">getStatus</a> () const</td></tr>
|
|
<tr class="memdesc:a4271651703764fd9a7d2c0315aff20de"><td class="mdescLeft"> </td><td class="mdescRight">Get the response status code. <a href="#a4271651703764fd9a7d2c0315aff20de">More...</a><br /></td></tr>
|
|
<tr class="separator:a4271651703764fd9a7d2c0315aff20de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1c6948f6444fad34d0537e206e398b8"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Http_1_1Response.html#ab1c6948f6444fad34d0537e206e398b8">getMajorHttpVersion</a> () const</td></tr>
|
|
<tr class="memdesc:ab1c6948f6444fad34d0537e206e398b8"><td class="mdescLeft"> </td><td class="mdescRight">Get the major HTTP version number of the response. <a href="#ab1c6948f6444fad34d0537e206e398b8">More...</a><br /></td></tr>
|
|
<tr class="separator:ab1c6948f6444fad34d0537e206e398b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3c649568d2e291e71c3a7da546bb392"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Http_1_1Response.html#af3c649568d2e291e71c3a7da546bb392">getMinorHttpVersion</a> () const</td></tr>
|
|
<tr class="memdesc:af3c649568d2e291e71c3a7da546bb392"><td class="mdescLeft"> </td><td class="mdescRight">Get the minor HTTP version number of the response. <a href="#af3c649568d2e291e71c3a7da546bb392">More...</a><br /></td></tr>
|
|
<tr class="separator:af3c649568d2e291e71c3a7da546bb392"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab3bfc29867563aa815f6460eeea16136"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Http_1_1Response.html#ab3bfc29867563aa815f6460eeea16136">getBody</a> () const</td></tr>
|
|
<tr class="memdesc:ab3bfc29867563aa815f6460eeea16136"><td class="mdescLeft"> </td><td class="mdescRight">Get the body of the response. <a href="#ab3bfc29867563aa815f6460eeea16136">More...</a><br /></td></tr>
|
|
<tr class="separator:ab3bfc29867563aa815f6460eeea16136"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:aba95e2a7762bb5df986048b05d03a22e"><td class="memItemLeft" align="right" valign="top"><a id="aba95e2a7762bb5df986048b05d03a22e"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>Http</b></td></tr>
|
|
<tr class="separator:aba95e2a7762bb5df986048b05d03a22e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Define a HTTP response. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Http_8hpp_source.html#l00193">193</a> of file <a class="el" href="Http_8hpp_source.html">Http.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="a663e071978e30fbbeb20ed045be874d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a663e071978e30fbbeb20ed045be874d8">◆ </a></span>Status</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8">sf::Http::Response::Status</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumerate all the valid status codes for a response. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a0158f932254d3f09647dd1f64bd43832"></a>Ok </td><td class="fielddoc"><p>Most common code returned when operation was successful. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a0a6e8bafa9365a0ed10b8a9cbfd0649b"></a>Created </td><td class="fielddoc"><p>The resource has successfully been created. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8ad328945457bd2f0d65107ba6b5ccd443"></a>Accepted </td><td class="fielddoc"><p>The request has been accepted, but will be processed later by the server. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8aefde9e4abf5682dcd314d63143be42e0"></a>NoContent </td><td class="fielddoc"><p>The server didn't send any data in return. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a77327cc2a5e34cc64030b322e61d12a8"></a>ResetContent </td><td class="fielddoc"><p>The server informs the client that it should clear the view (form) that caused the request to be sent. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a0cfae3ab0469b73dfddc54312a5e6a8a"></a>PartialContent </td><td class="fielddoc"><p>The server has sent a part of the resource, as a response to a partial GET request. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8add95cbd8fa27516821f763488557f96b"></a>MultipleChoices </td><td class="fielddoc"><p>The requested page can be accessed from several locations. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a2f91651db3a09628faf68cbcefa0810a"></a>MovedPermanently </td><td class="fielddoc"><p>The requested page has permanently moved to a new location. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a05c50d7b17c844e0b909e5802d5f1587"></a>MovedTemporarily </td><td class="fielddoc"><p>The requested page has temporarily moved to a new location. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a060ebc3af266e6bfe045b89e298e2545"></a>NotModified </td><td class="fielddoc"><p>For conditional requests, means the requested page hasn't changed and doesn't need to be refreshed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a3f88a714cf5483ee22f9051e5a3c080a"></a>BadRequest </td><td class="fielddoc"><p>The server couldn't understand the request (syntax error) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8ab7a79b7bff50fb1902c19eecbb4e2a2d"></a>Unauthorized </td><td class="fielddoc"><p>The requested page needs an authentication to be accessed. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a64492842e823ebe12a85539b6b454986"></a>Forbidden </td><td class="fielddoc"><p>The requested page cannot be accessed at all, even with authentication. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8affca8a8319a62d98bd3ef90ff5cfc030"></a>NotFound </td><td class="fielddoc"><p>The requested page doesn't exist. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a12533d00093b190e6d4c0076577e2239"></a>RangeNotSatisfiable </td><td class="fielddoc"><p>The server can't satisfy the partial GET request (with a "Range" header field) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8adae2b2a936414349d55b4ed8c583fed1"></a>InternalServerError </td><td class="fielddoc"><p>The server encountered an unexpected error. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a6920ba06d7e2bcf0b325da23ee95ef68"></a>NotImplemented </td><td class="fielddoc"><p>The server doesn't implement a requested feature. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8aad0cbad4cdaf448beb763e86bc1f747c"></a>BadGateway </td><td class="fielddoc"><p>The gateway server has received an error from the source server. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8ac4fffba9d5ad4c14171a1bbe4f6adf87"></a>ServiceNotAvailable </td><td class="fielddoc"><p>The server is temporarily unavailable (overloaded, in maintenance, ...) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a215935d823ab44694709a184a71353b0"></a>GatewayTimeout </td><td class="fielddoc"><p>The gateway server couldn't receive a response from the source server. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8aeb32a1a087d5fcf1a42663eb40c3c305"></a>VersionNotSupported </td><td class="fielddoc"><p>The server doesn't support the requested HTTP version. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a0af0090420e60bf54da4860749345c95"></a>InvalidResponse </td><td class="fielddoc"><p><a class="el" href="classsf_1_1Http_1_1Response.html" title="Define a HTTP response. ">Response</a> is not a valid HTTP one. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a663e071978e30fbbeb20ed045be874d8a7f307376f13bdc06b24fc274ecd2aa60"></a>ConnectionFailed </td><td class="fielddoc"><p>Connection with server failed. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Http_8hpp_source.html#l00201">201</a> of file <a class="el" href="Http_8hpp_source.html">Http.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a2e51c89356fe6a007c448a841a9ec08c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2e51c89356fe6a007c448a841a9ec08c">◆ </a></span>Response()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Http::Response::Response </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<p>Constructs an empty response. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ab3bfc29867563aa815f6460eeea16136"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab3bfc29867563aa815f6460eeea16136">◆ </a></span>getBody()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string& sf::Http::Response::getBody </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the body of the response. </p>
|
|
<p>The body of a response may contain: </p><ul>
|
|
<li>the requested page (for GET requests) </li>
|
|
<li>a response from the server (for POST requests) </li>
|
|
<li>nothing (for HEAD requests) </li>
|
|
<li>an error message (in case of an error)</li>
|
|
</ul>
|
|
<dl class="section return"><dt>Returns</dt><dd>The response body </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6dedeaeea13b5ebf0c41fc7a1c1885e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6dedeaeea13b5ebf0c41fc7a1c1885e5">◆ </a></span>getField()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string& sf::Http::Response::getField </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>field</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the value of a field. </p>
|
|
<p>If the field <em>field</em> is not found in the response header, the empty string is returned. This function uses case-insensitive comparisons.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">field</td><td>Name of the field to get</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Value of the field, or empty string if not found </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab1c6948f6444fad34d0537e206e398b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab1c6948f6444fad34d0537e206e398b8">◆ </a></span>getMajorHttpVersion()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int sf::Http::Response::getMajorHttpVersion </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the major HTTP version number of the response. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Major HTTP version number</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Http_1_1Response.html#af3c649568d2e291e71c3a7da546bb392" title="Get the minor HTTP version number of the response. ">getMinorHttpVersion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af3c649568d2e291e71c3a7da546bb392"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af3c649568d2e291e71c3a7da546bb392">◆ </a></span>getMinorHttpVersion()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int sf::Http::Response::getMinorHttpVersion </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the minor HTTP version number of the response. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Minor HTTP version number</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Http_1_1Response.html#ab1c6948f6444fad34d0537e206e398b8" title="Get the major HTTP version number of the response. ">getMajorHttpVersion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4271651703764fd9a7d2c0315aff20de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4271651703764fd9a7d2c0315aff20de">◆ </a></span>getStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Http_1_1Response.html#a663e071978e30fbbeb20ed045be874d8">Status</a> sf::Http::Response::getStatus </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the response status code. </p>
|
|
<p>The status code should be the first thing to be checked after receiving a response, it defines whether it is a success, a failure or anything else (see the Status enumeration).</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Status code of the response </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Http_8hpp_source.html">Http.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br>
|
|
Copyright © Laurent Gomila ::
|
|
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> ::
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|