mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-08-31 08:34:33 +02:00
149 lines
5 KiB
C#
149 lines
5 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Reflection;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace MediaBrowser.Common
|
|
{
|
|
/// <summary>
|
|
/// Delegate used with GetExports{T}.
|
|
/// </summary>
|
|
/// <param name="type">Type to create.</param>
|
|
/// <returns>New instance of type <param>type</param>.</returns>
|
|
public delegate object CreationDelegate(Type type);
|
|
|
|
/// <summary>
|
|
/// An interface to be implemented by the applications hosting a kernel.
|
|
/// </summary>
|
|
public interface IApplicationHost
|
|
{
|
|
/// <summary>
|
|
/// Occurs when [has pending restart changed].
|
|
/// </summary>
|
|
event EventHandler HasPendingRestartChanged;
|
|
|
|
/// <summary>
|
|
/// Gets the name.
|
|
/// </summary>
|
|
/// <value>The name.</value>
|
|
string Name { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the device identifier.
|
|
/// </summary>
|
|
/// <value>The device identifier.</value>
|
|
string SystemId { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether this instance has pending kernel reload.
|
|
/// </summary>
|
|
/// <value><c>true</c> if this instance has pending kernel reload; otherwise, <c>false</c>.</value>
|
|
bool HasPendingRestart { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether this instance is currently shutting down.
|
|
/// </summary>
|
|
/// <value><c>true</c> if this instance is shutting down; otherwise, <c>false</c>.</value>
|
|
bool IsShuttingDown { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether this instance can self restart.
|
|
/// </summary>
|
|
/// <value><c>true</c> if this instance can self restart; otherwise, <c>false</c>.</value>
|
|
bool CanSelfRestart { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the application version.
|
|
/// </summary>
|
|
/// <value>The application version.</value>
|
|
Version ApplicationVersion { get; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the service provider.
|
|
/// </summary>
|
|
IServiceProvider ServiceProvider { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets the application version.
|
|
/// </summary>
|
|
/// <value>The application version.</value>
|
|
string ApplicationVersionString { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the application user agent.
|
|
/// </summary>
|
|
/// <value>The application user agent.</value>
|
|
string ApplicationUserAgent { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the email address for use within a comment section of a user agent field.
|
|
/// Presently used to provide contact information to MusicBrainz service.
|
|
/// </summary>
|
|
string ApplicationUserAgentAddress { get; }
|
|
|
|
/// <summary>
|
|
/// Gets all plugin assemblies which implement a custom rest api.
|
|
/// </summary>
|
|
/// <returns>An <see cref="IEnumerable{Assembly}"/> containing the plugin assemblies.</returns>
|
|
IEnumerable<Assembly> GetApiPluginAssemblies();
|
|
|
|
/// <summary>
|
|
/// Notifies the pending restart.
|
|
/// </summary>
|
|
void NotifyPendingRestart();
|
|
|
|
/// <summary>
|
|
/// Restarts this instance.
|
|
/// </summary>
|
|
void Restart();
|
|
|
|
/// <summary>
|
|
/// Gets the exports.
|
|
/// </summary>
|
|
/// <typeparam name="T">The type.</typeparam>
|
|
/// <param name="manageLifetime">If set to <c>true</c> [manage lifetime].</param>
|
|
/// <returns><see cref="IReadOnlyCollection{T}" />.</returns>
|
|
IReadOnlyCollection<T> GetExports<T>(bool manageLifetime = true);
|
|
|
|
/// <summary>
|
|
/// Gets the exports.
|
|
/// </summary>
|
|
/// <typeparam name="T">The type.</typeparam>
|
|
/// <param name="defaultFunc">Delegate function that gets called to create the object.</param>
|
|
/// <param name="manageLifetime">If set to <c>true</c> [manage lifetime].</param>
|
|
/// <returns><see cref="IReadOnlyCollection{T}" />.</returns>
|
|
IReadOnlyCollection<T> GetExports<T>(CreationDelegate defaultFunc, bool manageLifetime = true);
|
|
|
|
/// <summary>
|
|
/// Gets the export types.
|
|
/// </summary>
|
|
/// <typeparam name="T">The type.</typeparam>
|
|
/// <returns>IEnumerable{Type}.</returns>
|
|
IEnumerable<Type> GetExportTypes<T>();
|
|
|
|
/// <summary>
|
|
/// Resolves this instance.
|
|
/// </summary>
|
|
/// <typeparam name="T">The <c>Type</c>.</typeparam>
|
|
/// <returns>``0.</returns>
|
|
T Resolve<T>();
|
|
|
|
/// <summary>
|
|
/// Shuts down.
|
|
/// </summary>
|
|
/// <returns>A task.</returns>
|
|
Task Shutdown();
|
|
|
|
/// <summary>
|
|
/// Initializes this instance.
|
|
/// </summary>
|
|
void Init();
|
|
|
|
/// <summary>
|
|
/// Creates the instance.
|
|
/// </summary>
|
|
/// <param name="type">The type.</param>
|
|
/// <returns>System.Object.</returns>
|
|
object CreateInstance(Type type);
|
|
}
|
|
}
|