| <!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.Client.IStreamSenderMessage 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&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&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_1Client.html">Client</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html">IStreamSenderMessage</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.IStreamSenderMessage Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A specialized streaming message type used to operate on a streamed message which allows message data to be written in one or more transfer frames to the remote allowing for very large message transmission with limited memory overhead. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Client.IStreamSenderMessage:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.png" usemap="#Apache.Qpid.Proton.Client.IStreamSenderMessage_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Client.IStreamSenderMessage_map" name="Apache.Qpid.Proton.Client.IStreamSenderMessage_map"> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html" alt="Apache.Qpid.Proton.Client.IAdvancedMessage< Stream >" shape="rect" coords="0,0,417,24"/> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamSenderMessage.html" alt="Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage" shape="rect" coords="0,112,417,136"/> |
| </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:aab87371764009d6450b77a056ae839a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html">IStreamSenderMessage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#aab87371764009d6450b77a056ae839a3">Complete</a> ()</td></tr> |
| <tr class="memdesc:aab87371764009d6450b77a056ae839a3"><td class="mdescLeft"> </td><td class="mdescRight">Marks the currently streaming message as being complete. Marking a message as complete finalizes the streaming send operation and causes a final transfer frame to be sent to the remote indicating that the ongoing streaming delivery is done and no more message data will arrive. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#aab87371764009d6450b77a056ae839a3">More...</a><br /></td></tr> |
| <tr class="separator:aab87371764009d6450b77a056ae839a3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae810c799704cf535e92b8b148029c107"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html">IStreamSenderMessage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#ae810c799704cf535e92b8b148029c107">Abort</a> ()</td></tr> |
| <tr class="memdesc:ae810c799704cf535e92b8b148029c107"><td class="mdescLeft"> </td><td class="mdescRight">Marks the currently streaming message as being aborted. Once aborted no further writes regardless of whether any writes have yet been performed or not. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#ae810c799704cf535e92b8b148029c107">More...</a><br /></td></tr> |
| <tr class="separator:ae810c799704cf535e92b8b148029c107"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5d9b760b9cd9351b7c470ced06502c99"><td class="memItemLeft" align="right" valign="top">Stream </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#a5d9b760b9cd9351b7c470ced06502c99">GetBodyStream</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html">OutputStreamOptions</a> options=null)</td></tr> |
| <tr class="memdesc:a5d9b760b9cd9351b7c470ced06502c99"><td class="mdescLeft"> </td><td class="mdescRight">Creates an write only stream instance configured with the given options which will write the bytes as the payload of one or more AMQP data sections based on the provided configuration.. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#a5d9b760b9cd9351b7c470ced06502c99">More...</a><br /></td></tr> |
| <tr class="separator:a5d9b760b9cd9351b7c470ced06502c99"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac5ce889ffc4581730ab3e4f754c3c20f"><td class="memItemLeft" align="right" valign="top">Stream </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#ac5ce889ffc4581730ab3e4f754c3c20f">RawOutputStream</a> ()</td></tr> |
| <tr class="separator:ac5ce889ffc4581730ab3e4f754c3c20f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html">Apache.Qpid.Proton.Client.IAdvancedMessage< Stream ></a></td></tr> |
| <tr class="memitem:a10cc5fc74f1a160b9edb48b4b304d5f1 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html">IAdvancedMessage</a>< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#a10cc5fc74f1a160b9edb48b4b304d5f1">AddBodySection</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1ISection.html">ISection</a> section)</td></tr> |
| <tr class="memdesc:a10cc5fc74f1a160b9edb48b4b304d5f1 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Adds the given section to the internal collection of sections that will be sent to the remote peer when this message is encoded. If a previous section was added by a call to the set body method it should be retained as the first element of the running list of body sections contained in this message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#a10cc5fc74f1a160b9edb48b4b304d5f1">More...</a><br /></td></tr> |
| <tr class="separator:a10cc5fc74f1a160b9edb48b4b304d5f1 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad0606733180f8e20cc1a6a26bf110a77 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html">IAdvancedMessage</a>< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#ad0606733180f8e20cc1a6a26bf110a77">SetBodySections</a> (IEnumerable< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1ISection.html">ISection</a> > section)</td></tr> |
| <tr class="memdesc:ad0606733180f8e20cc1a6a26bf110a77 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Sets the body section instances to use when encoding this message. The value set replaces any existing sections assigned to this message through the add body sections API or the singular body set method. Calling the set method with a null or empty enumerable is equivalent to calling the clear body sections method. The values from the passed enumerable are copied and changes to it following calls to this method are not reflected in the collection contained in this message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#ad0606733180f8e20cc1a6a26bf110a77">More...</a><br /></td></tr> |
| <tr class="separator:ad0606733180f8e20cc1a6a26bf110a77 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa2bd9e213ab637bf0e32bc9acf801264 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top">IEnumerable< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1ISection.html">ISection</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#aa2bd9e213ab637bf0e32bc9acf801264">GetBodySections</a> ()</td></tr> |
| <tr class="memdesc:aa2bd9e213ab637bf0e32bc9acf801264 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Create and return an unmodifiable read-only view that contains the section instances currently assigned to this message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#aa2bd9e213ab637bf0e32bc9acf801264">More...</a><br /></td></tr> |
| <tr class="separator:aa2bd9e213ab637bf0e32bc9acf801264 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1a05ca1d750361e63bde433f47d2f4e0 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html">IAdvancedMessage</a>< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#a1a05ca1d750361e63bde433f47d2f4e0">ClearBodySections</a> ()</td></tr> |
| <tr class="memdesc:a1a05ca1d750361e63bde433f47d2f4e0 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Clears all currently set body sections from this message instance. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#a1a05ca1d750361e63bde433f47d2f4e0">More...</a><br /></td></tr> |
| <tr class="separator:a1a05ca1d750361e63bde433f47d2f4e0 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7b8bcc3c6edc3d37b743b56be89372f5 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html">IAdvancedMessage</a>< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#a7b8bcc3c6edc3d37b743b56be89372f5">ForEachBodySection</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1ISection.html">ISection</a> > consumer)</td></tr> |
| <tr class="memdesc:a7b8bcc3c6edc3d37b743b56be89372f5 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Efficient enumeration over all currently assigned body sections in this message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#a7b8bcc3c6edc3d37b743b56be89372f5">More...</a><br /></td></tr> |
| <tr class="separator:a7b8bcc3c6edc3d37b743b56be89372f5 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac1f4c102cdc2ac11647708f04dd88141 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#ac1f4c102cdc2ac11647708f04dd88141">Encode</a> (IDictionary< string, object > deliveryAnnotations)</td></tr> |
| <tr class="memdesc:ac1f4c102cdc2ac11647708f04dd88141 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Encodes the advanced message for transmission by the client. The provided delivery annotations can be included or augmented by the advanced implementation based on the target message format. The implementation is responsible for ensuring that the delivery annotations are treated correctly encoded into the correct location in the message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#ac1f4c102cdc2ac11647708f04dd88141">More...</a><br /></td></tr> |
| <tr class="separator:ac1f4c102cdc2ac11647708f04dd88141 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </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:a16c1bb47f5eafccb4a94730fa3de83fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamTracker.html">IStreamTracker</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#a16c1bb47f5eafccb4a94730fa3de83fe">Tracker</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a16c1bb47f5eafccb4a94730fa3de83fe"><td class="mdescLeft"> </td><td class="mdescRight">Returns the stream tracker that is associated with this outgoing stream message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#a16c1bb47f5eafccb4a94730fa3de83fe">More...</a><br /></td></tr> |
| <tr class="separator:a16c1bb47f5eafccb4a94730fa3de83fe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa9d8f58a17aa7002eae4230cc181620d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSender.html">IStreamSender</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#aa9d8f58a17aa7002eae4230cc181620d">Sender</a><code> [get]</code></td></tr> |
| <tr class="memdesc:aa9d8f58a17aa7002eae4230cc181620d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the stream sender instance that owns this outgoing stream message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#aa9d8f58a17aa7002eae4230cc181620d">More...</a><br /></td></tr> |
| <tr class="separator:aa9d8f58a17aa7002eae4230cc181620d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aff263b617dd28d2825e4b5ba698d0424"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#aff263b617dd28d2825e4b5ba698d0424">Completed</a><code> [get]</code></td></tr> |
| <tr class="memdesc:aff263b617dd28d2825e4b5ba698d0424"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the outgoing stream message has been completed. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#aff263b617dd28d2825e4b5ba698d0424">More...</a><br /></td></tr> |
| <tr class="separator:aff263b617dd28d2825e4b5ba698d0424"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7dac926d26608ad734961fb26d19ada3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#a7dac926d26608ad734961fb26d19ada3">Aborted</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a7dac926d26608ad734961fb26d19ada3"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the outgoing stream message has been aborted. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#a7dac926d26608ad734961fb26d19ada3">More...</a><br /></td></tr> |
| <tr class="separator:a7dac926d26608ad734961fb26d19ada3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html">Apache.Qpid.Proton.Client.IAdvancedMessage< Stream ></a></td></tr> |
| <tr class="memitem:a5feee9911f57192bd75fb05813c14be3 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1Header.html">Header</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#a5feee9911f57192bd75fb05813c14be3">Header</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a5feee9911f57192bd75fb05813c14be3 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the AMQP Header instance that is carried in the message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#a5feee9911f57192bd75fb05813c14be3">More...</a><br /></td></tr> |
| <tr class="separator:a5feee9911f57192bd75fb05813c14be3 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a93b038cef300b2ba59fd32816504ccd6 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1Properties.html">Properties</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#a93b038cef300b2ba59fd32816504ccd6">Properties</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a93b038cef300b2ba59fd32816504ccd6 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the AMQP Properties instance that is carried in the message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#a93b038cef300b2ba59fd32816504ccd6">More...</a><br /></td></tr> |
| <tr class="separator:a93b038cef300b2ba59fd32816504ccd6 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab06b53475bba2600b2f3ee5973c2404d inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1MessageAnnotations.html">MessageAnnotations</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#ab06b53475bba2600b2f3ee5973c2404d">Annotations</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:ab06b53475bba2600b2f3ee5973c2404d inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the AMQP MessageAnnotations instance that is carried in the message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#ab06b53475bba2600b2f3ee5973c2404d">More...</a><br /></td></tr> |
| <tr class="separator:ab06b53475bba2600b2f3ee5973c2404d inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab77704943ae674031c55433125bad115 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1ApplicationProperties.html">ApplicationProperties</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#ab77704943ae674031c55433125bad115">ApplicationProperties</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:ab77704943ae674031c55433125bad115 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the AMQP ApplicationProperties instance that is carried in the message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#ab77704943ae674031c55433125bad115">More...</a><br /></td></tr> |
| <tr class="separator:ab77704943ae674031c55433125bad115 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa9008ac8b6cce4c5bb15fb36bff30260 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1Footer.html">Footer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#aa9008ac8b6cce4c5bb15fb36bff30260">Footer</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:aa9008ac8b6cce4c5bb15fb36bff30260 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the AMQP Footer instance that is carried in the message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#aa9008ac8b6cce4c5bb15fb36bff30260">More...</a><br /></td></tr> |
| <tr class="separator:aa9008ac8b6cce4c5bb15fb36bff30260 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af399fd6928471ceef6ae89db2a6103e5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#af399fd6928471ceef6ae89db2a6103e5">MessageFormat</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:af399fd6928471ceef6ae89db2a6103e5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Access the message format value present in this message. The exact structure of a message, together with its encoding, is defined by the message format (default is the AMQP defined message format zero. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#af399fd6928471ceef6ae89db2a6103e5">More...</a><br /></td></tr> |
| <tr class="separator:af399fd6928471ceef6ae89db2a6103e5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pub_static_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html">Apache.Qpid.Proton.Client.IAdvancedMessage< Stream ></a></td></tr> |
| <tr class="memitem:a38921acd559608834cd563b82021a302 inherit pub_static_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memItemLeft" align="right" valign="top">static new <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html">IAdvancedMessage</a>< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#a38921acd559608834cd563b82021a302">Create</a> ()</td></tr> |
| <tr class="memdesc:a38921acd559608834cd563b82021a302 inherit pub_static_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new advanced message instance using the Proton implementation. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#a38921acd559608834cd563b82021a302">More...</a><br /></td></tr> |
| <tr class="separator:a38921acd559608834cd563b82021a302 inherit pub_static_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A specialized streaming message type used to operate on a streamed message which allows message data to be written in one or more transfer frames to the remote allowing for very large message transmission with limited memory overhead. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae810c799704cf535e92b8b148029c107"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae810c799704cf535e92b8b148029c107">◆ </a></span>Abort()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html">IStreamSenderMessage</a> Apache.Qpid.Proton.Client.IStreamSenderMessage.Abort </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Marks the currently streaming message as being aborted. Once aborted no further writes regardless of whether any writes have yet been performed or not. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This outgoing stream message instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamSenderMessage.html#a97f8a0dec182599522661140a4fc7226">Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aab87371764009d6450b77a056ae839a3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aab87371764009d6450b77a056ae839a3">◆ </a></span>Complete()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html">IStreamSenderMessage</a> Apache.Qpid.Proton.Client.IStreamSenderMessage.Complete </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Marks the currently streaming message as being complete. Marking a message as complete finalizes the streaming send operation and causes a final transfer frame to be sent to the remote indicating that the ongoing streaming delivery is done and no more message data will arrive. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This outgoing stream message instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamSenderMessage.html#ae91c8364fdb76d64d002aaccabb6e7fd">Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a5d9b760b9cd9351b7c470ced06502c99"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5d9b760b9cd9351b7c470ced06502c99">◆ </a></span>GetBodyStream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Stream Apache.Qpid.Proton.Client.IStreamSenderMessage.GetBodyStream </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html">OutputStreamOptions</a> </td> |
| <td class="paramname"><em>options</em> = <code>null</code></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates an write only stream instance configured with the given options which will write the bytes as the payload of one or more AMQP data sections based on the provided configuration.. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">options</td><td>options to apply to the created stream</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A write only stream instance used to write the message body</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamSenderMessage.html#aeab99aa45727fda4c3612322c97721e1">Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ac5ce889ffc4581730ab3e4f754c3c20f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac5ce889ffc4581730ab3e4f754c3c20f">◆ </a></span>RawOutputStream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Stream Apache.Qpid.Proton.Client.IStreamSenderMessage.RawOutputStream </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p></p> |
| <dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientStreamSenderMessage.html#a16d804a6e17b5db723ca30f74af51ae1">Apache.Qpid.Proton.Client.Implementation.ClientStreamSenderMessage</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a7dac926d26608ad734961fb26d19ada3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7dac926d26608ad734961fb26d19ada3">◆ </a></span>Aborted</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.Client.IStreamSenderMessage.Aborted</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>Returns if the outgoing stream message has been aborted. </p> |
| |
| </div> |
| </div> |
| <a id="aff263b617dd28d2825e4b5ba698d0424"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aff263b617dd28d2825e4b5ba698d0424">◆ </a></span>Completed</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.Client.IStreamSenderMessage.Completed</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>Returns if the outgoing stream message has been completed. </p> |
| |
| </div> |
| </div> |
| <a id="aa9d8f58a17aa7002eae4230cc181620d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa9d8f58a17aa7002eae4230cc181620d">◆ </a></span>Sender</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_1Client_1_1IStreamSender.html">IStreamSender</a> Apache.Qpid.Proton.Client.IStreamSenderMessage.Sender</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>Returns the stream sender instance that owns this outgoing stream message. </p> |
| |
| </div> |
| </div> |
| <a id="a16c1bb47f5eafccb4a94730fa3de83fe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a16c1bb47f5eafccb4a94730fa3de83fe">◆ </a></span>Tracker</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_1Client_1_1IStreamTracker.html">IStreamTracker</a> Apache.Qpid.Proton.Client.IStreamSenderMessage.Tracker</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>Returns the stream tracker that is associated with this outgoing stream message. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/IStreamSenderMessage.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
