RefreshInfo.xml 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="RefreshInfo" FullName="System.ServiceModel.PeerResolvers.RefreshInfo">
  3. <TypeSignature Language="C#" Value="public class RefreshInfo" />
  4. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RefreshInfo 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>When a peer resolver service refreshes an entry, it sets a new expiry on that entry. An instance of this object must be supplied to the peer resolver service for each peer node that should have its expiration refreshed; otherwise, the entry is marked as stale and will be deleted after a specific interval for cleanup has passed.</para>
  22. <para>Instances of this class are primarily used to pass information to the 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 information for the refresh of a registration entry by a peer resolver service.</para>
  27. </summary>
  28. </Docs>
  29. <Members>
  30. <Member MemberName=".ctor">
  31. <MemberSignature Language="C#" Value="public RefreshInfo ();" />
  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.RefreshInfo" /> class. </para>
  43. </summary>
  44. </Docs>
  45. </Member>
  46. <Member MemberName=".ctor">
  47. <MemberSignature Language="C#" Value="public RefreshInfo (string meshId, Guid regId);" />
  48. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string meshId, valuetype System.Guid regId) cil managed" />
  49. <MemberType>Constructor</MemberType>
  50. <AssemblyInfo>
  51. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  52. </AssemblyInfo>
  53. <Parameters>
  54. <Parameter Name="meshId" Type="System.String" />
  55. <Parameter Name="regId" Type="System.Guid" />
  56. </Parameters>
  57. <Docs>
  58. <remarks>To be added.</remarks>
  59. <summary>
  60. <attribution license="cc4" from="Microsoft" modified="false" />
  61. <para>Initializes a new instance of the <see cref="T:System.ServiceModel.PeerResolvers.RefreshInfo" /> class with the provided mesh ID and unique registration ID.</para>
  62. </summary>
  63. <param name="meshId">
  64. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that identifies the mesh in which the peer node participates.</param>
  65. <param name="regId">
  66. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Guid" /> that uniquely identifies the registration entry for the peer node.</param>
  67. </Docs>
  68. </Member>
  69. <Member MemberName="HasBody">
  70. <MemberSignature Language="C#" Value="public bool HasBody ();" />
  71. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasBody() cil managed" />
  72. <MemberType>Method</MemberType>
  73. <AssemblyInfo>
  74. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  75. </AssemblyInfo>
  76. <ReturnValue>
  77. <ReturnType>System.Boolean</ReturnType>
  78. </ReturnValue>
  79. <Parameters />
  80. <Docs>
  81. <remarks>To be added.</remarks>
  82. <summary>
  83. <attribution license="cc4" from="Microsoft" modified="false" />
  84. <para>Indicates whether the body of the message containing a serialized instance of this type is correctly formed.</para>
  85. </summary>
  86. <returns>
  87. <attribution license="cc4" from="Microsoft" modified="false" />
  88. <para>True if the refresh information message body is correctly formed by the sender (the service client); false if it is not.</para>
  89. </returns>
  90. </Docs>
  91. </Member>
  92. <Member MemberName="MeshId">
  93. <MemberSignature Language="C#" Value="public string MeshId { get; }" />
  94. <MemberSignature Language="ILAsm" Value=".property instance string MeshId" />
  95. <MemberType>Property</MemberType>
  96. <AssemblyInfo>
  97. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  98. </AssemblyInfo>
  99. <ReturnValue>
  100. <ReturnType>System.String</ReturnType>
  101. </ReturnValue>
  102. <Docs>
  103. <value>To be added.</value>
  104. <remarks>To be added.</remarks>
  105. <summary>
  106. <attribution license="cc4" from="Microsoft" modified="false" />
  107. <para>Gets the mesh ID of the registration entry to refresh.</para>
  108. </summary>
  109. </Docs>
  110. </Member>
  111. <Member MemberName="RegistrationId">
  112. <MemberSignature Language="C#" Value="public Guid RegistrationId { get; }" />
  113. <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid RegistrationId" />
  114. <MemberType>Property</MemberType>
  115. <AssemblyInfo>
  116. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  117. </AssemblyInfo>
  118. <ReturnValue>
  119. <ReturnType>System.Guid</ReturnType>
  120. </ReturnValue>
  121. <Docs>
  122. <value>To be added.</value>
  123. <remarks>To be added.</remarks>
  124. <summary>
  125. <attribution license="cc4" from="Microsoft" modified="false" />
  126. <para>Gets the unique registration ID of the registration entry to refresh.</para>
  127. </summary>
  128. </Docs>
  129. </Member>
  130. </Members>
  131. </Type>