Grpc.Core.BindServiceMethodAttribute.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371
  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 BindServiceMethodAttribute
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class BindServiceMethodAttribute
  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.Core.BindServiceMethodAttribute">
  73. <h1 id="Grpc_Core_BindServiceMethodAttribute" data-uid="Grpc.Core.BindServiceMethodAttribute" class="text-break">Class BindServiceMethodAttribute
  74. </h1>
  75. <div class="markdown level0 summary"><p>Specifies the location of the service bind method for a gRPC service.
  76. The bind method is typically generated code and is used to register a service&apos;s
  77. methods with the server on startup.</p>
  78. <p>The bind method signature takes a <a class="xref" href="Grpc.Core.ServiceBinderBase.html">ServiceBinderBase</a> and an optional
  79. instance of the service base class, e.g. <code>static void BindService(ServiceBinderBase, GreeterService)</code>.</p>
  80. </div>
  81. <div class="markdown level0 conceptual"></div>
  82. <div class="inheritance">
  83. <h5>Inheritance</h5>
  84. <div class="level0"><span class="xref">System.Object</span></div>
  85. <div class="level1"><span class="xref">System.Attribute</span></div>
  86. <div class="level2"><span class="xref">BindServiceMethodAttribute</span></div>
  87. </div>
  88. <div classs="implements">
  89. <h5>Implements</h5>
  90. <div><span class="xref">System.Runtime.InteropServices._Attribute</span></div>
  91. </div>
  92. <div class="inheritedMembers">
  93. <h5>Inherited Members</h5>
  94. <div>
  95. <span class="xref">System.Attribute.Equals(System.Object)</span>
  96. </div>
  97. <div>
  98. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)</span>
  99. </div>
  100. <div>
  101. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)</span>
  102. </div>
  103. <div>
  104. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)</span>
  105. </div>
  106. <div>
  107. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
  108. </div>
  109. <div>
  110. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)</span>
  111. </div>
  112. <div>
  113. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)</span>
  114. </div>
  115. <div>
  116. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)</span>
  117. </div>
  118. <div>
  119. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
  120. </div>
  121. <div>
  122. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly)</span>
  123. </div>
  124. <div>
  125. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)</span>
  126. </div>
  127. <div>
  128. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)</span>
  129. </div>
  130. <div>
  131. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)</span>
  132. </div>
  133. <div>
  134. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)</span>
  135. </div>
  136. <div>
  137. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)</span>
  138. </div>
  139. <div>
  140. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)</span>
  141. </div>
  142. <div>
  143. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
  144. </div>
  145. <div>
  146. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module)</span>
  147. </div>
  148. <div>
  149. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)</span>
  150. </div>
  151. <div>
  152. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)</span>
  153. </div>
  154. <div>
  155. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)</span>
  156. </div>
  157. <div>
  158. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)</span>
  159. </div>
  160. <div>
  161. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)</span>
  162. </div>
  163. <div>
  164. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)</span>
  165. </div>
  166. <div>
  167. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
  168. </div>
  169. <div>
  170. <span class="xref">System.Attribute.GetHashCode()</span>
  171. </div>
  172. <div>
  173. <span class="xref">System.Attribute.IsDefaultAttribute()</span>
  174. </div>
  175. <div>
  176. <span class="xref">System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)</span>
  177. </div>
  178. <div>
  179. <span class="xref">System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)</span>
  180. </div>
  181. <div>
  182. <span class="xref">System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)</span>
  183. </div>
  184. <div>
  185. <span class="xref">System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
  186. </div>
  187. <div>
  188. <span class="xref">System.Attribute.IsDefined(System.Reflection.Module, System.Type)</span>
  189. </div>
  190. <div>
  191. <span class="xref">System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)</span>
  192. </div>
  193. <div>
  194. <span class="xref">System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)</span>
  195. </div>
  196. <div>
  197. <span class="xref">System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
  198. </div>
  199. <div>
  200. <span class="xref">System.Attribute.Match(System.Object)</span>
  201. </div>
  202. <div>
  203. <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetIDsOfNames(System.Guid, System.IntPtr, System.UInt32, System.UInt32, System.IntPtr)</span>
  204. </div>
  205. <div>
  206. <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetTypeInfo(System.UInt32, System.UInt32, System.IntPtr)</span>
  207. </div>
  208. <div>
  209. <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetTypeInfoCount(System.UInt32)</span>
  210. </div>
  211. <div>
  212. <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.Invoke(System.UInt32, System.Guid, System.UInt32, System.Int16, System.IntPtr, System.IntPtr, System.IntPtr, System.IntPtr)</span>
  213. </div>
  214. <div>
  215. <span class="xref">System.Attribute.TypeId</span>
  216. </div>
  217. <div>
  218. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  219. </div>
  220. <div>
  221. <span class="xref">System.Object.GetType()</span>
  222. </div>
  223. <div>
  224. <span class="xref">System.Object.MemberwiseClone()</span>
  225. </div>
  226. <div>
  227. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  228. </div>
  229. <div>
  230. <span class="xref">System.Object.ToString()</span>
  231. </div>
  232. </div>
  233. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  234. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  235. <h5 id="Grpc_Core_BindServiceMethodAttribute_syntax">Syntax</h5>
  236. <div class="codewrapper">
  237. <pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
  238. public class BindServiceMethodAttribute : Attribute, _Attribute</code></pre>
  239. </div>
  240. <h3 id="constructors">Constructors
  241. </h3>
  242. <a id="Grpc_Core_BindServiceMethodAttribute__ctor_" data-uid="Grpc.Core.BindServiceMethodAttribute.#ctor*"></a>
  243. <h4 id="Grpc_Core_BindServiceMethodAttribute__ctor_System_Type_System_String_" data-uid="Grpc.Core.BindServiceMethodAttribute.#ctor(System.Type,System.String)">BindServiceMethodAttribute(Type, String)</h4>
  244. <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Grpc.Core.BindServiceMethodAttribute.html">BindServiceMethodAttribute</a> class.</p>
  245. </div>
  246. <div class="markdown level1 conceptual"></div>
  247. <h5 class="decalaration">Declaration</h5>
  248. <div class="codewrapper">
  249. <pre><code class="lang-csharp hljs">public BindServiceMethodAttribute(Type bindType, string bindMethodName)</code></pre>
  250. </div>
  251. <h5 class="parameters">Parameters</h5>
  252. <table class="table table-bordered table-striped table-condensed">
  253. <thead>
  254. <tr>
  255. <th>Type</th>
  256. <th>Name</th>
  257. <th>Description</th>
  258. </tr>
  259. </thead>
  260. <tbody>
  261. <tr>
  262. <td><span class="xref">System.Type</span></td>
  263. <td><span class="parametername">bindType</span></td>
  264. <td><p>The type the service bind method is defined on.</p>
  265. </td>
  266. </tr>
  267. <tr>
  268. <td><span class="xref">System.String</span></td>
  269. <td><span class="parametername">bindMethodName</span></td>
  270. <td><p>The name of the service bind method.</p>
  271. </td>
  272. </tr>
  273. </tbody>
  274. </table>
  275. <h3 id="properties">Properties
  276. </h3>
  277. <a id="Grpc_Core_BindServiceMethodAttribute_BindMethodName_" data-uid="Grpc.Core.BindServiceMethodAttribute.BindMethodName*"></a>
  278. <h4 id="Grpc_Core_BindServiceMethodAttribute_BindMethodName" data-uid="Grpc.Core.BindServiceMethodAttribute.BindMethodName">BindMethodName</h4>
  279. <div class="markdown level1 summary"><p>Gets the name of the service bind method.</p>
  280. </div>
  281. <div class="markdown level1 conceptual"></div>
  282. <h5 class="decalaration">Declaration</h5>
  283. <div class="codewrapper">
  284. <pre><code class="lang-csharp hljs">public string BindMethodName { get; }</code></pre>
  285. </div>
  286. <h5 class="propertyValue">Property Value</h5>
  287. <table class="table table-bordered table-striped table-condensed">
  288. <thead>
  289. <tr>
  290. <th>Type</th>
  291. <th>Description</th>
  292. </tr>
  293. </thead>
  294. <tbody>
  295. <tr>
  296. <td><span class="xref">System.String</span></td>
  297. <td></td>
  298. </tr>
  299. </tbody>
  300. </table>
  301. <a id="Grpc_Core_BindServiceMethodAttribute_BindType_" data-uid="Grpc.Core.BindServiceMethodAttribute.BindType*"></a>
  302. <h4 id="Grpc_Core_BindServiceMethodAttribute_BindType" data-uid="Grpc.Core.BindServiceMethodAttribute.BindType">BindType</h4>
  303. <div class="markdown level1 summary"><p>Gets the type the service bind method is defined on.</p>
  304. </div>
  305. <div class="markdown level1 conceptual"></div>
  306. <h5 class="decalaration">Declaration</h5>
  307. <div class="codewrapper">
  308. <pre><code class="lang-csharp hljs">public Type BindType { get; }</code></pre>
  309. </div>
  310. <h5 class="propertyValue">Property Value</h5>
  311. <table class="table table-bordered table-striped table-condensed">
  312. <thead>
  313. <tr>
  314. <th>Type</th>
  315. <th>Description</th>
  316. </tr>
  317. </thead>
  318. <tbody>
  319. <tr>
  320. <td><span class="xref">System.Type</span></td>
  321. <td></td>
  322. </tr>
  323. </tbody>
  324. </table>
  325. <h3 id="implements">Implements</h3>
  326. <div>
  327. <span class="xref">System.Runtime.InteropServices._Attribute</span>
  328. </div>
  329. </article>
  330. </div>
  331. <div class="hidden-sm col-md-2" role="complementary">
  332. <div class="sideaffix">
  333. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  334. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  335. </nav>
  336. </div>
  337. </div>
  338. </div>
  339. </div>
  340. <footer>
  341. <div class="grad-bottom"></div>
  342. <div class="footer">
  343. <div class="container">
  344. <span class="pull-right">
  345. <a href="#top">Back to top</a>
  346. </span>
  347. <span>Generated by <strong>DocFX</strong></span>
  348. </div>
  349. </div>
  350. </footer>
  351. </div>
  352. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  353. <script type="text/javascript" src="../styles/docfx.js"></script>
  354. <script type="text/javascript" src="../styles/main.js"></script>
  355. </body>
  356. </html>