Grpc.Health.V1.Health.html 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  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 Health
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Health
  11. | gRPC C# ">
  12. <meta name="generator" content="docfx 2.36.0.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" data-offset="120">
  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">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Grpc.Health.V1.Health">
  73. <h1 id="Grpc_Health_V1_Health" data-uid="Grpc.Health.V1.Health" class="text-break">Class Health
  74. </h1>
  75. <div class="markdown level0 summary"></div>
  76. <div class="markdown level0 conceptual"></div>
  77. <div class="inheritance">
  78. <h5>Inheritance</h5>
  79. <div class="level0"><span class="xref">System.Object</span></div>
  80. <div class="level1"><span class="xref">Health</span></div>
  81. </div>
  82. <div class="inheritedMembers">
  83. <h5>Inherited Members</h5>
  84. <div>
  85. <span class="xref">System.Object.Equals(System.Object)</span>
  86. </div>
  87. <div>
  88. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  89. </div>
  90. <div>
  91. <span class="xref">System.Object.GetHashCode()</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.GetType()</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.MemberwiseClone()</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.ToString()</span>
  104. </div>
  105. </div>
  106. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Health.V1.html">Grpc.Health.V1</a></h6>
  107. <h6><strong>Assembly</strong>: Grpc.HealthCheck.dll</h6>
  108. <h5 id="Grpc_Health_V1_Health_syntax">Syntax</h5>
  109. <div class="codewrapper">
  110. <pre><code class="lang-csharp hljs">public static class Health</code></pre>
  111. </div>
  112. <h3 id="properties">Properties
  113. </h3>
  114. <a id="Grpc_Health_V1_Health_Descriptor_" data-uid="Grpc.Health.V1.Health.Descriptor*"></a>
  115. <h4 id="Grpc_Health_V1_Health_Descriptor" data-uid="Grpc.Health.V1.Health.Descriptor">Descriptor</h4>
  116. <div class="markdown level1 summary"><p>Service descriptor</p>
  117. </div>
  118. <div class="markdown level1 conceptual"></div>
  119. <h5 class="decalaration">Declaration</h5>
  120. <div class="codewrapper">
  121. <pre><code class="lang-csharp hljs">public static Google.Protobuf.Reflection.ServiceDescriptor Descriptor { get; }</code></pre>
  122. </div>
  123. <h5 class="propertyValue">Property Value</h5>
  124. <table class="table table-bordered table-striped table-condensed">
  125. <thead>
  126. <tr>
  127. <th>Type</th>
  128. <th>Description</th>
  129. </tr>
  130. </thead>
  131. <tbody>
  132. <tr>
  133. <td><span class="xref">Google.Protobuf.Reflection.ServiceDescriptor</span></td>
  134. <td></td>
  135. </tr>
  136. </tbody>
  137. </table>
  138. <h3 id="methods">Methods
  139. </h3>
  140. <a id="Grpc_Health_V1_Health_BindService_" data-uid="Grpc.Health.V1.Health.BindService*"></a>
  141. <h4 id="Grpc_Health_V1_Health_BindService_Grpc_Core_ServiceBinderBase_Grpc_Health_V1_Health_HealthBase_" data-uid="Grpc.Health.V1.Health.BindService(Grpc.Core.ServiceBinderBase,Grpc.Health.V1.Health.HealthBase)">BindService(ServiceBinderBase, Health.HealthBase)</h4>
  142. <div class="markdown level1 summary"><p>Register service method with a service binder with or without implementation. Useful when customizing the service binding logic.
  143. Note: this method is part of an experimental API that can change or be removed without any prior notice.</p>
  144. </div>
  145. <div class="markdown level1 conceptual"></div>
  146. <h5 class="decalaration">Declaration</h5>
  147. <div class="codewrapper">
  148. <pre><code class="lang-csharp hljs">public static void BindService(ServiceBinderBase serviceBinder, Health.HealthBase serviceImpl)</code></pre>
  149. </div>
  150. <h5 class="parameters">Parameters</h5>
  151. <table class="table table-bordered table-striped table-condensed">
  152. <thead>
  153. <tr>
  154. <th>Type</th>
  155. <th>Name</th>
  156. <th>Description</th>
  157. </tr>
  158. </thead>
  159. <tbody>
  160. <tr>
  161. <td><a class="xref" href="Grpc.Core.ServiceBinderBase.html">ServiceBinderBase</a></td>
  162. <td><span class="parametername">serviceBinder</span></td>
  163. <td><p>Service methods will be bound by calling <code>AddMethod</code> on this object.</p>
  164. </td>
  165. </tr>
  166. <tr>
  167. <td><a class="xref" href="Grpc.Health.V1.Health.HealthBase.html">Health.HealthBase</a></td>
  168. <td><span class="parametername">serviceImpl</span></td>
  169. <td><p>An object implementing the server-side handling logic.</p>
  170. </td>
  171. </tr>
  172. </tbody>
  173. </table>
  174. <a id="Grpc_Health_V1_Health_BindService_" data-uid="Grpc.Health.V1.Health.BindService*"></a>
  175. <h4 id="Grpc_Health_V1_Health_BindService_Grpc_Health_V1_Health_HealthBase_" data-uid="Grpc.Health.V1.Health.BindService(Grpc.Health.V1.Health.HealthBase)">BindService(Health.HealthBase)</h4>
  176. <div class="markdown level1 summary"><p>Creates service definition that can be registered with a server</p>
  177. </div>
  178. <div class="markdown level1 conceptual"></div>
  179. <h5 class="decalaration">Declaration</h5>
  180. <div class="codewrapper">
  181. <pre><code class="lang-csharp hljs">public static ServerServiceDefinition BindService(Health.HealthBase serviceImpl)</code></pre>
  182. </div>
  183. <h5 class="parameters">Parameters</h5>
  184. <table class="table table-bordered table-striped table-condensed">
  185. <thead>
  186. <tr>
  187. <th>Type</th>
  188. <th>Name</th>
  189. <th>Description</th>
  190. </tr>
  191. </thead>
  192. <tbody>
  193. <tr>
  194. <td><a class="xref" href="Grpc.Health.V1.Health.HealthBase.html">Health.HealthBase</a></td>
  195. <td><span class="parametername">serviceImpl</span></td>
  196. <td><p>An object implementing the server-side handling logic.</p>
  197. </td>
  198. </tr>
  199. </tbody>
  200. </table>
  201. <h5 class="returns">Returns</h5>
  202. <table class="table table-bordered table-striped table-condensed">
  203. <thead>
  204. <tr>
  205. <th>Type</th>
  206. <th>Description</th>
  207. </tr>
  208. </thead>
  209. <tbody>
  210. <tr>
  211. <td><a class="xref" href="Grpc.Core.ServerServiceDefinition.html">ServerServiceDefinition</a></td>
  212. <td></td>
  213. </tr>
  214. </tbody>
  215. </table>
  216. </article>
  217. </div>
  218. <div class="hidden-sm col-md-2" role="complementary">
  219. <div class="sideaffix">
  220. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  221. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  222. </nav>
  223. </div>
  224. </div>
  225. </div>
  226. </div>
  227. <footer>
  228. <div class="grad-bottom"></div>
  229. <div class="footer">
  230. <div class="container">
  231. <span class="pull-right">
  232. <a href="#top">Back to top</a>
  233. </span>
  234. <span>Generated by <strong>DocFX</strong></span>
  235. </div>
  236. </div>
  237. </footer>
  238. </div>
  239. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  240. <script type="text/javascript" src="../styles/docfx.js"></script>
  241. <script type="text/javascript" src="../styles/main.js"></script>
  242. </body>
  243. </html>