michael.heier/jellyfin
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Document IEventConsumer

Browse Source
This commit is contained in:
Patrick Barron 2020-08-24 20:34:33 -04:00
parent 9fa4fff15d
commit 71c33d09c4
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
MediaBrowser.Controller/Events/IEventConsumer.cs
View File

@ -3,9 +3,18 @@ using System.Threading.Tasks;
namespace MediaBrowser.Controller.Events namespace MediaBrowser.Controller.Events
{ {
/// <summary>
/// An interface representing a type that consumes events of type <c>T</c>.
/// </summary>
/// <typeparam name="T">The type of events this consumes.</typeparam>
public interface IEventConsumer<in T> public interface IEventConsumer<in T>
where T : EventArgs where T : EventArgs
{ {
/// <summary>
/// A method that is called when an event of type <c>T</c> is fired.
/// </summary>
/// <param name="eventArgs">The event.</param>
/// <returns>A task representing the consumption of the event.</returns>
Task OnEvent(T eventArgs); Task OnEvent(T eventArgs);
} }
} }