grpc/csharp/api/Grpc.Core.CallInvocationDet...

502 lines
20 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>Struct CallInvocationDetails&lt;TRequest, TResponse&gt;
| gRPC C# </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Struct CallInvocationDetails&lt;TRequest, TResponse&gt;
| gRPC C# ">
<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.CallInvocationDetails`2">
<h1 id="Grpc_Core_CallInvocationDetails_2" data-uid="Grpc.Core.CallInvocationDetails`2" class="text-break">Struct CallInvocationDetails&lt;TRequest, TResponse&gt;
</h1>
<div class="markdown level0 summary"><p>Details about a client-side call to be invoked.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.ValueType.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.ValueType.GetHashCode()</span>
</div>
<div>
<span class="xref">System.ValueType.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
<h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
<h5 id="Grpc_Core_CallInvocationDetails_2_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public struct CallInvocationDetails&lt;TRequest, TResponse&gt;</code></pre>
</div>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">TRequest</span></td>
<td><p>Request message type for the call.</p>
</td>
</tr>
<tr>
<td><span class="parametername">TResponse</span></td>
<td><p>Response message type for the call.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="constructors">Constructors
</h3>
<a id="Grpc_Core_CallInvocationDetails_2__ctor_" data-uid="Grpc.Core.CallInvocationDetails`2.#ctor*"></a>
<h4 id="Grpc_Core_CallInvocationDetails_2__ctor_Grpc_Core_Channel_Grpc_Core_Method__0__1__Grpc_Core_CallOptions_" data-uid="Grpc.Core.CallInvocationDetails`2.#ctor(Grpc.Core.Channel,Grpc.Core.Method{`0,`1},Grpc.Core.CallOptions)">CallInvocationDetails(Channel, Method&lt;TRequest, TResponse&gt;, CallOptions)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Grpc.Core.CallInvocationDetails-2.html">CallInvocationDetails&lt;TRequest, TResponse&gt;</a> struct.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CallInvocationDetails(Channel channel, Method&lt;TRequest, TResponse&gt; method, CallOptions options)</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.Channel.html">Channel</a></td>
<td><span class="parametername">channel</span></td>
<td><p>Channel to use for this call.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
<td><span class="parametername">method</span></td>
<td><p>Method to call.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>Call options.</p>
</td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_CallInvocationDetails_2__ctor_" data-uid="Grpc.Core.CallInvocationDetails`2.#ctor*"></a>
<h4 id="Grpc_Core_CallInvocationDetails_2__ctor_Grpc_Core_Channel_Grpc_Core_Method__0__1__System_String_Grpc_Core_CallOptions_" data-uid="Grpc.Core.CallInvocationDetails`2.#ctor(Grpc.Core.Channel,Grpc.Core.Method{`0,`1},System.String,Grpc.Core.CallOptions)">CallInvocationDetails(Channel, Method&lt;TRequest, TResponse&gt;, String, CallOptions)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Grpc.Core.CallInvocationDetails-2.html">CallInvocationDetails&lt;TRequest, TResponse&gt;</a> struct.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CallInvocationDetails(Channel channel, Method&lt;TRequest, TResponse&gt; method, string host, CallOptions options)</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.Channel.html">Channel</a></td>
<td><span class="parametername">channel</span></td>
<td><p>Channel to use for this call.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
<td><span class="parametername">method</span></td>
<td><p>Method to call.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">host</span></td>
<td><p>Host that contains the method. if <code>null</code>, default host will be used.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>Call options.</p>
</td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_CallInvocationDetails_2__ctor_" data-uid="Grpc.Core.CallInvocationDetails`2.#ctor*"></a>
<h4 id="Grpc_Core_CallInvocationDetails_2__ctor_Grpc_Core_Channel_System_String_System_String_Grpc_Core_Marshaller__0__Grpc_Core_Marshaller__1__Grpc_Core_CallOptions_" data-uid="Grpc.Core.CallInvocationDetails`2.#ctor(Grpc.Core.Channel,System.String,System.String,Grpc.Core.Marshaller{`0},Grpc.Core.Marshaller{`1},Grpc.Core.CallOptions)">CallInvocationDetails(Channel, String, String, Marshaller&lt;TRequest&gt;, Marshaller&lt;TResponse&gt;, CallOptions)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Grpc.Core.CallInvocationDetails-2.html">CallInvocationDetails&lt;TRequest, TResponse&gt;</a> struct.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CallInvocationDetails(Channel channel, string method, string host, Marshaller&lt;TRequest&gt; requestMarshaller, Marshaller&lt;TResponse&gt; responseMarshaller, CallOptions options)</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.Channel.html">Channel</a></td>
<td><span class="parametername">channel</span></td>
<td><p>Channel to use for this call.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">method</span></td>
<td><p>Qualified method name.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">host</span></td>
<td><p>Host that contains the method.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.Marshaller-1.html">Marshaller</a>&lt;TRequest&gt;</td>
<td><span class="parametername">requestMarshaller</span></td>
<td><p>Request marshaller.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.Marshaller-1.html">Marshaller</a>&lt;TResponse&gt;</td>
<td><span class="parametername">responseMarshaller</span></td>
<td><p>Response marshaller.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>Call options.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Grpc_Core_CallInvocationDetails_2_Channel_" data-uid="Grpc.Core.CallInvocationDetails`2.Channel*"></a>
<h4 id="Grpc_Core_CallInvocationDetails_2_Channel" data-uid="Grpc.Core.CallInvocationDetails`2.Channel">Channel</h4>
<div class="markdown level1 summary"><p>Get channel associated with this call.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Channel Channel { 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><a class="xref" href="Grpc.Core.Channel.html">Channel</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_CallInvocationDetails_2_Host_" data-uid="Grpc.Core.CallInvocationDetails`2.Host*"></a>
<h4 id="Grpc_Core_CallInvocationDetails_2_Host" data-uid="Grpc.Core.CallInvocationDetails`2.Host">Host</h4>
<div class="markdown level1 summary"><p>Get name of host.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Host { 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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_CallInvocationDetails_2_Method_" data-uid="Grpc.Core.CallInvocationDetails`2.Method*"></a>
<h4 id="Grpc_Core_CallInvocationDetails_2_Method" data-uid="Grpc.Core.CallInvocationDetails`2.Method">Method</h4>
<div class="markdown level1 summary"><p>Gets name of method to be called.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Method { 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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_CallInvocationDetails_2_Options_" data-uid="Grpc.Core.CallInvocationDetails`2.Options*"></a>
<h4 id="Grpc_Core_CallInvocationDetails_2_Options" data-uid="Grpc.Core.CallInvocationDetails`2.Options">Options</h4>
<div class="markdown level1 summary"><p>Gets the call options.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CallOptions Options { 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><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_CallInvocationDetails_2_RequestMarshaller_" data-uid="Grpc.Core.CallInvocationDetails`2.RequestMarshaller*"></a>
<h4 id="Grpc_Core_CallInvocationDetails_2_RequestMarshaller" data-uid="Grpc.Core.CallInvocationDetails`2.RequestMarshaller">RequestMarshaller</h4>
<div class="markdown level1 summary"><p>Gets marshaller used to serialize requests.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Marshaller&lt;TRequest&gt; RequestMarshaller { 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><a class="xref" href="Grpc.Core.Marshaller-1.html">Marshaller</a>&lt;TRequest&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_CallInvocationDetails_2_ResponseMarshaller_" data-uid="Grpc.Core.CallInvocationDetails`2.ResponseMarshaller*"></a>
<h4 id="Grpc_Core_CallInvocationDetails_2_ResponseMarshaller" data-uid="Grpc.Core.CallInvocationDetails`2.ResponseMarshaller">ResponseMarshaller</h4>
<div class="markdown level1 summary"><p>Gets marshaller used to deserialized responses.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Marshaller&lt;TResponse&gt; ResponseMarshaller { 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><a class="xref" href="Grpc.Core.Marshaller-1.html">Marshaller</a>&lt;TResponse&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="Grpc_Core_CallInvocationDetails_2_WithOptions_" data-uid="Grpc.Core.CallInvocationDetails`2.WithOptions*"></a>
<h4 id="Grpc_Core_CallInvocationDetails_2_WithOptions_Grpc_Core_CallOptions_" data-uid="Grpc.Core.CallInvocationDetails`2.WithOptions(Grpc.Core.CallOptions)">WithOptions(CallOptions)</h4>
<div class="markdown level1 summary"><p>Returns new instance of <a class="xref" href="Grpc.Core.CallInvocationDetails-2.html">CallInvocationDetails&lt;TRequest, TResponse&gt;</a> with
<code>Options</code> set to the value provided. Values of all other fields are preserved.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CallInvocationDetails&lt;TRequest, TResponse&gt; WithOptions(CallOptions options)</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.CallOptions.html">CallOptions</a></td>
<td><span class="parametername">options</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><a class="xref" href="Grpc.Core.CallInvocationDetails-2.html">CallInvocationDetails</a>&lt;TRequest, TResponse&gt;</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>