Skip to content
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

Jump to bottom

Deprecate, with warning, broker sync API #515

Open
wants to merge 4 commits into
base: release-2.1
Choose a base branch
from
Open

Deprecate, with warning, broker sync API #515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
69f752f
test against 3.1
mauroservienti Dec 12, 2021
b978aee
Deprecate message broker sync API
mauroservienti Dec 12, 2021
2586a28
Ignore noisy attributes
mauroservienti Dec 12, 2021
ccb197f
Deprecate constructor
mauroservienti Dec 12, 2021
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
106 changes: 105 additions & 1 deletion src/Radical.Tests/API/APIApprovals.Approve_API.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
[assembly: System.Runtime.CompilerServices.InternalsVisibleTo("Radical.Tests")]
[assembly: System.Runtime.InteropServices.ComVisible(false)]
[assembly: System.Runtime.InteropServices.Guid("ac1104e2-8764-42ea-80aa-bfd22bc6a89f")]
[assembly: System.Runtime.Versioning.TargetFramework(".NETStandard,Version=v2.0", FrameworkDisplayName="")]
namespace Radical
{
public sealed class ActionTextWriter : System.IO.TextWriter
Expand Down Expand Up @@ -926,26 +925,78 @@ namespace Radical.ComponentModel.Messaging
}
public interface IMessageBroker
{
[System.Obsolete("Broadcast is deprecated. Use BroadcastAsync. It will be treated as an error in v3" +
" and removed in v4.", false)]
void Broadcast(object sender, object message);
System.Threading.Tasks.Task BroadcastAsync(object sender, object message);
[System.Obsolete("Dispatch is deprecated. Use BroadcastAsync. It will be treated as an error in v3 " +
"and removed in v4.", false)]
void Dispatch(object sender, object message);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe(object subscriber, System.Type messageType, System.Action<object, object> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe(object subscriber, object sender, System.Type messageType, System.Action<object, object> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe(object subscriber, System.Type messageType, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Action<object, object> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe(object subscriber, System.Type messageType, System.Func<object, object, bool> callbackFilter, System.Action<object, object> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe(object subscriber, object sender, System.Type messageType, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Action<object, object> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe(object subscriber, object sender, System.Type messageType, System.Func<object, object, bool> callbackFilter, System.Action<object, object> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe(object subscriber, System.Type messageType, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Func<object, object, bool> callbackFilter, System.Action<object, object> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe(object subscriber, object sender, System.Type messageType, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Func<object, object, bool> callbackFilter, System.Action<object, object> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe<T>(object subscriber, System.Action<object, T> callback);
void Subscribe<T>(object subscriber, System.Func<object, T, System.Threading.Tasks.Task> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe<T>(object subscriber, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Action<object, T> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe<T>(object subscriber, System.Func<object, T, bool> callbackFilter, System.Action<object, T> callback);
void Subscribe<T>(object subscriber, System.Func<object, T, System.Threading.Tasks.Task<bool>> callbackFilter, System.Func<object, T, System.Threading.Tasks.Task> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe<T>(object subscriber, object sender, System.Action<object, T> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe<T>(object subscriber, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Func<object, T, bool> callbackFilter, System.Action<object, T> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe<T>(object subscriber, object sender, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Action<object, T> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe<T>(object subscriber, object sender, System.Func<object, T, bool> callbackFilter, System.Action<object, T> callback);
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
void Subscribe<T>(object subscriber, object sender, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Func<object, T, bool> callbackFilter, System.Action<object, T> callback);
void Unsubscribe(object subscriber);
void Unsubscribe(object subscriber, object sender);
Expand Down Expand Up @@ -1178,27 +1229,80 @@ namespace Radical.Messaging
public class MessageBroker : Radical.ComponentModel.Messaging.IMessageBroker
{
public MessageBroker(Radical.ComponentModel.IDispatcher dispatcher) { }
[System.Obsolete("Constructing a message broker with a task factory is deprecated.", false)]
public MessageBroker(Radical.ComponentModel.IDispatcher dispatcher, System.Threading.Tasks.TaskFactory factory) { }
[System.Obsolete("Broadcast is deprecated. Use BroadcastAsync. It will be treated as an error in v3" +
" and removed in v4.", false)]
public void Broadcast(object sender, object message) { }
public System.Threading.Tasks.Task BroadcastAsync(object sender, object message) { }
[System.Obsolete("Dispatch is deprecated. Use BroadcastAsync. It will be treated as an error in v3 " +
"and removed in v4.", false)]
public void Dispatch(object sender, object message) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe(object subscriber, System.Type messageType, System.Action<object, object> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe(object subscriber, object sender, System.Type messageType, System.Action<object, object> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe(object subscriber, System.Type messageType, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Action<object, object> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe(object subscriber, System.Type messageType, System.Func<object, object, bool> callbackFilter, System.Action<object, object> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe(object subscriber, object sender, System.Type messageType, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Action<object, object> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe(object subscriber, object sender, System.Type messageType, System.Func<object, object, bool> callbackFilter, System.Action<object, object> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe(object subscriber, System.Type messageType, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Func<object, object, bool> callbackFilter, System.Action<object, object> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe(object subscriber, object sender, System.Type messageType, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Func<object, object, bool> callbackFilter, System.Action<object, object> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe<T>(object subscriber, System.Action<object, T> callback) { }
public void Subscribe<T>(object subscriber, System.Func<object, T, System.Threading.Tasks.Task> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe<T>(object subscriber, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Action<object, T> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe<T>(object subscriber, System.Func<object, T, bool> callbackFilter, System.Action<object, T> callback) { }
public void Subscribe<T>(object subscriber, System.Func<object, T, System.Threading.Tasks.Task<bool>> callbackFilter, System.Func<object, T, System.Threading.Tasks.Task> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe<T>(object subscriber, object sender, System.Action<object, T> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe<T>(object subscriber, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Func<object, T, bool> callbackFilter, System.Action<object, T> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe<T>(object subscriber, object sender, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Action<object, T> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe<T>(object subscriber, object sender, System.Func<object, T, bool> callbackFilter, System.Action<object, T> callback) { }
[System.Obsolete("The synchronous version of Subscribe is deprecated. Use the overload that accepts" +
" a Func<obect, TMessage, Task>. It will be treated as an error in v3 and removed" +
" in v4.", false)]
public void Subscribe<T>(object subscriber, object sender, Radical.ComponentModel.Messaging.InvocationModel invocationModel, System.Func<object, T, bool> callbackFilter, System.Action<object, T> callback) { }
public void Unsubscribe(object subscriber) { }
public void Unsubscribe(object subscriber, object sender) { }
Expand Down
5 changes: 4 additions & 1 deletion src/Radical.Tests/API/APIApprovals.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ public class APIApprovals
[UseReporter(typeof(DiffReporter))]
public void Approve_API()
{
var publicApi = ApiGenerator.GeneratePublicApi(typeof(IMessageBroker).Assembly, options: null);
var publicApi = ApiGenerator.GeneratePublicApi(typeof(IMessageBroker).Assembly, options: new ApiGeneratorOptions
{
ExcludeAttributes = new[] { "System.Runtime.Versioning.TargetFrameworkAttribute", "System.Reflection.AssemblyMetadataAttribute" }
});

Approvals.Verify(publicApi);
}
Expand Down
2 changes: 1 addition & 1 deletion src/Radical.Tests/Radical.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>netcoreapp3.0</TargetFramework>
<TargetFramework>netcoreapp3.1</TargetFramework>
</PropertyGroup>

<ItemGroup>
Expand Down
Loading