RefreshResponseInfo.xml 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="RefreshResponseInfo" FullName="System.ServiceModel.PeerResolvers.RefreshResponseInfo">
  3. <TypeSignature Language="C#" Value="public class RefreshResponseInfo" />
  4. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RefreshResponseInfo 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 <see cref="M:System.ServiceModel.PeerResolvers.CustomPeerResolverService.Refresh(System.ServiceModel.PeerResolvers.RefreshInfo)" /> or an implementation of <see cref="M:System.ServiceModel.PeerResolvers.CustomPeerResolverService.Refresh(System.ServiceModel.PeerResolvers.RefreshInfo)" /> is called, this object is returned to the client. It contains the refreshed registration entry with the new expiry timestamp, and is returned when a previous <see cref="T:System.ServiceModel.PeerResolvers.RefreshInfo" /> instance is sent to the peer resolver as part of a request to update the expiry of a registration entry.</para>
  22. <para>Instances of this class are primarily used to pass information from the resolver service to a network client of that service.</para>
  23. </remarks>
  24. <summary>
  25. <attribution license="cc4" from="Microsoft" modified="false" />
  26. <para>Contains response information returned as a result of a registration lookup table refresh operation on the peer resolver.</para>
  27. </summary>
  28. </Docs>
  29. <Members>
  30. <Member MemberName=".ctor">
  31. <MemberSignature Language="C#" Value="public RefreshResponseInfo ();" />
  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.RefreshResponseInfo" /> class. </para>
  43. </summary>
  44. </Docs>
  45. </Member>
  46. <Member MemberName=".ctor">
  47. <MemberSignature Language="C#" Value="public RefreshResponseInfo (TimeSpan registrationLifetime, System.ServiceModel.PeerResolvers.RefreshResult result);" />
  48. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.TimeSpan registrationLifetime, valuetype System.ServiceModel.PeerResolvers.RefreshResult result) cil managed" />
  49. <MemberType>Constructor</MemberType>
  50. <AssemblyInfo>
  51. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  52. </AssemblyInfo>
  53. <Parameters>
  54. <Parameter Name="registrationLifetime" Type="System.TimeSpan" />
  55. <Parameter Name="result" Type="System.ServiceModel.PeerResolvers.RefreshResult" />
  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.RefreshResponseInfo" /> class with the provided registration lifetime and refresh results.</para>
  62. </summary>
  63. <param name="registrationLifetime">
  64. <attribution license="cc4" from="Microsoft" modified="false" />
  65. <see cref="T:System.TimeSpan" /> that specifies the new lifetime of the peer's registration.</param>
  66. <param name="result">
  67. <attribution license="cc4" from="Microsoft" modified="false" />
  68. <see cref="T:System.ServiceModel.PeerResolvers.RefreshResult" /> that specifies the result of the refresh.</param>
  69. </Docs>
  70. </Member>
  71. <Member MemberName="HasBody">
  72. <MemberSignature Language="C#" Value="public bool HasBody ();" />
  73. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasBody() cil managed" />
  74. <MemberType>Method</MemberType>
  75. <AssemblyInfo>
  76. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  77. </AssemblyInfo>
  78. <ReturnValue>
  79. <ReturnType>System.Boolean</ReturnType>
  80. </ReturnValue>
  81. <Parameters />
  82. <Docs>
  83. <remarks>To be added.</remarks>
  84. <summary>
  85. <attribution license="cc4" from="Microsoft" modified="false" />
  86. <para>Indicates whether the body of the message containing a serialized instance of this type is correctly formed.</para>
  87. </summary>
  88. <returns>
  89. <attribution license="cc4" from="Microsoft" modified="false" />
  90. <para>True if the refresh response information body is correctly-formed by the sender; false if it is not.</para>
  91. </returns>
  92. </Docs>
  93. </Member>
  94. <Member MemberName="RegistrationLifetime">
  95. <MemberSignature Language="C#" Value="public TimeSpan RegistrationLifetime { get; set; }" />
  96. <MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan RegistrationLifetime" />
  97. <MemberType>Property</MemberType>
  98. <AssemblyInfo>
  99. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  100. </AssemblyInfo>
  101. <ReturnValue>
  102. <ReturnType>System.TimeSpan</ReturnType>
  103. </ReturnValue>
  104. <Docs>
  105. <value>To be added.</value>
  106. <remarks>To be added.</remarks>
  107. <summary>
  108. <attribution license="cc4" from="Microsoft" modified="false" />
  109. <para>Gets or sets amount of time before a registration expires and is removed by the resolver service. </para>
  110. </summary>
  111. </Docs>
  112. </Member>
  113. <Member MemberName="Result">
  114. <MemberSignature Language="C#" Value="public System.ServiceModel.PeerResolvers.RefreshResult Result { get; set; }" />
  115. <MemberSignature Language="ILAsm" Value=".property instance valuetype System.ServiceModel.PeerResolvers.RefreshResult Result" />
  116. <MemberType>Property</MemberType>
  117. <AssemblyInfo>
  118. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  119. </AssemblyInfo>
  120. <ReturnValue>
  121. <ReturnType>System.ServiceModel.PeerResolvers.RefreshResult</ReturnType>
  122. </ReturnValue>
  123. <Docs>
  124. <value>To be added.</value>
  125. <remarks>To be added.</remarks>
  126. <summary>
  127. <attribution license="cc4" from="Microsoft" modified="false" />
  128. <para>Gets or sets the result of a refresh operation.</para>
  129. </summary>
  130. </Docs>
  131. </Member>
  132. </Members>
  133. </Type>