so_5::layer_t Class Reference

An interface of the additional SObjectizer Environment layer. More...

#include <so_layer.hpp>

Inheritance diagram for so_5::layer_t:

Public Member Functions
	layer_t ()=default
virtual	~layer_t () noexcept=default
virtual void	start ()
	Start hook.
virtual void	shutdown ()
	Shutdown signal hook.
virtual void	wait ()
	Waiting for the complete shutdown of a layer.

Protected Member Functions
environment_t &	so_environment () const
	Access to the SObjectizer Environment.

Private Member Functions
	layer_t (const layer_t &)=delete
	layer_t (layer_t &&)=delete
layer_t &	operator= (const layer_t &)=delete
layer_t &	operator= (layer_t &&)=delete
void	bind_to_environment (environment_t *env)
	Bind layer to the SObjectizer Environment.

Private Attributes
environment_t *	m_env {}
	SObjectizer Environment to which layer is bound.

Friends
class	impl::layer_core_t

Detailed Description

An interface of the additional SObjectizer Environment layer.

Examples

so_5/named_dispatchers_layer/main.cpp.

Definition at line 30 of file so_layer.hpp.

Constructor & Destructor Documentation

layer_t() [1/3]

so_5::layer_t::layer_t ( const layer_t & )

privatedelete

layer_t() [2/3]

so_5::layer_t::layer_t ( layer_t && )

privatedelete

layer_t() [3/3]

so_5::layer_t::layer_t ( )

default

~layer_t()

virtual so_5::layer_t::~layer_t ( )

virtualdefaultnoexcept

Member Function Documentation

bind_to_environment()

void so_5::layer_t::bind_to_environment ( environment_t * env )

private

Bind layer to the SObjectizer Environment.

Definition at line 41 of file so_layer.cpp.

operator=() [1/2]

layer_t & so_5::layer_t::operator= ( const layer_t & )

privatedelete

operator=() [2/2]

layer_t & so_5::layer_t::operator= ( layer_t && )

privatedelete

shutdown()

void so_5::layer_t::shutdown ( )

virtual

Shutdown signal hook.

The default implementation do nothing.

Definition at line 18 of file so_layer.cpp.

so_environment()

environment_t & so_5::layer_t::so_environment ( ) const

protected

Access to the SObjectizer Environment.

Throws an exception if a layer is not bound to the SObjectizer Environment.

Definition at line 28 of file so_layer.cpp.

start()

void so_5::layer_t::start ( )

virtual

Start hook.

The default implementation do nothing.

Definition at line 13 of file so_layer.cpp.

wait()

void so_5::layer_t::wait ( )

virtual

Waiting for the complete shutdown of a layer.

The default implementation do nothing and returned immediately.

Definition at line 23 of file so_layer.cpp.

Friends And Related Symbol Documentation

impl::layer_core_t

friend class impl::layer_core_t

friend

Definition at line 32 of file so_layer.hpp.

Member Data Documentation

m_env

environment_t* so_5::layer_t::m_env {}

private

SObjectizer Environment to which layer is bound.

Pointer has the actual value only after binding to the SObjectizer Environment.

Definition at line 85 of file so_layer.hpp.

---

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

• so_layer.hpp
• so_layer.cpp