Facility to provide interface while registering actors #1350
Conversation
Signed-off-by: Siri Varma Vegiraju <svegiraju@microsoft.com>
Signed-off-by: Siri Varma Vegiraju <svegiraju@microsoft.com>
Signed-off-by: Siri Varma Vegiraju <svegiraju@microsoft.com>
siri-varma
force-pushed
the
users/svegiraju/pull-request-123
branch
from
004c240
to
c463186
Compare
|
@philliphoff @cgillum Would you folks be able to help with approving the workflows please ? |
|
@siri-varma All in all, I think this looks fine, but I think it'd be helpful to have documentation calling this out as it might be unclear to someone why they're experiencing an exception when implementing an interface that doesn't itself ultimately inherit from an IActor parent. Otherwise, I think all the code looks fine. If you could write up a few words about it in this section, I'd be happy to accept this. |
Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com>
|
@WhitWaldo I updated the md file. Let me know if it looks good. Thanks |
daprdocs/content/en/dotnet-sdk-docs/dotnet-actors/dotnet-actors-usage.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Siri Varma Vegiraju <siri.varma@outlook.com>
|
This will also close #694 |
| > [!IMPORTANT] | ||
| > When registering actors, note the return type requirements for the methods inside the interfaces: | ||
| > * Pattern 1: `options.Actors.RegisterActor<MyActor>()` | ||
| > * In this case, all interfaces implemented by `MyActor` must have methods that return only `Task` or `Task<T>`. This applies to every method in all interfaces `MyActor` implements. | ||
| > * Pattern 2: `options.Actors.RegisterActor<IMyActor, MyActor>()` | ||
| > * Here, only the `IMyActor` interface is required to have methods that return `Task` or `Task<T>`. Other interfaces `MyActor` are not subject to this restriction. |
There was a problem hiding this comment.
If we force the use of IActor interface we can add a Diagnostics to block the compilation when the derived class contains methods that doesn't return Task<T>. Similar to what is done in the actors' source generator for the CancellationToken (example)
I usually don't like to find out particularities from documentation, if possible I prefer my editor to guide me.
What do you think about it?
Description
Added facility to provide Interface types while registering Actors.
Issue reference
We strive to have all PR being opened based on an issue, where the problem or feature have been discussed prior to implementation.
Please reference the issue this PR will close: #1341
Checklist
Please make sure you've completed the relevant tasks for this PR, out of the following list: