Dependency Injection container. More...

#include <solinject.hpp>

Public Types
template<class T >
using	Factory = typename impl::IServiceTyped< T >::Factory
	Factory function that accepts a reference to a DI container and returns a pointer to an instance of a service. More...

template<class T >
using	ServicePtr = typename impl::IServiceTyped< T >::ServicePtr
	Pointer to an instance of a service. More...

using	DIServicePtr = impl::RegisteredServices::DIServicePtr
	Pointer to a DI service instance. More...

using	ScopedServiceBuilderPtr = impl::ScopedServiceBuilders::ScopedServiceBuilderPtr
	Pointer to a scoped service builder. More...

Public Member Functions
	Container ()
	Default constructor.

	Container (const Container &other)=delete
	Copy constructor (deleted)

	Container (Container &&other) noexcept
	Move constructor.

Container &	operator= (const Container &other)=delete
	Copy-assignment operator (deleted)

Container &	operator= (Container &&other) noexcept
	Move-assignment operator.

Container	CreateScope () const
	Creates a scoped container from the current container. More...

bool	IsScope ()
	Tells if the container is a scope container. More...

template<class T >
void	RegisterSingletonService (Factory< T > factory)
	Registers a service with singleton lifetime. More...

template<class T >
void	RegisterSingletonService (ServicePtr< T > instance)
	Registers a service with singleton lifetime. More...

template<class T >
void	RegisterTransientService (Factory< T > factory)
	Registers a service with transient lifetime. More...

template<class T >
void	RegisterSharedService (Factory< T > factory)
	Registers a service with shared lifetime. More...

template<class T >
void	RegisterScopedService (Factory< T > factory)
	Registers a service with scoped lifetime. More...

void	RegisterService (std::type_index type, DIServicePtr diService)
	Registers a service. More...

void	RegisterScopedServiceBuilder (std::type_index type, ScopedServiceBuilderPtr serviceBuilder)
	Registers a scoped service builder. More...

template<class T >
ServicePtr< T >	GetRequiredService () const
	Resolves a required service. More...

template<class T >
ServicePtr< T >	GetService () const
	Resolves an optional service. More...

template<class T >
std::vector< ServicePtr< T > >	GetServices () const
	Resolves services. More...

Friends
void	swap (Container &a, Container &b) noexcept
	Swaps two Container instances.

Detailed Description

Dependency Injection container.

Member Typedef Documentation

◆ DIServicePtr

using sol::di::Container::DIServicePtr = impl::RegisteredServices::DIServicePtr

Pointer to a DI service instance.

◆ Factory

template<class T >

using sol::di::Container::Factory = typename impl::IServiceTyped<T>::Factory

Factory function that accepts a reference to a DI container and returns a pointer to an instance of a service.

Template Parameters

T	the service type

◆ ScopedServiceBuilderPtr

using sol::di::Container::ScopedServiceBuilderPtr = impl::ScopedServiceBuilders::ScopedServiceBuilderPtr

Pointer to a scoped service builder.

◆ ServicePtr

template<class T >

using sol::di::Container::ServicePtr = typename impl::IServiceTyped<T>::ServicePtr

Pointer to an instance of a service.

Template Parameters

T	service type

Member Function Documentation

◆ CreateScope()

Container sol::di::Container::CreateScope ( ) const

inline

Creates a scoped container from the current container.

Returns: Scoped Container instance

◆ GetRequiredService()

template<class T >

ServicePtr<T> sol::di::Container::GetRequiredService ( ) const

inline

Resolves a required service.

Template Parameters

T	service type

Returns: Pointer to an instance of the service

Exceptions

sol::di::exc::ServiceNotRegisteredException

◆ GetService()

template<class T >

ServicePtr<T> sol::di::Container::GetService ( ) const

inline

Resolves an optional service.

Template Parameters

T	service type

Returns: Pointer to an instance of the service or nullptr if the service is not registered

◆ GetServices()

template<class T >

std::vector<ServicePtr<T> > sol::di::Container::GetServices ( ) const

inline

Resolves services.

Template Parameters

T	the service type

Returns: std::vector of pointers to service instances or empty vector if the service is not registered

◆ IsScope()

bool sol::di::Container::IsScope ( )

inline

Tells if the container is a scope container.

Returns: true if the container is a scope container, false otherwise

◆ RegisterScopedService()

template<class T >

void sol::di::Container::RegisterScopedService ( Factory< T > factory )

inline

Registers a service with scoped lifetime.

Template Parameters

T	service type

Parameters

factory factory function

◆ RegisterScopedServiceBuilder()

void sol::di::Container::RegisterScopedServiceBuilder	(	std::type_index	type,
		ScopedServiceBuilderPtr	serviceBuilder
	)

inline

Registers a scoped service builder.

Parameters

type	service type
serviceBuilder	service builder

Warning: This method is intended for use by the ContainerBuilder class only

◆ RegisterService()

void sol::di::Container::RegisterService	(	std::type_index	type,
		DIServicePtr	diService
	)

inline

Registers a service.

Parameters

type	service type
diService	pointer to a DI service instance

Warning: This method is intended for use by the ContainerBuilder class only

◆ RegisterSharedService()

template<class T >

void sol::di::Container::RegisterSharedService ( Factory< T > factory )

inline

Registers a service with shared lifetime.

Template Parameters

T	service type

Parameters

factory factory function

◆ RegisterSingletonService() [1/2]

template<class T >

void sol::di::Container::RegisterSingletonService ( Factory< T > factory )

inline

Registers a service with singleton lifetime.

Template Parameters

T	service type

Parameters

factory factory function

◆ RegisterSingletonService() [2/2]

template<class T >

void sol::di::Container::RegisterSingletonService ( ServicePtr< T > instance )

inline

Registers a service with singleton lifetime.

Template Parameters

T	service type

Parameters

instance pointer to an instance of the service

◆ RegisterTransientService()

template<class T >

void sol::di::Container::RegisterTransientService ( Factory< T > factory )

inline

Registers a service with transient lifetime.

Template Parameters

T	service type

Parameters

factory factory function

The documentation for this class was generated from the following file:

include/solinject/Container.hpp

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ DIServicePtr

◆ Factory

◆ ScopedServiceBuilderPtr

◆ ServicePtr

Member Function Documentation

◆ CreateScope()

◆ GetRequiredService()

◆ GetService()

◆ GetServices()

◆ IsScope()

◆ RegisterScopedService()

◆ RegisterScopedServiceBuilder()

◆ RegisterService()

◆ RegisterSharedService()

◆ RegisterSingletonService() [1/2]

◆ RegisterSingletonService() [2/2]

◆ RegisterTransientService()