Class ServiceContainer

This class combines the capabilities of a IServiceCollection and IServiceProvider into a single object that implements the combined IServiceContainer interface.

Inheritance
object
ServiceContainer
Implements
IServiceCollection
Namespace: Neon.Common
Assembly: Neon.Common.dll
Syntax
public class ServiceContainer : IServiceContainer, IServiceCollection
Remarks

The design of IServiceCollection and IServiceProvider seems somewhat limited. This assumes that applications explicitly initialize a IServiceCollection instance during startup and then call BuildServiceProvider() to return the IServiceProvider that can actually be used to find a service at runtime.

This works fine for lots of applications, but with a framework like Neon, it is useful to have a global service provider that allows the client to register default services for applications that are not coded to be aware of dependency injection. The problem with the Microsoft DependencyInjection design is that additional services registered after a BuildServiceProvider() call will not be returned by the service provider.

This class combines both these capabilities into a single class such that services can be registered and located dynamically without ever having to call BuildServiceProvider().

note

The BuildServiceProvider() extension methods still work the same and return only a point-in-time snapshot of the services. You may not need to call these though, because you can call GetService(Type) directly.

Constructors

ServiceContainer()

Constructor.

Declaration
public ServiceContainer()

Properties

Count

Declaration
public int Count { get; }
Property Value
Type Description
int

IsReadOnly

Declaration
public bool IsReadOnly { get; }
Property Value
Type Description
bool

this[int]

Declaration
public ServiceDescriptor this[int index] { get; set; }
Parameters
Type Name Description
int index
Property Value
Type Description
ServiceDescriptor

Methods

Add(ServiceDescriptor)

Declaration
public void Add(ServiceDescriptor item)
Parameters
Type Name Description
ServiceDescriptor item

Clear()

Declaration
public void Clear()

Clone()

Returns a clone of the instance. This can be useful for unit testing to save the service container before executing a test and then restoring it afterwards.

Declaration
public ServiceContainer Clone()
Returns
Type Description
ServiceContainer

The cloned instance.

Contains(ServiceDescriptor)

Declaration
public bool Contains(ServiceDescriptor item)
Parameters
Type Name Description
ServiceDescriptor item
Returns
Type Description
bool

CopyTo(ServiceDescriptor[], int)

Declaration
public void CopyTo(ServiceDescriptor[] array, int arrayIndex)
Parameters
Type Name Description
ServiceDescriptor[] array
int arrayIndex

GetEnumerator()

Declaration
public IEnumerator<ServiceDescriptor> GetEnumerator()
Returns
Type Description
IEnumerator<ServiceDescriptor>

GetService(Type)

Gets the service object of the specified type.

Declaration
public object GetService(Type serviceType)
Parameters
Type Name Description
Type serviceType

An object that specifies the type of service object to get.
Returns
Type Description
object

A service object of type serviceType.

-or-

null if there is no service object of type serviceType.

GetService<TService>()

This is a convenience generic method that returns the service already cast to requested type.

Declaration
public TService GetService<TService>()
Returns
Type Description
TService

The service instance if it exists or null.
Type Parameters
Name Description
TService

Specifies the desired service type.

IndexOf(ServiceDescriptor)

Declaration
public int IndexOf(ServiceDescriptor item)
Parameters
Type Name Description
ServiceDescriptor item
Returns
Type Description
int

Insert(int, ServiceDescriptor)

Declaration
public void Insert(int index, ServiceDescriptor item)
Parameters
Type Name Description
int index
ServiceDescriptor item

Remove(ServiceDescriptor)

Declaration
public bool Remove(ServiceDescriptor item)
Parameters
Type Name Description
ServiceDescriptor item
Returns
Type Description
bool

RemoveAt(int)

Declaration
public void RemoveAt(int index)
Parameters
Type Name Description
int index

Implements

IServiceCollection