RegisterInfo.xml 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="RegisterInfo" FullName="System.ServiceModel.PeerResolvers.RegisterInfo">
  3. <TypeSignature Language="C#" Value="public class RegisterInfo" />
  4. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RegisterInfo extends System.Object" />
  5. <AssemblyInfo>
  6. <AssemblyName>System.ServiceModel</AssemblyName>
  7. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  8. </AssemblyInfo>
  9. <Base>
  10. <BaseTypeName>System.Object</BaseTypeName>
  11. </Base>
  12. <Interfaces />
  13. <Attributes>
  14. <Attribute>
  15. <AttributeName>System.ServiceModel.MessageContract(IsWrapped=false)</AttributeName>
  16. </Attribute>
  17. </Attributes>
  18. <Docs>
  19. <remarks>
  20. <attribution license="cc4" from="Microsoft" modified="false" />
  21. <para>This class defines the information used to register the tuple of a peer node and a mesh ID with a peer resolver service. This information is inserted as an entry in the registration lookup table of the resolver service, which can be queried by other peers for the endpoint addresses of the inserted peer.</para>
  22. <para>Instances of this class are created when <see cref="Overload:System.ServiceModel.PeerResolvers.CustomPeerResolverService.Register" /> (or an implementation of <see cref="M:System.ServiceModel.PeerResolvers.IPeerResolverContract.Register(System.ServiceModel.PeerResolvers.RegisterInfo)" />) is called to register with a peer resolver service. They are primarily used to pass registration request information to a peer resolver service from a network client of that service.</para>
  23. </remarks>
  24. <summary>
  25. <attribution license="cc4" from="Microsoft" modified="false" />
  26. <para>Defines the peer registration information to be supplied to a peer resolver service.</para>
  27. </summary>
  28. </Docs>
  29. <Members>
  30. <Member MemberName=".ctor">
  31. <MemberSignature Language="C#" Value="public RegisterInfo ();" />
  32. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  33. <MemberType>Constructor</MemberType>
  34. <AssemblyInfo>
  35. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  36. </AssemblyInfo>
  37. <Parameters />
  38. <Docs>
  39. <remarks>To be added.</remarks>
  40. <summary>
  41. <attribution license="cc4" from="Microsoft" modified="false" />
  42. <para>Initializes a new default instance of the <see cref="T:System.ServiceModel.PeerResolvers.RegisterInfo" /> class. </para>
  43. </summary>
  44. </Docs>
  45. </Member>
  46. <Member MemberName=".ctor">
  47. <MemberSignature Language="C#" Value="public RegisterInfo (Guid client, string meshId, System.ServiceModel.PeerNodeAddress address);" />
  48. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Guid client, string meshId, class System.ServiceModel.PeerNodeAddress address) cil managed" />
  49. <MemberType>Constructor</MemberType>
  50. <AssemblyInfo>
  51. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  52. </AssemblyInfo>
  53. <Parameters>
  54. <Parameter Name="client" Type="System.Guid" />
  55. <Parameter Name="meshId" Type="System.String" />
  56. <Parameter Name="address" Type="System.ServiceModel.PeerNodeAddress" />
  57. </Parameters>
  58. <Docs>
  59. <remarks>To be added.</remarks>
  60. <summary>
  61. <attribution license="cc4" from="Microsoft" modified="false" />
  62. <para>Initializes a new instance of the <see cref="T:System.ServiceModel.PeerResolvers.RegisterInfo" /> class with the supplied client ID, mesh ID, and endpoint address(es).</para>
  63. </summary>
  64. <param name="client">
  65. <attribution license="cc4" from="Microsoft" modified="false" />
  66. <see cref="T:System.Guid" /> that uniquely identifies the peer node to be registered.</param>
  67. <param name="meshId">
  68. <attribution license="cc4" from="Microsoft" modified="false" />
  69. <see cref="T:System.String" /> that specifies the ID of the mesh in which the peer node participates.</param>
  70. <param name="address">
  71. <attribution license="cc4" from="Microsoft" modified="false" />
  72. <see cref="T:System.ServiceModel.PeerNodeAddress" /> that specifies the endpoint address(es) of the peer node to be registered.</param>
  73. </Docs>
  74. </Member>
  75. <Member MemberName="ClientId">
  76. <MemberSignature Language="C#" Value="public Guid ClientId { get; }" />
  77. <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid ClientId" />
  78. <MemberType>Property</MemberType>
  79. <AssemblyInfo>
  80. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  81. </AssemblyInfo>
  82. <ReturnValue>
  83. <ReturnType>System.Guid</ReturnType>
  84. </ReturnValue>
  85. <Docs>
  86. <value>To be added.</value>
  87. <remarks>To be added.</remarks>
  88. <summary>
  89. <attribution license="cc4" from="Microsoft" modified="false" />
  90. <para>Gets a <see cref="T:System.Guid" /> that uniquely identifies the registration entry for a peer node.</para>
  91. </summary>
  92. </Docs>
  93. </Member>
  94. <Member MemberName="HasBody">
  95. <MemberSignature Language="C#" Value="public bool HasBody ();" />
  96. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasBody() cil managed" />
  97. <MemberType>Method</MemberType>
  98. <AssemblyInfo>
  99. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  100. </AssemblyInfo>
  101. <ReturnValue>
  102. <ReturnType>System.Boolean</ReturnType>
  103. </ReturnValue>
  104. <Parameters />
  105. <Docs>
  106. <remarks>To be added.</remarks>
  107. <summary>
  108. <attribution license="cc4" from="Microsoft" modified="false" />
  109. <para>Indicates whether the body of the message containing a serialized instance of this type is correctly formed.</para>
  110. </summary>
  111. <returns>
  112. <attribution license="cc4" from="Microsoft" modified="false" />
  113. <para>True if the registration information body is correctly-formed by the sender; false if it is not.</para>
  114. </returns>
  115. </Docs>
  116. </Member>
  117. <Member MemberName="MeshId">
  118. <MemberSignature Language="C#" Value="public string MeshId { get; }" />
  119. <MemberSignature Language="ILAsm" Value=".property instance string MeshId" />
  120. <MemberType>Property</MemberType>
  121. <AssemblyInfo>
  122. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  123. </AssemblyInfo>
  124. <ReturnValue>
  125. <ReturnType>System.String</ReturnType>
  126. </ReturnValue>
  127. <Docs>
  128. <value>To be added.</value>
  129. <remarks>To be added.</remarks>
  130. <summary>
  131. <attribution license="cc4" from="Microsoft" modified="false" />
  132. <para>Gets a mesh ID associated with the registration entry.</para>
  133. </summary>
  134. </Docs>
  135. </Member>
  136. <Member MemberName="NodeAddress">
  137. <MemberSignature Language="C#" Value="public System.ServiceModel.PeerNodeAddress NodeAddress { get; }" />
  138. <MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.PeerNodeAddress NodeAddress" />
  139. <MemberType>Property</MemberType>
  140. <AssemblyInfo>
  141. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  142. </AssemblyInfo>
  143. <ReturnValue>
  144. <ReturnType>System.ServiceModel.PeerNodeAddress</ReturnType>
  145. </ReturnValue>
  146. <Docs>
  147. <value>To be added.</value>
  148. <remarks>To be added.</remarks>
  149. <summary>
  150. <attribution license="cc4" from="Microsoft" modified="false" />
  151. <para>Gets the endpoint address(es) to associate with the node that is registering with the resolver service.</para>
  152. </summary>
  153. </Docs>
  154. </Member>
  155. </Members>
  156. </Type>