-
Notifications
You must be signed in to change notification settings - Fork 8
/
IServiceLocator.cs
65 lines (56 loc) · 3.5 KB
/
IServiceLocator.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) Martin Bustos @FronkonGames <fronkongames@gmail.com>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of
// the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
// WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
using System;
namespace FronkonGames.GameWork.Foundation
{
/// <summary> Service Locator interface. </summary>
public interface IServiceLocator
{
/// <summary> Register an instance with the given type T. </summary>
/// <param name="service">The instance to register.</param>
void Register<T>(T service) where T : IService;
/// <summary> Register an instance with the given type T. </summary>
/// <param name="type">The type that this service will be registered with.</param>
/// <param name="service">The instance to register.</param>
void Register(Type type, IService service);
/// <summary> Unregister the service of type T. </summary>
/// <typeparam name="T">T is the type of the service to be unregistered</typeparam>
/// <returns>True if the type is successfully unregistered.</returns>
bool Unregister<T>() where T : IService;
/// <summary> Unregister the service of type T. </summary>
/// <returns>True if the type is successfully unregistered.</returns>
bool Unregister(Type type);
/// <summary> Unregister all services. </summary>
void UnregisterAll();
/// <summary> Get the service of type T. </summary>
/// <typeparam name="T">The type of the service to be retrieved.</typeparam>
/// <returns>The instance that is registered with the given interface type T. </returns>
IService Get<T>() where T : IService;
/// <summary> Get the service of type. </summary>
/// <param name="type">The type of the service to be retrieved.</param>
/// <returns>The instance that is registered with the given interface type T. </returns>
IService Get(Type type);
/// <summary> Check if the service of type T is registered. </summary>
/// <typeparam name="T">The type of the service to be checked.</typeparam>
/// <returns>True if the service is registered, false otherwise.</returns>
bool IsRegistered<T>() where T : IService;
/// <summary> Check if the service of type T is registered. </summary>
/// <param name="type">The type of the service to be checked.</param>
/// <returns>True if the service is registered, false otherwise.</returns>
bool IsRegistered(Type type);
}
}