grpc/csharp-dotnet/api/Grpc.Core.Method-2.html

361 lines
14 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 Method&lt;TRequest, TResponse&gt;
| gRPC for .NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Method&lt;TRequest, TResponse&gt;
| 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.Method`2">
<h1 id="Grpc_Core_Method_2" data-uid="Grpc.Core.Method`2" class="text-break">Class Method&lt;TRequest, TResponse&gt;
</h1>
<div class="markdown level0 summary"><p>A description of a remote method.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">Method&lt;TRequest, TResponse&gt;</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Grpc.Core.IMethod.html">IMethod</a></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_Method_2_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class Method&lt;TRequest, TResponse&gt; : object, IMethod</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 this method.</p>
</td>
</tr>
<tr>
<td><span class="parametername">TResponse</span></td>
<td><p>Response message type for this method.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="constructors">Constructors
</h3>
<a id="Grpc_Core_Method_2__ctor_" data-uid="Grpc.Core.Method`2.#ctor*"></a>
<h4 id="Grpc_Core_Method_2__ctor_Grpc_Core_MethodType_System_String_System_String_Grpc_Core_Marshaller__0__Grpc_Core_Marshaller__1__" data-uid="Grpc.Core.Method`2.#ctor(Grpc.Core.MethodType,System.String,System.String,Grpc.Core.Marshaller{`0},Grpc.Core.Marshaller{`1})">Method(MethodType, String, String, Marshaller&lt;TRequest&gt;, Marshaller&lt;TResponse&gt;)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <code>Method</code> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Method(MethodType type, string serviceName, string name, Marshaller&lt;TRequest&gt; requestMarshaller, Marshaller&lt;TResponse&gt; responseMarshaller)</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.MethodType.html">MethodType</a></td>
<td><span class="parametername">type</span></td>
<td><p>Type of method.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">serviceName</span></td>
<td><p>Name of service this method belongs to.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>Unqualified name of 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>Marshaller used for request messages.</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>Marshaller used for response messages.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Grpc_Core_Method_2_FullName_" data-uid="Grpc.Core.Method`2.FullName*"></a>
<h4 id="Grpc_Core_Method_2_FullName" data-uid="Grpc.Core.Method`2.FullName">FullName</h4>
<div class="markdown level1 summary"><p>Gets the fully qualified name of the method. On the server side, methods are dispatched
based on this name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string FullName { 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_Method_2_Name_" data-uid="Grpc.Core.Method`2.Name*"></a>
<h4 id="Grpc_Core_Method_2_Name" data-uid="Grpc.Core.Method`2.Name">Name</h4>
<div class="markdown level1 summary"><p>Gets the unqualified name of the method.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Name { 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_Method_2_RequestMarshaller_" data-uid="Grpc.Core.Method`2.RequestMarshaller*"></a>
<h4 id="Grpc_Core_Method_2_RequestMarshaller" data-uid="Grpc.Core.Method`2.RequestMarshaller">RequestMarshaller</h4>
<div class="markdown level1 summary"><p>Gets the marshaller used for request messages.</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_Method_2_ResponseMarshaller_" data-uid="Grpc.Core.Method`2.ResponseMarshaller*"></a>
<h4 id="Grpc_Core_Method_2_ResponseMarshaller" data-uid="Grpc.Core.Method`2.ResponseMarshaller">ResponseMarshaller</h4>
<div class="markdown level1 summary"><p>Gets the marshaller used for response messages.</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>
<a id="Grpc_Core_Method_2_ServiceName_" data-uid="Grpc.Core.Method`2.ServiceName*"></a>
<h4 id="Grpc_Core_Method_2_ServiceName" data-uid="Grpc.Core.Method`2.ServiceName">ServiceName</h4>
<div class="markdown level1 summary"><p>Gets the name of the service to which this method belongs.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ServiceName { 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_Method_2_Type_" data-uid="Grpc.Core.Method`2.Type*"></a>
<h4 id="Grpc_Core_Method_2_Type" data-uid="Grpc.Core.Method`2.Type">Type</h4>
<div class="markdown level1 summary"><p>Gets the type of the method.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MethodType Type { 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.MethodType.html">MethodType</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Grpc.Core.IMethod.html">IMethod</a>
</div>
</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>