IConnectionManager.cs 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. using MediaBrowser.Model.Dto;
  2. using MediaBrowser.Model.Events;
  3. using System;
  4. using System.Threading;
  5. using System.Threading.Tasks;
  6. namespace MediaBrowser.Model.ApiClient
  7. {
  8. public interface IConnectionManager
  9. {
  10. /// <summary>
  11. /// Occurs when [connected].
  12. /// </summary>
  13. event EventHandler<GenericEventArgs<ConnectionResult>> Connected;
  14. /// <summary>
  15. /// Occurs when [remote logged out].
  16. /// </summary>
  17. event EventHandler<EventArgs> RemoteLoggedOut;
  18. /// <summary>
  19. /// Gets the API client.
  20. /// </summary>
  21. /// <param name="item">The item.</param>
  22. /// <returns>MediaBrowser.Model.ApiClient.IApiClient.</returns>
  23. IApiClient GetApiClient(BaseItemDto item);
  24. /// <summary>
  25. /// Connects the specified cancellation token.
  26. /// </summary>
  27. /// <param name="cancellationToken">The cancellation token.</param>
  28. /// <returns>Task&lt;ConnectionResult&gt;.</returns>
  29. Task<ConnectionResult> Connect(CancellationToken cancellationToken);
  30. /// <summary>
  31. /// Connects the specified server.
  32. /// </summary>
  33. /// <param name="server">The server.</param>
  34. /// <param name="cancellationToken">The cancellation token.</param>
  35. /// <returns>Task&lt;ConnectionResult&gt;.</returns>
  36. Task<ConnectionResult> Connect(ServerInfo server, CancellationToken cancellationToken);
  37. /// <summary>
  38. /// Connects the specified server.
  39. /// </summary>
  40. /// <param name="address">The address.</param>
  41. /// <param name="cancellationToken">The cancellation token.</param>
  42. /// <returns>Task&lt;ConnectionResult&gt;.</returns>
  43. Task<ConnectionResult> Connect(string address, CancellationToken cancellationToken);
  44. /// <summary>
  45. /// Logouts this instance.
  46. /// </summary>
  47. /// <returns>Task&lt;ConnectionResult&gt;.</returns>
  48. Task<ConnectionResult> Logout();
  49. }
  50. }