blob: 3a6421bae9129131bcc3734cf38fd5ee0e1d5c0d [file] [log] [blame]
<!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>Apache Mesos: process::Encoder 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="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">Apache Mesos
</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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceprocess.html">process</a></li><li class="navelem"><a class="el" href="classprocess_1_1Encoder.html">Encoder</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classprocess_1_1Encoder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">process::Encoder Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="encoder_8hpp_source.html">encoder.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for process::Encoder:</div>
<div class="dyncontent">
<div class="center">
<img src="classprocess_1_1Encoder.png" usemap="#process::Encoder_map" alt=""/>
<map id="process::Encoder_map" name="process::Encoder_map">
<area href="classprocess_1_1DataEncoder.html" alt="process::DataEncoder" shape="rect" coords="99,56,287,80"/>
<area href="classprocess_1_1FileEncoder.html" alt="process::FileEncoder" shape="rect" coords="297,56,485,80"/>
<area href="classprocess_1_1HttpResponseEncoder.html" alt="process::HttpResponseEncoder" shape="rect" coords="0,112,188,136"/>
<area href="classprocess_1_1MessageEncoder.html" alt="process::MessageEncoder" shape="rect" coords="198,112,386,136"/>
</map>
</div></div>
<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:a61ab7c7c77f3285b9e1a91c3f962a007"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprocess_1_1Encoder.html#a61ab7c7c77f3285b9e1a91c3f962a007">Kind</a> { <a class="el" href="classprocess_1_1Encoder.html#a61ab7c7c77f3285b9e1a91c3f962a007ac87a85b245f499b11d47cf8c1a941b34">DATA</a>,
<a class="el" href="classprocess_1_1Encoder.html#a61ab7c7c77f3285b9e1a91c3f962a007a0268afc52c40ae5367e3735511000246">FILE</a>
}</td></tr>
<tr class="separator:a61ab7c7c77f3285b9e1a91c3f962a007"><td class="memSeparator" colspan="2">&#160;</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:a088747c70d4551a8971fc916c785bc1b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprocess_1_1Encoder.html#a088747c70d4551a8971fc916c785bc1b">Encoder</a> ()=default</td></tr>
<tr class="separator:a088747c70d4551a8971fc916c785bc1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9168827ab5f9afb73fb91b2b7d100b6a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprocess_1_1Encoder.html#a9168827ab5f9afb73fb91b2b7d100b6a">~Encoder</a> ()</td></tr>
<tr class="separator:a9168827ab5f9afb73fb91b2b7d100b6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab897ad4d4c34b843b2470a687955110a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classprocess_1_1Encoder.html#a61ab7c7c77f3285b9e1a91c3f962a007">Kind</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprocess_1_1Encoder.html#ab897ad4d4c34b843b2470a687955110a">kind</a> () const =0</td></tr>
<tr class="separator:ab897ad4d4c34b843b2470a687955110a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4d01c19116f3044ad6b5640085f51b1"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprocess_1_1Encoder.html#ad4d01c19116f3044ad6b5640085f51b1">backup</a> (size_t length)=0</td></tr>
<tr class="separator:ad4d01c19116f3044ad6b5640085f51b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecd2a94984a8e5297b0f5e18679d2583"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprocess_1_1Encoder.html#aecd2a94984a8e5297b0f5e18679d2583">remaining</a> () const =0</td></tr>
<tr class="separator:aecd2a94984a8e5297b0f5e18679d2583"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a61ab7c7c77f3285b9e1a91c3f962a007"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classprocess_1_1Encoder.html#a61ab7c7c77f3285b9e1a91c3f962a007">process::Encoder::Kind</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a61ab7c7c77f3285b9e1a91c3f962a007ac87a85b245f499b11d47cf8c1a941b34"></a>DATA</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a61ab7c7c77f3285b9e1a91c3f962a007a0268afc52c40ae5367e3735511000246"></a>FILE</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a088747c70d4551a8971fc916c785bc1b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">process::Encoder::Encoder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a9168827ab5f9afb73fb91b2b7d100b6a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual process::Encoder::~Encoder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad4d01c19116f3044ad6b5640085f51b1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void process::Encoder::backup </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</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>Implemented in <a class="el" href="classprocess_1_1FileEncoder.html#a4d6103c619e2c9ec1918813ada1f7b32">process::FileEncoder</a>, and <a class="el" href="classprocess_1_1DataEncoder.html#a70909315bb6d4dd0add1064fe1d113a5">process::DataEncoder</a>.</p>
</div>
</div>
<a class="anchor" id="ab897ad4d4c34b843b2470a687955110a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classprocess_1_1Encoder.html#a61ab7c7c77f3285b9e1a91c3f962a007">Kind</a> process::Encoder::kind </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classprocess_1_1FileEncoder.html#af378b042ec2124981cad35280f64dd2d">process::FileEncoder</a>, and <a class="el" href="classprocess_1_1DataEncoder.html#a5430bf4549e2aa2d841970d8c48dd3f1">process::DataEncoder</a>.</p>
</div>
</div>
<a class="anchor" id="aecd2a94984a8e5297b0f5e18679d2583"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t process::Encoder::remaining </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classprocess_1_1FileEncoder.html#ac17e03b4af0e161920a134f2b48c8317">process::FileEncoder</a>, and <a class="el" href="classprocess_1_1DataEncoder.html#ac1aad9f354442ecb25d18bbb89b6f239">process::DataEncoder</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>3rdparty/libprocess/src/<a class="el" href="encoder_8hpp_source.html">encoder.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>