blob: 29fcf433af5438a3a009bd0f8ec425fec93d7b60 [file] [log] [blame]
<!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>Proton DotNet: Apache.Qpid.Proton.Engine.IEngineConfiguration Interface 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">Proton DotNet
</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="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineConfiguration.html">IEngineConfiguration</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#properties">Properties</a> &#124;
<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineConfiguration-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Engine.IEngineConfiguration Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Configuration options for the <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a>
<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineConfiguration.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Engine.IEngineConfiguration:</div>
<div class="dyncontent">
<div class="center">
<img src="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineConfiguration.png" usemap="#Apache.Qpid.Proton.Engine.IEngineConfiguration_map" alt=""/>
<map id="Apache.Qpid.Proton.Engine.IEngineConfiguration_map" name="Apache.Qpid.Proton.Engine.IEngineConfiguration_map">
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngineConfiguration.html" title="Implementation of engine configuration options along with Proton specific internal configuration and ..." alt="Apache.Qpid.Proton.Engine.Implementation.ProtonEngineConfiguration" shape="rect" coords="0,56,413,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a21498a1fb982a353463fa99012fdbc4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBufferAllocator.html">IProtonBufferAllocator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineConfiguration.html#a21498a1fb982a353463fa99012fdbc4b">BufferAllocator</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a21498a1fb982a353463fa99012fdbc4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the ProtonBufferAllocator used by this <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a>. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineConfiguration.html#a21498a1fb982a353463fa99012fdbc4b">More...</a><br /></td></tr>
<tr class="separator:a21498a1fb982a353463fa99012fdbc4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21167ba02d23f159d814153f8235681b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineConfiguration.html#a21167ba02d23f159d814153f8235681b">TraceFrames</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a21167ba02d23f159d814153f8235681b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables AMQP frame tracing from engine to the system output. Depending on the underlying engine composition frame tracing may not be possible in which case this method will have no effect and the access method that read the state will return false. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngineConfiguration.html#a21167ba02d23f159d814153f8235681b">More...</a><br /></td></tr>
<tr class="separator:a21167ba02d23f159d814153f8235681b"><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>Configuration options for the <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a> </p>
</div><h2 class="groupheader">Property Documentation</h2>
<a id="a21498a1fb982a353463fa99012fdbc4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21498a1fb982a353463fa99012fdbc4b">&#9670;&nbsp;</a></span>BufferAllocator</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBufferAllocator.html">IProtonBufferAllocator</a> Apache.Qpid.Proton.Engine.IEngineConfiguration.BufferAllocator</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the ProtonBufferAllocator used by this <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a>. </p>
<p>When copying data, encoding types or otherwise needing to allocate memory storage the <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a> will use the assigned IProtonBufferAllocator. If no allocator is assigned the <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a> will use the default allocator. </p>
</div>
</div>
<a id="a21167ba02d23f159d814153f8235681b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21167ba02d23f159d814153f8235681b">&#9670;&nbsp;</a></span>TraceFrames</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Qpid.Proton.Engine.IEngineConfiguration.TraceFrames</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables AMQP frame tracing from engine to the system output. Depending on the underlying engine composition frame tracing may not be possible in which case this method will have no effect and the access method that read the state will return false. </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>src/Proton/Engine/IEngineConfiguration.cs</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>