carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365
							<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class Server
   | gRPC C# </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class Server
   | 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.Server">
  
  
  <h1 id="Grpc_Core_Server" data-uid="Grpc.Core.Server" class="text-break">Class Server
  </h1>
  <div class="markdown level0 summary"><p>gRPC server. A single server can serve an arbitrary number of services and can listen on more than one port.</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">Server</span></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <span class="xref">System.Object.Equals(System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.GetHashCode()</span>
    </div>
    <div>
      <span class="xref">System.Object.GetType()</span>
    </div>
    <div>
      <span class="xref">System.Object.MemberwiseClone()</span>
    </div>
    <div>
      <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.ToString()</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_Server_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class Server</code></pre>
  </div>
  <h3 id="constructors">Constructors
  </h3>
  <a id="Grpc_Core_Server__ctor_" data-uid="Grpc.Core.Server.#ctor*"></a>
  <h4 id="Grpc_Core_Server__ctor" data-uid="Grpc.Core.Server.#ctor">Server()</h4>
  <div class="markdown level1 summary"><p>Creates a new server.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Server()</code></pre>
  </div>
  <a id="Grpc_Core_Server__ctor_" data-uid="Grpc.Core.Server.#ctor*"></a>
  <h4 id="Grpc_Core_Server__ctor_System_Collections_Generic_IEnumerable_Grpc_Core_ChannelOption__" data-uid="Grpc.Core.Server.#ctor(System.Collections.Generic.IEnumerable{Grpc.Core.ChannelOption})">Server(IEnumerable&lt;ChannelOption&gt;)</h4>
  <div class="markdown level1 summary"><p>Creates a new server.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Server(IEnumerable&lt;ChannelOption&gt; 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><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Grpc.Core.ChannelOption.html">ChannelOption</a>&gt;</td>
        <td><span class="parametername">options</span></td>
        <td><p>Channel options.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
  </h3>
  <a id="Grpc_Core_Server_Ports_" data-uid="Grpc.Core.Server.Ports*"></a>
  <h4 id="Grpc_Core_Server_Ports" data-uid="Grpc.Core.Server.Ports">Ports</h4>
  <div class="markdown level1 summary"><p>Ports on which the server will listen once started. Register a port with this
server by adding its definition to this collection.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Server.ServerPortCollection Ports { 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.Server.ServerPortCollection.html">Server.ServerPortCollection</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="Grpc_Core_Server_RequestCallTokensPerCompletionQueue_" data-uid="Grpc.Core.Server.RequestCallTokensPerCompletionQueue*"></a>
  <h4 id="Grpc_Core_Server_RequestCallTokensPerCompletionQueue" data-uid="Grpc.Core.Server.RequestCallTokensPerCompletionQueue">RequestCallTokensPerCompletionQueue</h4>
  <div class="markdown level1 summary"><p>Experimental API. Might anytime change without prior notice.
Number or calls requested via grpc_server_request_call at any given time for each completion queue.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int RequestCallTokensPerCompletionQueue { get; set; }</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_Server_Services_" data-uid="Grpc.Core.Server.Services*"></a>
  <h4 id="Grpc_Core_Server_Services" data-uid="Grpc.Core.Server.Services">Services</h4>
  <div class="markdown level1 summary"><p>Services that will be exported by the server once started. Register a service with this
server by adding its definition to this collection.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Server.ServiceDefinitionCollection Services { 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.Server.ServiceDefinitionCollection.html">Server.ServiceDefinitionCollection</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="Grpc_Core_Server_ShutdownTask_" data-uid="Grpc.Core.Server.ShutdownTask*"></a>
  <h4 id="Grpc_Core_Server_ShutdownTask" data-uid="Grpc.Core.Server.ShutdownTask">ShutdownTask</h4>
  <div class="markdown level1 summary"><p>To allow awaiting termination of the server.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Task ShutdownTask { 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.Threading.Tasks.Task</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
  </h3>
  <a id="Grpc_Core_Server_KillAsync_" data-uid="Grpc.Core.Server.KillAsync*"></a>
  <h4 id="Grpc_Core_Server_KillAsync" data-uid="Grpc.Core.Server.KillAsync">KillAsync()</h4>
  <div class="markdown level1 summary"><p>Requests server shutdown while cancelling all the in-progress calls.
The returned task finishes when shutdown procedure is complete.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Task KillAsync()</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">System.Threading.Tasks.Task</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="Grpc_Core_Server_KillAsync_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>It is strongly recommended to shutdown all previously created servers before exiting from the process.</p>
</div>
  <a id="Grpc_Core_Server_ShutdownAsync_" data-uid="Grpc.Core.Server.ShutdownAsync*"></a>
  <h4 id="Grpc_Core_Server_ShutdownAsync" data-uid="Grpc.Core.Server.ShutdownAsync">ShutdownAsync()</h4>
  <div class="markdown level1 summary"><p>Requests server shutdown and when there are no more calls being serviced,
cleans up used resources. The returned task finishes when shutdown procedure
is complete.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Task ShutdownAsync()</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">System.Threading.Tasks.Task</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="Grpc_Core_Server_ShutdownAsync_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>It is strongly recommended to shutdown all previously created servers before exiting from the process.</p>
</div>
  <a id="Grpc_Core_Server_Start_" data-uid="Grpc.Core.Server.Start*"></a>
  <h4 id="Grpc_Core_Server_Start" data-uid="Grpc.Core.Server.Start">Start()</h4>
  <div class="markdown level1 summary"><p>Starts the server.
Throws <code>IOException</code> if not all ports have been bound successfully (see <code>Ports.Add</code> method).
Even if some of that ports haven&apos;t been bound, the server will still serve normally on all ports that have been
bound successfully (and the user is expected to shutdown the server by invoking <code>ShutdownAsync</code> or <code>KillAsync</code>).</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public void Start()</code></pre>
  </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>