Skip to content

Remove crefs for old APIs #11329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Remove crefs for old APIs #11329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions xml/System.Cloud.Messaging/LatencyRecorderMiddlewareExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@
<Docs>
<param name="pipelineBuilder">The builder for async processing pipeline.</param>
<summary>
Adds the <see cref="T:System.Cloud.Messaging.IMessageMiddleware" /> to register the <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContextProvider" /> in <see cref="T:System.Cloud.Messaging.IMessageMiddleware" /> pipeline to
create and set <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> with the <see cref="T:System.Cloud.Messaging.MessageContext" />.
Adds the <see cref="T:System.Cloud.Messaging.IMessageMiddleware" /> to register the ILatencyContextProvider in <see cref="T:System.Cloud.Messaging.IMessageMiddleware" /> pipeline to
create and set ILatencyContext with the <see cref="T:System.Cloud.Messaging.MessageContext" />.
</summary>
<returns>
<see cref="T:System.Cloud.Messaging.IAsyncProcessingPipelineBuilder" /> to chain additional calls.</returns>
<remarks>
If the <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> is already available in the workflow,
If the ILatencyContext is already available in the workflow,
use the <see cref="M:System.Cloud.Messaging.LatencyRecorderMiddlewareExtensions.AddLatencyContextMiddleware``1(System.Cloud.Messaging.IAsyncProcessingPipelineBuilder,System.Func{System.IServiceProvider,``0})" /> variant.
</remarks>
<exception cref="T:System.ArgumentNullException">Any argument is <see langword="null" />.</exception>
Expand Down Expand Up @@ -87,11 +87,11 @@
<Parameter Name="implementationFactory" Type="System.Func&lt;System.IServiceProvider,T&gt;" Index="1" FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp;netframework-4.6.2-pp" />
</Parameters>
<Docs>
<typeparam name="T">The type of <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> implementation.</typeparam>
<typeparam name="T">The type of ILatencyContext implementation.</typeparam>
<param name="pipelineBuilder">The builder for async processing pipeline.</param>
<param name="implementationFactory">The <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> implementation factory.</param>
<param name="implementationFactory">The ILatencyContext implementation factory.</param>
<summary>
Adds the <see cref="T:System.Cloud.Messaging.IMessageMiddleware" /> to reuse the existing <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> registered with the ASP.NET pipeline and set it in the <see cref="T:System.Cloud.Messaging.MessageContext" />.
Adds the <see cref="T:System.Cloud.Messaging.IMessageMiddleware" /> to reuse the existing ILatencyContext registered with the ASP.NET pipeline and set it in the <see cref="T:System.Cloud.Messaging.MessageContext" />.
</summary>
<returns>
<see cref="T:System.Cloud.Messaging.IAsyncProcessingPipelineBuilder" /> to chain additional calls.</returns>
Expand Down Expand Up @@ -132,18 +132,18 @@
<Parameter Name="exporterFactory" Type="System.Func&lt;System.IServiceProvider,System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.Telemetry.Latency.ILatencyDataExporter&gt;&gt;" Index="2" FrameworkAlternate="netframework-4.6.2-pp" />
</Parameters>
<Docs>
<typeparam name="T">The type of <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContextProvider" /> implementation.</typeparam>
<typeparam name="T">The type of ILatencyContextProvider implementation.</typeparam>
<param name="pipelineBuilder">The builder for async processing pipeline.</param>
<param name="implementationFactory">The <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContextProvider" /> implementation factory.</param>
<param name="implementationFactory">The ILatencyContextProvider implementation factory.</param>
<param name="exporterFactory">The factory for exporting capture latency context.</param>
<summary>
Adds the <see cref="T:System.Cloud.Messaging.IMessageMiddleware" /> to register the provided <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContextProvider" /> in the <see cref="T:System.Cloud.Messaging.IMessageMiddleware" /> pipeline to
create and set <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> with the <see cref="T:System.Cloud.Messaging.MessageContext" />.
Adds the <see cref="T:System.Cloud.Messaging.IMessageMiddleware" /> to register the provided ILatencyContextProvider the <see cref="T:System.Cloud.Messaging.IMessageMiddleware" /> pipeline to
create and set ILatencyContext with the <see cref="T:System.Cloud.Messaging.MessageContext" />.
</summary>
<returns>
<see cref="T:System.Cloud.Messaging.IAsyncProcessingPipelineBuilder" /> to chain additional calls.</returns>
<remarks>
If the <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> is already available in the workflow,
If the ILatencyContext is already available in the workflow,
use the <see cref="M:System.Cloud.Messaging.LatencyRecorderMiddlewareExtensions.AddLatencyContextMiddleware``1(System.Cloud.Messaging.IAsyncProcessingPipelineBuilder,System.Func{System.IServiceProvider,``0})" /> variant.
</remarks>
<exception cref="T:System.ArgumentNullException">Any argument is <see langword="null" />.</exception>
Expand Down Expand Up @@ -179,12 +179,12 @@
<param name="failureMeasureToken">The failure token.</param>
<summary>
Adds the <see cref="T:System.Cloud.Messaging.IMessageMiddleware" /> for recording latency of the underlying <see cref="T:System.Cloud.Messaging.IMessageMiddleware" /> pipeline
by obtaining the <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> associated with <see cref="T:System.Cloud.Messaging.MessageContext" />.
by obtaining the ILatencyContext associated with <see cref="T:System.Cloud.Messaging.MessageContext" />.
</summary>
<returns>
<see cref="T:System.Cloud.Messaging.IAsyncProcessingPipelineBuilder" /> to chain additional calls.</returns>
<remarks>
Ensure to register the <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> in the <see cref="T:System.Cloud.Messaging.MessageContext" /> before calling this method via either of the following methods:
Ensure to register the ILatencyContext in the <see cref="T:System.Cloud.Messaging.MessageContext" /> before calling this method via either of the following methods:
1. <see cref="M:System.Cloud.Messaging.LatencyRecorderMiddlewareExtensions.AddLatencyContextMiddleware(System.Cloud.Messaging.IAsyncProcessingPipelineBuilder)" /> OR
2. <see cref="M:System.Cloud.Messaging.LatencyRecorderMiddlewareExtensions.AddLatencyContextMiddleware``1(System.Cloud.Messaging.IAsyncProcessingPipelineBuilder,System.Func{System.IServiceProvider,``0},System.Func{System.IServiceProvider,System.Collections.Generic.IEnumerable{Microsoft.Extensions.Telemetry.Latency.ILatencyDataExporter}})" /> OR
3. <see cref="M:System.Cloud.Messaging.LatencyRecorderMiddlewareExtensions.AddLatencyContextMiddleware``1(System.Cloud.Messaging.IAsyncProcessingPipelineBuilder,System.Func{System.IServiceProvider,``0})" />.
Expand Down
12 changes: 6 additions & 6 deletions xml/System.Cloud.Messaging/MessageLatencyContextFeatureExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<Interfaces />
<Docs>
<summary>
Provides extension methods for <see cref="T:System.Cloud.Messaging.MessageContext" /> class to add support for setting/retrieving <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" />.
Provides extension methods for <see cref="T:System.Cloud.Messaging.MessageContext" /> class to add support for setting/retrieving ILatencyContext.
</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -51,10 +51,10 @@
<param name="context">The message context.</param>
<param name="latencyContext">The latency context to store fine-grained latency for different processing steps.</param>
<summary>
Sets the <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> in <see cref="T:System.Cloud.Messaging.MessageContext" />.
Sets the ILatencyContext in <see cref="T:System.Cloud.Messaging.MessageContext" />.
</summary>
<remarks>
The <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> allows user to set fine-grained latency and associated properties for different processing steps.
The ILatencyContext allows user to set fine-grained latency and associated properties for different processing steps.
</remarks>
<exception cref="T:System.ArgumentNullException">Any argument is <see langword="null" />.</exception>
</Docs>
Expand Down Expand Up @@ -86,12 +86,12 @@
<param name="context">The message context.</param>
<param name="latencyContext">The optional latency context registered with the <paramref name="context" />.</param>
<summary>
Try to get the <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> from the <see cref="T:System.Cloud.Messaging.MessageContext" />.
Try to get the ILatencyContext from the <see cref="T:System.Cloud.Messaging.MessageContext" />.
</summary>
<returns>
<see cref="T:System.Boolean" /> and if <see langword="true" />, a corresponding <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" />.</returns>
<see cref="T:System.Boolean" /> and if <see langword="true" />, a corresponding ILatencyContext.</returns>
<remarks>
Application should set the <see cref="T:Microsoft.Extensions.Telemetry.Latency.ILatencyContext" /> in the <see cref="T:System.Cloud.Messaging.MessageContext" /> via the <see cref="M:System.Cloud.Messaging.MessageLatencyContextFeatureExtensions.SetLatencyContext(System.Cloud.Messaging.MessageContext,Microsoft.Extensions.Telemetry.Latency.ILatencyContext)" />.
Application should set the ILatencyContext in the <see cref="T:System.Cloud.Messaging.MessageContext" /> via the <see cref="M:System.Cloud.Messaging.MessageLatencyContextFeatureExtensions.SetLatencyContext(System.Cloud.Messaging.MessageContext,Microsoft.Extensions.Telemetry.Latency.ILatencyContext)" /> method.
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="context" /> is <see langword="null" />.</exception>
Expand Down
Loading