grpc/csharp-dotnet/api/Grpc.Core.Metadata.html

618 lines
23 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class Metadata
| gRPC for .NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Metadata
| gRPC for .NET ">
<meta name="generator" content="docfx 2.36.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Grpc.Core.Metadata">
<h1 id="Grpc_Core_Metadata" data-uid="Grpc.Core.Metadata" class="text-break">Class Metadata
</h1>
<div class="markdown level0 summary"><p>A collection of metadata entries that can be exchanged during a call.
gRPC supports these types of metadata:
<ul><li>Request headersare sent by the client at the beginning of a remote call before any request messages are sent.</li><li>Response headersare sent by the server at the beginning of a remote call handler before any response messages are sent.</li><li>Response trailersare sent by the server at the end of a remote call along with resulting call status.</li></ul></p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">IList</span>&lt;<a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a>&gt;</div>
<div class="level1"><span class="xref">Metadata</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
<h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
<h5 id="Grpc_Core_Metadata_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class Metadata : IList&lt;Metadata.Entry&gt;</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Grpc_Core_Metadata__ctor_" data-uid="Grpc.Core.Metadata.#ctor*"></a>
<h4 id="Grpc_Core_Metadata__ctor" data-uid="Grpc.Core.Metadata.#ctor">Metadata()</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of <code>Metadata</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Metadata()</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<h4 id="Grpc_Core_Metadata_BinaryHeaderSuffix" data-uid="Grpc.Core.Metadata.BinaryHeaderSuffix">BinaryHeaderSuffix</h4>
<div class="markdown level1 summary"><p>All binary headers should have this suffix.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string BinaryHeaderSuffix = null</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="Grpc_Core_Metadata_Empty" data-uid="Grpc.Core.Metadata.Empty">Empty</h4>
<div class="markdown level1 summary"><p>An read-only instance of metadata containing no entries.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly Metadata Empty</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Grpc_Core_Metadata_Count_" data-uid="Grpc.Core.Metadata.Count*"></a>
<h4 id="Grpc_Core_Metadata_Count" data-uid="Grpc.Core.Metadata.Count">Count</h4>
<div class="markdown level1 summary"><span class="xref">IList&lt;&gt;</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Count { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_Metadata_IsReadOnly_" data-uid="Grpc.Core.Metadata.IsReadOnly*"></a>
<h4 id="Grpc_Core_Metadata_IsReadOnly" data-uid="Grpc.Core.Metadata.IsReadOnly">IsReadOnly</h4>
<div class="markdown level1 summary"><span class="xref">IList&lt;&gt;</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsReadOnly { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_Metadata_Item_" data-uid="Grpc.Core.Metadata.Item*"></a>
<h4 id="Grpc_Core_Metadata_Item_System_Int32_" data-uid="Grpc.Core.Metadata.Item(System.Int32)">Item[Int32]</h4>
<div class="markdown level1 summary"><span class="xref">IList&lt;&gt;</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Metadata.Entry this[int index] { get; set; }</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="Grpc_Core_Metadata_Add_" data-uid="Grpc.Core.Metadata.Add*"></a>
<h4 id="Grpc_Core_Metadata_Add_Grpc_Core_Metadata_Entry_" data-uid="Grpc.Core.Metadata.Add(Grpc.Core.Metadata.Entry)">Add(Metadata.Entry)</h4>
<div class="markdown level1 summary"><span class="xref">IList&lt;&gt;</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Add(Metadata.Entry item)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a></td>
<td><span class="parametername">item</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_Metadata_Add_" data-uid="Grpc.Core.Metadata.Add*"></a>
<h4 id="Grpc_Core_Metadata_Add_System_String_System_Byte___" data-uid="Grpc.Core.Metadata.Add(System.String,System.Byte[])">Add(String, Byte[])</h4>
<div class="markdown level1 summary"><p>Adds a new binary-valued metadata entry. See <code>Metadata.Entry</code> constructor for params.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Add(string key, byte[] valueBytes)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">key</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Byte</span>[]</td>
<td><span class="parametername">valueBytes</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_Metadata_Add_" data-uid="Grpc.Core.Metadata.Add*"></a>
<h4 id="Grpc_Core_Metadata_Add_System_String_System_String_" data-uid="Grpc.Core.Metadata.Add(System.String,System.String)">Add(String, String)</h4>
<div class="markdown level1 summary"><p>Adds a new ASCII-valued metadata entry. See <code>Metadata.Entry</code> constructor for params.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Add(string key, string value)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">key</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">value</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_Metadata_Clear_" data-uid="Grpc.Core.Metadata.Clear*"></a>
<h4 id="Grpc_Core_Metadata_Clear" data-uid="Grpc.Core.Metadata.Clear">Clear()</h4>
<div class="markdown level1 summary"><span class="xref">IList&lt;&gt;</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Clear()</code></pre>
</div>
<a id="Grpc_Core_Metadata_Contains_" data-uid="Grpc.Core.Metadata.Contains*"></a>
<h4 id="Grpc_Core_Metadata_Contains_Grpc_Core_Metadata_Entry_" data-uid="Grpc.Core.Metadata.Contains(Grpc.Core.Metadata.Entry)">Contains(Metadata.Entry)</h4>
<div class="markdown level1 summary"><span class="xref">IList&lt;&gt;</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Contains(Metadata.Entry item)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a></td>
<td><span class="parametername">item</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_Metadata_CopyTo_" data-uid="Grpc.Core.Metadata.CopyTo*"></a>
<h4 id="Grpc_Core_Metadata_CopyTo_Grpc_Core_Metadata_Entry___System_Int32_" data-uid="Grpc.Core.Metadata.CopyTo(Grpc.Core.Metadata.Entry[],System.Int32)">CopyTo(Metadata.Entry[], Int32)</h4>
<div class="markdown level1 summary"><span class="xref">IList&lt;&gt;</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void CopyTo(Metadata.Entry[] array, int arrayIndex)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a>[]</td>
<td><span class="parametername">array</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">arrayIndex</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_Metadata_GetEnumerator_" data-uid="Grpc.Core.Metadata.GetEnumerator*"></a>
<h4 id="Grpc_Core_Metadata_GetEnumerator" data-uid="Grpc.Core.Metadata.GetEnumerator">GetEnumerator()</h4>
<div class="markdown level1 summary"><span class="xref">IList&lt;&gt;</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerator&lt;Metadata.Entry&gt; GetEnumerator()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">IEnumerator</span>&lt;<a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_Metadata_IndexOf_" data-uid="Grpc.Core.Metadata.IndexOf*"></a>
<h4 id="Grpc_Core_Metadata_IndexOf_Grpc_Core_Metadata_Entry_" data-uid="Grpc.Core.Metadata.IndexOf(Grpc.Core.Metadata.Entry)">IndexOf(Metadata.Entry)</h4>
<div class="markdown level1 summary"><span class="xref">IList&lt;&gt;</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int IndexOf(Metadata.Entry item)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a></td>
<td><span class="parametername">item</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_Metadata_Insert_" data-uid="Grpc.Core.Metadata.Insert*"></a>
<h4 id="Grpc_Core_Metadata_Insert_System_Int32_Grpc_Core_Metadata_Entry_" data-uid="Grpc.Core.Metadata.Insert(System.Int32,Grpc.Core.Metadata.Entry)">Insert(Int32, Metadata.Entry)</h4>
<div class="markdown level1 summary"><span class="xref">IList&lt;&gt;</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Insert(int index, Metadata.Entry item)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a></td>
<td><span class="parametername">item</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_Metadata_Remove_" data-uid="Grpc.Core.Metadata.Remove*"></a>
<h4 id="Grpc_Core_Metadata_Remove_Grpc_Core_Metadata_Entry_" data-uid="Grpc.Core.Metadata.Remove(Grpc.Core.Metadata.Entry)">Remove(Metadata.Entry)</h4>
<div class="markdown level1 summary"><span class="xref">IList&lt;&gt;</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Remove(Metadata.Entry item)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Grpc.Core.Metadata.Entry.html">Metadata.Entry</a></td>
<td><span class="parametername">item</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_Metadata_RemoveAt_" data-uid="Grpc.Core.Metadata.RemoveAt*"></a>
<h4 id="Grpc_Core_Metadata_RemoveAt_System_Int32_" data-uid="Grpc.Core.Metadata.RemoveAt(System.Int32)">RemoveAt(Int32)</h4>
<div class="markdown level1 summary"><span class="xref">IList&lt;&gt;</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void RemoveAt(int index)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>