input/releases/qpid-proton-dotnet-1.0.0-M10/api/interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IUtf8StreamDecoder.html - qpid-site - Git at Google

 <!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.Codec.IUtf8StreamDecoder 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_1Codec.html">Codec</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IUtf8StreamDecoder.html">IUtf8StreamDecoder</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IUtf8StreamDecoder-members.html">List of all members</a>  </div>
   <div class="headertitle">
 <div class="title">Apache.Qpid.Proton.Codec.IUtf8StreamDecoder Interface Reference</div>  </div>
 </div><!--header-->
 <div class="contents">

 <p>Interface for an external UTF8 Decoder that can be supplied by a client which implements custom decoding logic optimized for the application using the <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Codec.html">Codec</a>.
  <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IUtf8StreamDecoder.html#details">More...</a></p>
 <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:a72552d2f858d81282ca69288d656e376"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IUtf8StreamDecoder.html#a72552d2f858d81282ca69288d656e376">DecodeUTF8</a> (Stream stream, int utf8length)</td></tr>
 <tr class="memdesc:a72552d2f858d81282ca69288d656e376"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decodes a String from the given UTF8 Bytes advancing the buffer read index by the given length value once complete. If the implementation does not advance the buffer read index the outcome of future decode calls is not defined.  <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IUtf8StreamDecoder.html#a72552d2f858d81282ca69288d656e376">More...</a><br /></td></tr>
 <tr class="separator:a72552d2f858d81282ca69288d656e376"><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>Interface for an external UTF8 Decoder that can be supplied by a client which implements custom decoding logic optimized for the application using the <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Codec.html">Codec</a>. </p>
 </div><h2 class="groupheader">Member Function Documentation</h2>
 <a id="a72552d2f858d81282ca69288d656e376"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a72552d2f858d81282ca69288d656e376">&#9670;&nbsp;</a></span>DecodeUTF8()</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">string Apache.Qpid.Proton.Codec.IUtf8StreamDecoder.DecodeUTF8 </td>
           <td>(</td>
           <td class="paramtype">Stream&#160;</td>
           <td class="paramname"><em>stream</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">int&#160;</td>
           <td class="paramname"><em>utf8length</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Decodes a String from the given UTF8 Bytes advancing the buffer read index by the given length value once complete. If the implementation does not advance the buffer read index the outcome of future decode calls is not defined. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">stream</td><td>The stream that carries the UTF8 bytes</td></tr>
     <tr><td class="paramname">utf8length</td><td>the length of the UTF8 string</td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>The decoded UTF-8 string</dd></dl>

 </div>
 </div>
 <hr/>The documentation for this interface was generated from the following file:<ul>
 <li>src/Proton/Codec/Decoders/IUtf8StreamDecoder.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>
	<!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.Codec.IUtf8StreamDecoder 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_1Codec.html">Codec</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IUtf8StreamDecoder.html">IUtf8StreamDecoder</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#pub-methods">Public Member Functions</a> \|
	<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IUtf8StreamDecoder-members.html">List of all members</a> </div>
	<div class="headertitle">
	<div class="title">Apache.Qpid.Proton.Codec.IUtf8StreamDecoder Interface Reference</div> </div>
	</div><!--header-->
	<div class="contents">

	<p>Interface for an external UTF8 Decoder that can be supplied by a client which implements custom decoding logic optimized for the application using the <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Codec.html">Codec</a>.
	<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IUtf8StreamDecoder.html#details">More...</a></p>
	<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:a72552d2f858d81282ca69288d656e376"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IUtf8StreamDecoder.html#a72552d2f858d81282ca69288d656e376">DecodeUTF8</a> (Stream stream, int utf8length)</td></tr>
	<tr class="memdesc:a72552d2f858d81282ca69288d656e376"><td class="mdescLeft"> </td><td class="mdescRight">Decodes a String from the given UTF8 Bytes advancing the buffer read index by the given length value once complete. If the implementation does not advance the buffer read index the outcome of future decode calls is not defined. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IUtf8StreamDecoder.html#a72552d2f858d81282ca69288d656e376">More...</a><br /></td></tr>
	<tr class="separator:a72552d2f858d81282ca69288d656e376"><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 for an external UTF8 Decoder that can be supplied by a client which implements custom decoding logic optimized for the application using the <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Codec.html">Codec</a>. </p>
	</div><h2 class="groupheader">Member Function Documentation</h2>
	<a id="a72552d2f858d81282ca69288d656e376"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a72552d2f858d81282ca69288d656e376">◆ </a></span>DecodeUTF8()</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">string Apache.Qpid.Proton.Codec.IUtf8StreamDecoder.DecodeUTF8 </td>
	<td>(</td>
	<td class="paramtype">Stream </td>
	<td class="paramname"><em>stream</em>, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype">int </td>
	<td class="paramname"><em>utf8length</em> </td>
	</tr>
	<tr>
	<td></td>
	<td>)</td>
	<td></td><td></td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Decodes a String from the given UTF8 Bytes advancing the buffer read index by the given length value once complete. If the implementation does not advance the buffer read index the outcome of future decode calls is not defined. </p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramname">stream</td><td>The stream that carries the UTF8 bytes</td></tr>
	<tr><td class="paramname">utf8length</td><td>the length of the UTF8 string</td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section return"><dt>Returns</dt><dd>The decoded UTF-8 string</dd></dl>

	</div>
	</div>
	<hr/>The documentation for this interface was generated from the following file:<ul>
	<li>src/Proton/Codec/Decoders/IUtf8StreamDecoder.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>