<!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.5"/>
<title>xmltooling: xmltooling::GenericResponse 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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">xmltooling
 <span id="projectnumber">1.5.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<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="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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('a00038.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="a00252.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">xmltooling::GenericResponse Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface to generic protocol responses that transport XML messages.
<a href="a00038.html#details">More...</a></p>
<p><code>#include <xmltooling/io/GenericResponse.h></code></p>
<div class="dynheader">
Inheritance diagram for xmltooling::GenericResponse:</div>
<div class="dyncontent">
<div class="center">
<img src="a00038.png" usemap="#xmltooling::GenericResponse_map" alt=""/>
<map id="xmltooling::GenericResponse_map" name="xmltooling::GenericResponse_map">
<area href="a00042.html" title="Interface to HTTP response. " alt="xmltooling::HTTPResponse" shape="rect" coords="0,56,173,80"/>
</map>
</div></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:aaa1c1ad753024e91ba8b6beb0a0ce31f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#aaa1c1ad753024e91ba8b6beb0a0ce31f">setContentType</a> (const char *type=0)=0</td></tr>
<tr class="memdesc:aaa1c1ad753024e91ba8b6beb0a0ce31f"><td class="mdescLeft"> </td><td class="mdescRight">Sets or clears the MIME type of the response. <a href="#aaa1c1ad753024e91ba8b6beb0a0ce31f">More...</a><br/></td></tr>
<tr class="separator:aaa1c1ad753024e91ba8b6beb0a0ce31f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac47423d7e0b6f8ee2bbb753cb0c853db"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ac47423d7e0b6f8ee2bbb753cb0c853db">sendResponse</a> (std::istream &inputStream)=0</td></tr>
<tr class="memdesc:ac47423d7e0b6f8ee2bbb753cb0c853db"><td class="mdescLeft"> </td><td class="mdescRight">Sends a completed response to the client along with a transport-specific "OK" indication. <a href="#ac47423d7e0b6f8ee2bbb753cb0c853db">More...</a><br/></td></tr>
<tr class="separator:ac47423d7e0b6f8ee2bbb753cb0c853db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5302f96dcd5ef850e755e515bf29981"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#af5302f96dcd5ef850e755e515bf29981">sendError</a> (std::istream &inputStream)=0</td></tr>
<tr class="memdesc:af5302f96dcd5ef850e755e515bf29981"><td class="mdescLeft"> </td><td class="mdescRight">Sends an "error" response to the client along with a transport-specific error indication. <a href="#af5302f96dcd5ef850e755e515bf29981">More...</a><br/></td></tr>
<tr class="separator:af5302f96dcd5ef850e755e515bf29981"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83b42e482a69871a8054a52a8396b4cf"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a83b42e482a69871a8054a52a8396b4cf">sendResponse</a> (std::istream &inputStream, long status)=0</td></tr>
<tr class="memdesc:a83b42e482a69871a8054a52a8396b4cf"><td class="mdescLeft"> </td><td class="mdescRight">Sends a completed response to the client. <a href="#a83b42e482a69871a8054a52a8396b4cf">More...</a><br/></td></tr>
<tr class="separator:a83b42e482a69871a8054a52a8396b4cf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface to generic protocol responses that transport XML messages. </p>
<p>This interface need not be threadsafe. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af5302f96dcd5ef850e755e515bf29981"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual long xmltooling::GenericResponse::sendError </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>inputStream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends an "error" response to the client along with a transport-specific error indication. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputStream</td><td>reference to source of response data </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a result code to return from the calling MessageEncoder </dd></dl>
<p>Implemented in <a class="el" href="a00042.html#ad6a4b4c4cf4db6e44f170d6bde2ac096">xmltooling::HTTPResponse</a>.</p>
</div>
</div>
<a class="anchor" id="ac47423d7e0b6f8ee2bbb753cb0c853db"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual long xmltooling::GenericResponse::sendResponse </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>inputStream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends a completed response to the client along with a transport-specific "OK" indication. </p>
<p>Used for "normal" responses.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputStream</td><td>reference to source of response data </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a result code to return from the calling MessageEncoder </dd></dl>
<p>Implemented in <a class="el" href="a00042.html#a9f2ac39237d3c4533997e3374a7f82dc">xmltooling::HTTPResponse</a>.</p>
</div>
</div>
<a class="anchor" id="a83b42e482a69871a8054a52a8396b4cf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual long xmltooling::GenericResponse::sendResponse </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>inputStream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends a completed response to the client. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputStream</td><td>reference to source of response data </td></tr>
<tr><td class="paramname">status</td><td>transport-specific status to return </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a result code to return from the calling MessageEncoder </dd></dl>
</div>
</div>
<a class="anchor" id="aaa1c1ad753024e91ba8b6beb0a0ce31f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void xmltooling::GenericResponse::setContentType </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>type</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets or clears the MIME type of the response. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>the MIME type, or nullptr to clear </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="a00042.html#af345e019a816cf7f59befe1bbc6afb73">xmltooling::HTTPResponse</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xmltooling/io/<a class="el" href="a00140.html">GenericResponse.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="a00206.html">xmltooling</a></li><li class="navelem"><a class="el" href="a00038.html">GenericResponse</a></li>
<li class="footer">Generated on Wed Sep 2 2015 18:20:35 for xmltooling by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
</body>
</html>
