Grpc.Core.Server.ServerPortCollection.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class Server.ServerPortCollection
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Server.ServerPortCollection
  11. | gRPC C# ">
  12. <meta name="generator" content="docfx 2.23.1.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../index.html">
  34. <img id="logo" class="svg" src="../logo.svg" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items"></div>
  58. <ul id="pagination"></ul>
  59. </div>
  60. </div>
  61. <div role="main" class="container body-content hide-when-search">
  62. <div class="sidenav hide-when-search">
  63. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  64. <div class="sidetoggle collapse" id="sidetoggle">
  65. <div id="sidetoc"></div>
  66. </div>
  67. </div>
  68. <div class="article row grid-right">
  69. <div class="col-md-10">
  70. <article class="content wrap" id="_content" data-uid="Grpc.Core.Server.ServerPortCollection">
  71. <h1 id="Grpc_Core_Server_ServerPortCollection" data-uid="Grpc.Core.Server.ServerPortCollection" class="text-break">Class Server.ServerPortCollection
  72. </h1>
  73. <div class="markdown level0 summary"><p>Collection of server ports.</p>
  74. </div>
  75. <div class="markdown level0 conceptual"></div>
  76. <div class="inheritance">
  77. <h5>Inheritance</h5>
  78. <div class="level0"><span class="xref">System.Object</span></div>
  79. <div class="level1"><span class="xref">Server.ServerPortCollection</span></div>
  80. </div>
  81. <div class="inheritedMembers">
  82. <h5>Inherited Members</h5>
  83. <div>
  84. <span class="xref">System.Object.ToString()</span>
  85. </div>
  86. <div>
  87. <span class="xref">System.Object.Equals(System.Object)</span>
  88. </div>
  89. <div>
  90. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  91. </div>
  92. <div>
  93. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.GetHashCode()</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.GetType()</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Object.MemberwiseClone()</span>
  103. </div>
  104. </div>
  105. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  106. <h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
  107. <h5 id="Grpc_Core_Server_ServerPortCollection_syntax">Syntax</h5>
  108. <div class="codewrapper">
  109. <pre><code class="lang-csharp hljs">public class ServerPortCollection : IEnumerable&lt;ServerPort&gt;, IEnumerable</code></pre>
  110. </div>
  111. <h3 id="methods">Methods
  112. </h3>
  113. <a id="Grpc_Core_Server_ServerPortCollection_Add_" data-uid="Grpc.Core.Server.ServerPortCollection.Add*"></a>
  114. <h4 id="Grpc_Core_Server_ServerPortCollection_Add_Grpc_Core_ServerPort_" data-uid="Grpc.Core.Server.ServerPortCollection.Add(Grpc.Core.ServerPort)">Add(ServerPort)</h4>
  115. <div class="markdown level1 summary"><p>Adds a new port on which server should listen.
  116. Only call this before Start().
  117. <returns>The port on which server will be listening.</returns></p>
  118. </div>
  119. <div class="markdown level1 conceptual"></div>
  120. <h5 class="decalaration">Declaration</h5>
  121. <div class="codewrapper">
  122. <pre><code class="lang-csharp hljs">public int Add(ServerPort serverPort)</code></pre>
  123. </div>
  124. <h5 class="parameters">Parameters</h5>
  125. <table class="table table-bordered table-striped table-condensed">
  126. <thead>
  127. <tr>
  128. <th>Type</th>
  129. <th>Name</th>
  130. <th>Description</th>
  131. </tr>
  132. </thead>
  133. <tbody>
  134. <tr>
  135. <td><a class="xref" href="Grpc.Core.ServerPort.html">ServerPort</a></td>
  136. <td><span class="parametername">serverPort</span></td>
  137. <td></td>
  138. </tr>
  139. </tbody>
  140. </table>
  141. <h5 class="returns">Returns</h5>
  142. <table class="table table-bordered table-striped table-condensed">
  143. <thead>
  144. <tr>
  145. <th>Type</th>
  146. <th>Description</th>
  147. </tr>
  148. </thead>
  149. <tbody>
  150. <tr>
  151. <td><span class="xref">System.Int32</span></td>
  152. <td></td>
  153. </tr>
  154. </tbody>
  155. </table>
  156. <a id="Grpc_Core_Server_ServerPortCollection_Add_" data-uid="Grpc.Core.Server.ServerPortCollection.Add*"></a>
  157. <h4 id="Grpc_Core_Server_ServerPortCollection_Add_System_String_System_Int32_Grpc_Core_ServerCredentials_" data-uid="Grpc.Core.Server.ServerPortCollection.Add(System.String,System.Int32,Grpc.Core.ServerCredentials)">Add(String, Int32, ServerCredentials)</h4>
  158. <div class="markdown level1 summary"><p>Adds a new port on which server should listen.
  159. <returns>The port on which server will be listening.</returns></p>
  160. </div>
  161. <div class="markdown level1 conceptual"></div>
  162. <h5 class="decalaration">Declaration</h5>
  163. <div class="codewrapper">
  164. <pre><code class="lang-csharp hljs">public int Add(string host, int port, ServerCredentials credentials)</code></pre>
  165. </div>
  166. <h5 class="parameters">Parameters</h5>
  167. <table class="table table-bordered table-striped table-condensed">
  168. <thead>
  169. <tr>
  170. <th>Type</th>
  171. <th>Name</th>
  172. <th>Description</th>
  173. </tr>
  174. </thead>
  175. <tbody>
  176. <tr>
  177. <td><span class="xref">System.String</span></td>
  178. <td><span class="parametername">host</span></td>
  179. <td><p>the host</p>
  180. </td>
  181. </tr>
  182. <tr>
  183. <td><span class="xref">System.Int32</span></td>
  184. <td><span class="parametername">port</span></td>
  185. <td><p>the port. If zero, an unused port is chosen automatically.</p>
  186. </td>
  187. </tr>
  188. <tr>
  189. <td><a class="xref" href="Grpc.Core.ServerCredentials.html">ServerCredentials</a></td>
  190. <td><span class="parametername">credentials</span></td>
  191. <td><p>credentials to use to secure this port.</p>
  192. </td>
  193. </tr>
  194. </tbody>
  195. </table>
  196. <h5 class="returns">Returns</h5>
  197. <table class="table table-bordered table-striped table-condensed">
  198. <thead>
  199. <tr>
  200. <th>Type</th>
  201. <th>Description</th>
  202. </tr>
  203. </thead>
  204. <tbody>
  205. <tr>
  206. <td><span class="xref">System.Int32</span></td>
  207. <td></td>
  208. </tr>
  209. </tbody>
  210. </table>
  211. <a id="Grpc_Core_Server_ServerPortCollection_GetEnumerator_" data-uid="Grpc.Core.Server.ServerPortCollection.GetEnumerator*"></a>
  212. <h4 id="Grpc_Core_Server_ServerPortCollection_GetEnumerator" data-uid="Grpc.Core.Server.ServerPortCollection.GetEnumerator">GetEnumerator()</h4>
  213. <div class="markdown level1 summary"><p>Gets enumerator for this collection.</p>
  214. </div>
  215. <div class="markdown level1 conceptual"></div>
  216. <h5 class="decalaration">Declaration</h5>
  217. <div class="codewrapper">
  218. <pre><code class="lang-csharp hljs">public IEnumerator&lt;ServerPort&gt; GetEnumerator()</code></pre>
  219. </div>
  220. <h5 class="returns">Returns</h5>
  221. <table class="table table-bordered table-striped table-condensed">
  222. <thead>
  223. <tr>
  224. <th>Type</th>
  225. <th>Description</th>
  226. </tr>
  227. </thead>
  228. <tbody>
  229. <tr>
  230. <td><span class="xref">System.Collections.Generic.IEnumerator</span>&lt;<a class="xref" href="Grpc.Core.ServerPort.html">ServerPort</a>&gt;</td>
  231. <td></td>
  232. </tr>
  233. </tbody>
  234. </table>
  235. <h5 class="implements">Implements</h5>
  236. <div><span class="xref">System.Collections.Generic.IEnumerable&lt;T&gt;.GetEnumerator()</span></div>
  237. <h3 id="eii">Explicit Interface Implementations
  238. </h3>
  239. <a id="Grpc_Core_Server_ServerPortCollection_System_Collections_IEnumerable_GetEnumerator_" data-uid="Grpc.Core.Server.ServerPortCollection.System#Collections#IEnumerable#GetEnumerator*"></a>
  240. <h4 id="Grpc_Core_Server_ServerPortCollection_System_Collections_IEnumerable_GetEnumerator" data-uid="Grpc.Core.Server.ServerPortCollection.System#Collections#IEnumerable#GetEnumerator">IEnumerable.GetEnumerator()</h4>
  241. <div class="markdown level1 summary"></div>
  242. <div class="markdown level1 conceptual"></div>
  243. <h5 class="decalaration">Declaration</h5>
  244. <div class="codewrapper">
  245. <pre><code class="lang-csharp hljs">IEnumerator IEnumerable.GetEnumerator()</code></pre>
  246. </div>
  247. <h5 class="returns">Returns</h5>
  248. <table class="table table-bordered table-striped table-condensed">
  249. <thead>
  250. <tr>
  251. <th>Type</th>
  252. <th>Description</th>
  253. </tr>
  254. </thead>
  255. <tbody>
  256. <tr>
  257. <td><span class="xref">System.Collections.IEnumerator</span></td>
  258. <td></td>
  259. </tr>
  260. </tbody>
  261. </table>
  262. <h5 class="implements">Implements</h5>
  263. <div><span class="xref">System.Collections.IEnumerable.GetEnumerator()</span></div>
  264. </article>
  265. </div>
  266. <div class="hidden-sm col-md-2" role="complementary">
  267. <div class="sideaffix">
  268. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  269. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  270. </nav>
  271. </div>
  272. </div>
  273. </div>
  274. </div>
  275. <footer>
  276. <div class="grad-bottom"></div>
  277. <div class="footer">
  278. <div class="container">
  279. <span class="pull-right">
  280. <a href="#top">Back to top</a>
  281. </span>
  282. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  283. </div>
  284. </div>
  285. </footer>
  286. </div>
  287. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  288. <script type="text/javascript" src="../styles/docfx.js"></script>
  289. <script type="text/javascript" src="../styles/main.js"></script>
  290. </body>
  291. </html>