Is it okay to attach async event handler to System.Timers.Timer?

后端 未结 2 1324
小鲜肉
小鲜肉 2021-01-04 02:49

I have already read the SO posts here and article here. I have a timer event that fires every once in a while and I want to do some asynchronous processing inside the handle

相关标签:
2条回答
  • 2021-01-04 03:06

    async void is "not recommended", with one very important exception: event handlers.

    Your code compiles fine (well, the second event subscription…the first would generate a compile-time error, assuming the same timer_Elapsed() method in both statements), because the compiler can infer the delegate's return type should be void. The async anonymous method could also return Task, but in this case that would be the wrong method signature, so you get void instead.

    It would also be fine to just declare your event handle as async void:

       private async void timer_Elapsed(object sender, ElapsedEventArgs e)
       {
          await Task.Delay(10);
       }
    

    Used like:

    timer.Elapsed += timer_Elapsed;
    

    Returning void for async methods is not ideal, but in the case of an event handler, there is no code that is going to use the Task anyway (unless the event is specifically implemented to understand async methods, as in Asynchronous events in C#). There's no reason to bend over backwards to comply with what would otherwise be the correct coding practice, if you get zero benefit from doing so.


    See also Should I avoid 'async void' event handlers?


    Addendum:

    From your edit to the question:

    Timer.Elapsed is I think synchronous event handler can I still attach async void to it?

    It's not the event that is asynchronous or synchronous, but the handler itself. And that's determined entirely by whether you use async and await for the handler method. You may, as described in your question and my answer, use an async void handler method with the Elapsed event, just as you may with any other event (assuming the event signature requires void as the handler return type, which is of course the standard for conventional .NET events).

    0 讨论(0)
  • 2021-01-04 03:20

    You are correct about avoiding "async void". Not sure about the compiler not objecting but you are subscribing to the same event twice.

    You should keep the asynchronous part inside the handler, not in the calling of the handler.

    Try removing the duplicate event subscription:

    timer.Elapsed += async (sender, arguments) => await timer_Elapsed(sender, arguments);
    

    and change the handler's signature from:

    private async Task timer_Elapsed(object sender, ElapsedEventArgs e)
    

    to:

    private void timer_Elapsed(object sender, ElapsedEventArgs e)
    

    Then do the asynchronous part inside the handler, using something like the suggestion in this post: https://stackoverflow.com/a/31469699/6776481

    Except the "WrapSomeMethod" call would return just Task, not Task<string>.

    Also, since this is inside of a windows service, don't forget to unsubscribe from the event if necessary.

    0 讨论(0)
提交回复
热议问题