IMessagePassingMng.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IMessagePassingMng.h                                        (C) 2000-2026 */
/*                                                                           */
/* Interface du gestionnaire des échanges de messages.                       */
/*---------------------------------------------------------------------------*/
#ifndef ARCCORE_MESSAGEPASSING_IMESSAGEPASSINGMNG_H
#define ARCCORE_MESSAGEPASSING_IMESSAGEPASSINGMNG_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/message_passing/MessagePassingGlobal.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::MessagePassing
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Détruit l'instance de passage de messages \a p.
 *
 * \warning Ceci ne doit être utilisé qu'avec les fonctions obsolètes
 * qui ne retournent pas d'instances de Ref<IMessagePassingMng> et
 * retournent seulement un IMessagePassingMng*.
 */
extern "C++" void ARCCORE_MESSAGEPASSING_EXPORT
mpDelete(IMessagePassingMng* p);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Interface du gestionnaire des échanges de messages.
 *
 * Cette classe utilise une sémantique par référence et les instances
 * sont automatiquement détruites lorsque cela est nécessaire.
 *
 * La plupart des opérations sur cette classe utilisent des fonctions libres
 * (comme mpSend() ou mpReceive()) qui sont définies dans le fichier 'Messages.h'.
 *
 * %Arcane fournit plusieurs implémentations pour le passage de messages, en
 * utilisant MPI, le passage de messages en mémoire partagée ou le passage de
 * messages hybride (MPI + mémoire partagée). Lorsqu'on utilise MPI, il est
 * possible de créer une instance de cette classe en utilisant la classe
 * StandaloneMpiMessagePassingMng.
 */
class ARCCORE_MESSAGEPASSING_EXPORT IMessagePassingMng
{
  friend void ARCCORE_MESSAGEPASSING_EXPORT mpDelete(IMessagePassingMng*);
  ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS();
 
 public:
 
  virtual ~IMessagePassingMng() = default;
 
 public:
 
  //! Rang de cette instance dans le communicateur
  virtual Int32 commRank() const = 0;
 
  //! Nombre d'instance dans le communicateur
  virtual Int32 commSize() const = 0;
 
  //! Interface pour collecter les temps d'exécution (peut être nul)
  virtual ITimeMetricCollector* timeMetricCollector() const = 0;
 
  //! Gestionnaire de trace associé à cette instance.
  virtual ITraceMng* traceMng() const =0;
 
  /*!
   * \brief Communicateur MPI associé à cette instance.
   *
   * Le communicateur n'est valide que si l'instance est associée à une
   * implémentation MPI. Vous pouvez convertir un communicateur en communicateur
   * MPI en utilisant les méthodes d'aide toMpiCommunicator() et
   * fillMpiCommunicatorIfValid() ou comme ceci :
   *
   * \code
   * IMessagePassingMng* mpm = ...;
   * Communicator comm = mpm->communicator();
   * if (comm.isValid())
   *   MPI_Comm mpi_comm = static_cast<MPI_Comm>(comm).
   * \endcode
   */
  virtual Communicator communicator() const;
 
 public:
 
  virtual IDispatchers* dispatchers() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arccore::MessagePassing
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif