UpdateInfo.xml 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="UpdateInfo" FullName="System.ServiceModel.PeerResolvers.UpdateInfo">
  3. <TypeSignature Language="C#" Value="public class UpdateInfo" />
  4. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit UpdateInfo 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>Instances of this class are primarily used to pass registration update request information to the resolver service from a network client of that service.</para>
  22. </remarks>
  23. <summary>
  24. <attribution license="cc4" from="Microsoft" modified="false" />
  25. <para>Contains the information used to update the endpoint address of a specific registration entry in the lookup table of a peer resolver service.</para>
  26. </summary>
  27. </Docs>
  28. <Members>
  29. <Member MemberName=".ctor">
  30. <MemberSignature Language="C#" Value="public UpdateInfo ();" />
  31. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  32. <MemberType>Constructor</MemberType>
  33. <AssemblyInfo>
  34. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  35. </AssemblyInfo>
  36. <Parameters />
  37. <Docs>
  38. <remarks>To be added.</remarks>
  39. <summary>
  40. <attribution license="cc4" from="Microsoft" modified="false" />
  41. <para>Initializes a new default instance of the <see cref="T:System.ServiceModel.PeerResolvers.UpdateInfo" /> class. </para>
  42. </summary>
  43. </Docs>
  44. </Member>
  45. <Member MemberName=".ctor">
  46. <MemberSignature Language="C#" Value="public UpdateInfo (Guid registrationId, Guid client, string meshId, System.ServiceModel.PeerNodeAddress address);" />
  47. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Guid registrationId, valuetype System.Guid client, string meshId, class System.ServiceModel.PeerNodeAddress address) cil managed" />
  48. <MemberType>Constructor</MemberType>
  49. <AssemblyInfo>
  50. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  51. </AssemblyInfo>
  52. <Parameters>
  53. <Parameter Name="registrationId" Type="System.Guid" />
  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>
  60. <attribution license="cc4" from="Microsoft" modified="false" />
  61. <para>A peer can have multiple entries for any mesh ID, each for a specific peer endpoint. Each endpoint entry is updated separately.</para>
  62. </remarks>
  63. <summary>
  64. <attribution license="cc4" from="Microsoft" modified="false" />
  65. <para>Initializes a new instance of the <see cref="T:System.ServiceModel.PeerResolvers.UpdateInfo" /> class with the supplied peer client ID, registration ID, peer mesh ID, and peer endpoint address.</para>
  66. </summary>
  67. <param name="registrationId">
  68. <attribution license="cc4" from="Microsoft" modified="false" />
  69. <see cref="T:System.Guid" /> that specifies the unique ID of the registration entry to update.</param>
  70. <param name="client">
  71. <attribution license="cc4" from="Microsoft" modified="false" />
  72. <see cref="T:System.Guid" /> that specifies the unique ID of the peer client that submitted the updated registration entry information.</param>
  73. <param name="meshId">
  74. <attribution license="cc4" from="Microsoft" modified="false" />
  75. <see cref="T:System.String" /> that contains the mesh ID of the entry.</param>
  76. <param name="address">
  77. <attribution license="cc4" from="Microsoft" modified="false" />
  78. <see cref="T:System.ServiceModel.PeerNodeAddress" /> that contains the endpoint address to update for the registration entry.</param>
  79. </Docs>
  80. </Member>
  81. <Member MemberName="ClientId">
  82. <MemberSignature Language="C#" Value="public Guid ClientId { get; }" />
  83. <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid ClientId" />
  84. <MemberType>Property</MemberType>
  85. <AssemblyInfo>
  86. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  87. </AssemblyInfo>
  88. <ReturnValue>
  89. <ReturnType>System.Guid</ReturnType>
  90. </ReturnValue>
  91. <Docs>
  92. <value>To be added.</value>
  93. <remarks>To be added.</remarks>
  94. <summary>
  95. <attribution license="cc4" from="Microsoft" modified="false" />
  96. <para>Gets the unique ID of the peer client that submitted the updated registration entry information.</para>
  97. </summary>
  98. </Docs>
  99. </Member>
  100. <Member MemberName="HasBody">
  101. <MemberSignature Language="C#" Value="public bool HasBody ();" />
  102. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasBody() cil managed" />
  103. <MemberType>Method</MemberType>
  104. <AssemblyInfo>
  105. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  106. </AssemblyInfo>
  107. <ReturnValue>
  108. <ReturnType>System.Boolean</ReturnType>
  109. </ReturnValue>
  110. <Parameters />
  111. <Docs>
  112. <remarks>To be added.</remarks>
  113. <summary>
  114. <attribution license="cc4" from="Microsoft" modified="false" />
  115. <para>Indicates whether the body of the message containing a serialized instance of this type is correctly formed.</para>
  116. </summary>
  117. <returns>
  118. <attribution license="cc4" from="Microsoft" modified="false" />
  119. <para>True if the registration update information body is correctly-formed by the sender; false if it is not.</para>
  120. </returns>
  121. </Docs>
  122. </Member>
  123. <Member MemberName="MeshId">
  124. <MemberSignature Language="C#" Value="public string MeshId { get; }" />
  125. <MemberSignature Language="ILAsm" Value=".property instance string MeshId" />
  126. <MemberType>Property</MemberType>
  127. <AssemblyInfo>
  128. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  129. </AssemblyInfo>
  130. <ReturnValue>
  131. <ReturnType>System.String</ReturnType>
  132. </ReturnValue>
  133. <Docs>
  134. <value>To be added.</value>
  135. <remarks>To be added.</remarks>
  136. <summary>
  137. <attribution license="cc4" from="Microsoft" modified="false" />
  138. <para>Gets the mesh ID of the registration entry.</para>
  139. </summary>
  140. </Docs>
  141. </Member>
  142. <Member MemberName="NodeAddress">
  143. <MemberSignature Language="C#" Value="public System.ServiceModel.PeerNodeAddress NodeAddress { get; }" />
  144. <MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.PeerNodeAddress NodeAddress" />
  145. <MemberType>Property</MemberType>
  146. <AssemblyInfo>
  147. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  148. </AssemblyInfo>
  149. <ReturnValue>
  150. <ReturnType>System.ServiceModel.PeerNodeAddress</ReturnType>
  151. </ReturnValue>
  152. <Docs>
  153. <value>To be added.</value>
  154. <remarks>To be added.</remarks>
  155. <summary>
  156. <attribution license="cc4" from="Microsoft" modified="false" />
  157. <para>Gets the endpoint address to update for the registration entry.</para>
  158. </summary>
  159. </Docs>
  160. </Member>
  161. <Member MemberName="RegistrationId">
  162. <MemberSignature Language="C#" Value="public Guid RegistrationId { get; }" />
  163. <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid RegistrationId" />
  164. <MemberType>Property</MemberType>
  165. <AssemblyInfo>
  166. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  167. </AssemblyInfo>
  168. <ReturnValue>
  169. <ReturnType>System.Guid</ReturnType>
  170. </ReturnValue>
  171. <Docs>
  172. <value>To be added.</value>
  173. <remarks>To be added.</remarks>
  174. <summary>
  175. <attribution license="cc4" from="Microsoft" modified="false" />
  176. <para>Gets the unique ID of the registration entry to update.</para>
  177. </summary>
  178. </Docs>
  179. </Member>
  180. </Members>
  181. </Type>