Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / content / releases / qpid-proton-dotnet-1.0.0-M10 / api / interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformative.html
blob: e95ac7cd30667b7870e60d117887fb889caf3f8a [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.Types.Transport.IPerformative 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_1Types.html">Types</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport.html">Transport</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformative.html">IPerformative</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformative-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Types.Transport.IPerformative Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Types.Transport.IPerformative:</div>
<div class="dyncontent">
<div class="center">
<img src="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformative.png" usemap="#Apache.Qpid.Proton.Types.Transport.IPerformative_map" alt=""/>
<map id="Apache.Qpid.Proton.Types.Transport.IPerformative_map" name="Apache.Qpid.Proton.Types.Transport.IPerformative_map">
<area href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Attach.html" alt="Apache.Qpid.Proton.Types.Transport.Attach" shape="rect" coords="313,112,616,136"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Begin.html" alt="Apache.Qpid.Proton.Types.Transport.Begin" shape="rect" coords="313,168,616,192"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Close.html" alt="Apache.Qpid.Proton.Types.Transport.Close" shape="rect" coords="313,224,616,248"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Detach.html" alt="Apache.Qpid.Proton.Types.Transport.Detach" shape="rect" coords="313,280,616,304"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Disposition.html" alt="Apache.Qpid.Proton.Types.Transport.Disposition" shape="rect" coords="313,336,616,360"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1End.html" alt="Apache.Qpid.Proton.Types.Transport.End" shape="rect" coords="313,392,616,416"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Flow.html" alt="Apache.Qpid.Proton.Types.Transport.Flow" shape="rect" coords="313,448,616,472"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Open.html" alt="Apache.Qpid.Proton.Types.Transport.Open" shape="rect" coords="313,504,616,528"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Transfer.html" alt="Apache.Qpid.Proton.Types.Transport.Transfer" shape="rect" coords="313,560,616,584"/>
</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:adf304b897a481df09b68cadc7a0d34da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformative.html#adf304b897a481df09b68cadc7a0d34da">Invoke&lt; T &gt;</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformativeHandler.html">IPerformativeHandler</a>&lt; T &gt; handler, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> payload, ushort channel, T context)</td></tr>
<tr class="memdesc:adf304b897a481df09b68cadc7a0d34da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit the performative using a handler instance and provided context data. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformative.html#adf304b897a481df09b68cadc7a0d34da">More...</a><br /></td></tr>
<tr class="separator:adf304b897a481df09b68cadc7a0d34da"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a73c4c1698ad6abc25ba0015f93974a25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport.html#a1cb9d50f8c1c2a1eb89a750d839929c2">PerformativeType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformative.html#a73c4c1698ad6abc25ba0015f93974a25">Type</a><code> [get]</code></td></tr>
<tr class="memdesc:a73c4c1698ad6abc25ba0015f93974a25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the type of this performative. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformative.html#a73c4c1698ad6abc25ba0015f93974a25">More...</a><br /></td></tr>
<tr class="separator:a73c4c1698ad6abc25ba0015f93974a25"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="adf304b897a481df09b68cadc7a0d34da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf304b897a481df09b68cadc7a0d34da">&#9670;&nbsp;</a></span>Invoke&lt; T &gt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Apache.Qpid.Proton.Types.Transport.IPerformative.Invoke&lt; T &gt; </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IPerformativeHandler.html">IPerformativeHandler</a>&lt; T &gt;&#160;</td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a>&#160;</td>
<td class="paramname"><em>payload</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ushort&#160;</td>
<td class="paramname"><em>channel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>context</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Visit the performative using a handler instance and provided context data. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The type of context that is provided</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>The handler instance to visit</td></tr>
<tr><td class="paramname">payload</td><td>The payload that the performative was sent with</td></tr>
<tr><td class="paramname">channel</td><td>The channel the performative was sent on</td></tr>
<tr><td class="paramname">context</td><td>The context for this visitation</td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Transfer.html#a5869881db6487a36d60c6a8b7157230c">Apache.Qpid.Proton.Types.Transport.Transfer</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Open.html#aa9f87431940460b5a68a502f5f7648ec">Apache.Qpid.Proton.Types.Transport.Open</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Flow.html#ad0f93408055322e6c99aa6f746591ae6">Apache.Qpid.Proton.Types.Transport.Flow</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1End.html#a4b73cb3b6102bdbbfe6e730cbacd6deb">Apache.Qpid.Proton.Types.Transport.End</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Disposition.html#ac5a2baf8d1d2729ea7ddc66f6370c348">Apache.Qpid.Proton.Types.Transport.Disposition</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Detach.html#a0df6169601c8ce55c71b0b7e223f5b7d">Apache.Qpid.Proton.Types.Transport.Detach</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Close.html#ac9868ed98329f4bef1261befd3f26b6d">Apache.Qpid.Proton.Types.Transport.Close</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Begin.html#a393c0ed6970ad87deddd0bbe655b5a83">Apache.Qpid.Proton.Types.Transport.Begin</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Attach.html#a69f9cb249d5040287ec8f21ddcd321e4">Apache.Qpid.Proton.Types.Transport.Attach</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a73c4c1698ad6abc25ba0015f93974a25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73c4c1698ad6abc25ba0015f93974a25">&#9670;&nbsp;</a></span>Type</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="namespaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport.html#a1cb9d50f8c1c2a1eb89a750d839929c2">PerformativeType</a> Apache.Qpid.Proton.Types.Transport.IPerformative.Type</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides the type of this performative. </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>src/Proton/Types/Transport/IPerformative.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>