coop_repository_basis.hpp

Go to the documentation of this file.

/*
  SObjectizer 5.
*/
 
/*!
 * \file
 * \brief Basic part of coop_repository functionality.
 *
 * \since
 * v.5.5.19
 */
 
#pragma once
 
#include <so_5/impl/coop_private_iface.hpp>
 
#include <so_5/exception.hpp>
 
#include <so_5/agent.hpp>
#include <so_5/coop_listener.hpp>
#include <so_5/environment_infrastructure.hpp>
 
#include <so_5/stats/repository.hpp>
 
#include <map>
#include <memory>
#include <set>
#include <string>
#include <mutex>
#include <condition_variable>
 
#if defined( SO_5_MSVC )
  #pragma warning(push)
  #pragma warning(disable: 4251)
#endif
 
namespace so_5
{
 
namespace impl
{
 
//
// coop_repository_basis_t
//
 
/*!
 * \brief A basic part for various implementations of coop_repository.
 *
 * \since
 * v.5.5.19
 */
class SO_5_TYPE coop_repository_basis_t
{
  coop_repository_basis_t( const coop_repository_basis_t & ) = delete;
  coop_repository_basis_t( coop_repository_basis_t && ) = delete;
 
public:
  coop_repository_basis_t(
    //! SObjectizer Environment.
    outliving_reference_t< environment_t > environment,
    //! Cooperation action listener.
    coop_listener_unique_ptr_t coop_listener );
 
  //! Create an instance of a new coop.
  /*!
   * \since
   * v.5.6.0
   */
  [[nodiscard]]
  coop_unique_holder_t
  make_coop(
    //! Parent coop.
    //! Can be empty. In that case there won't be any parent coop.
    coop_handle_t parent,
    //! Default binder for that coop.
    disp_binder_shptr_t default_binder );
 
  //! Register cooperation.
  [[nodiscard]]
  coop_handle_t
  register_coop(
    //! Cooperation to be registered.
    coop_unique_holder_t agent_coop );
 
  /*!
   * Type for return value of final_deregister_coop method.
   *
   * This method must return two boolean values:
   * - the first value equals to true if there is at least one live coop;
   * - the second value equals to true if total deregistration is in
   *   progress and there is no more live coops;
   *
   * \since
   * v.5.5.19
   */
  struct [[nodiscard]] final_deregistration_result_t
    {
      bool m_has_live_coop;
      bool m_total_deregistration_completed;
 
      final_deregistration_result_t(
        bool has_live_coop,
        bool total_deregistration_completed )
        : m_has_live_coop( has_live_coop )
        , m_total_deregistration_completed( total_deregistration_completed )
        {}
    };
 
  //! Do final actions of the cooperation deregistration.
  /*!
   * \note
   * This method is noexcept since v.5.8.0.
   *
   * \retval true there are some live cooperations.
   * \retval false there is no more live cooperations.
   */
  final_deregistration_result_t
  final_deregister_coop(
    //! Cooperation name to be deregistered.
    coop_shptr_t coop ) noexcept;
 
  //! Deregisted all cooperations.
  /*!
   * All cooperations will be deregistered at the SObjectizer shutdown.
   *
   * \return Count of coops to be completely deregistered.
   */
  void
  deregister_all_coop() noexcept;
 
  /*!
   * \brief Result of attempt to switch to shutdown state.
   *
   * \since
   * v.5.6.0
   */
  enum class [[nodiscard]] try_switch_to_shutdown_result_t
    {
      switched,
      already_in_shutdown_state
    };
 
  /*!
   * \brief Try to switch repository to shutdown state.
   *
   * \note
   * This method doesn't call deregister_all_coop().
   * It only changes state of repository to 'shutdown'.
   * This prevents from registration of new cooperations.
   *
   * \since
   * v.5.6.0
   */
  try_switch_to_shutdown_result_t
  try_switch_to_shutdown() noexcept;
 
  /*!
   * \since
   * v.5.5.0
   *
   * \brief Access to SObjectizer Environment.
   *
   * \note This access is necessary to use error_logger for
   * logging error messages.
   */
  [[nodiscard]]
  environment_t &
  environment();
 
  /*!
   * \since
   * v.5.5.4
   *
   * \brief Get the current statistic for run-time monitoring.
   */
  [[nodiscard]]
  environment_infrastructure_t::coop_repository_stats_t
  query_stats();
 
protected:
  class root_coop_t;
 
  //! Enumeration of possible repository statuses.
  enum class status_t
    {
      normal,
      pending_shutdown,
      shutdown
    };
 
  //! Environment to work in.
  outliving_reference_t< environment_t > m_env;
 
  //! Counter for coop_ids.
  std::atomic_uint_fast64_t m_coop_id_counter{ 0 };
 
  //! Lock for coop repository.
  std::mutex m_lock;
 
  //! Status of repository.
  status_t m_status{ status_t::normal };
 
  //! Condition variable to wait a possibility to do actions
  //! in deregister_all_coop.
  std::condition_variable m_shutdown_enabled_cond;
 
  //! Total count of coops.
  std::size_t m_total_coops{};
 
  //! Total count of agents.
  std::size_t m_total_agents{};
 
  //! Count of coops those are in registration now.
  std::size_t m_registrations_in_progress{};
 
  //! Cooperation actions listener.
  coop_listener_unique_ptr_t m_coop_listener;
 
  //! A special root coop.
  /*!
   * \attention
   * This coop can't be deregistered!
   */
  std::shared_ptr< root_coop_t > m_root_coop;
 
  //! An actual implementation of registration of a coop.
  [[nodiscard]]
  coop_handle_t
  do_registration_specific_actions( coop_unique_holder_t coop_ptr );
};
 
} /* namespace impl */
 
} /* namespace so_5 */
 
#if defined( SO_5_MSVC )
  #pragma warning(pop)
#endif