Interface d'un message de sérialisation entre IMessagePassingMng. Plus de détails...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/message_passing/arccore/message_passing/ISerializeMessage.h>

Graphe d'héritage de Arccore::MessagePassing::ISerializeMessage:

Graphe de collaboration de Arccore::MessagePassing::ISerializeMessage:

Types publics
enum	eMessageType { MT_Send , MT_Recv , MT_Broadcast }

enum class	eStrategy { Default , OneMessage }
	Stratégie d'envoi/réception. Plus de détails...

Fonctions membres publiques
virtual	~ISerializeMessage ()=default
	Libère les ressources.

virtual bool	isSend () const =0
	true s'il faut envoyer, false s'il faut recevoir

virtual eMessageType	messageType () const =0
	Type du message.

virtual Int32	destRank () const =0
	Rang du destinataire (si isSend() est vrai) ou envoyeur.

virtual MessageRank	destination () const =0
	Rang du destinataire (si isSend() est vrai) ou de l'envoyeur.

virtual Int32	origRank () const =0
	Rang de l'envoyeur du message Voir aussi destRank() pour une interprétation suivant la valeur de isSend()

virtual MessageRank	source () const =0
	Rang de l'envoyeur du message.

virtual ISerializer *	serializer ()=0
	Sérialiseur.

virtual bool	finished () const =0
	true si le message est terminé

virtual void	setFinished (bool v)=0
	Positionne l'état 'fini' du message.

virtual void	setTag (Int32 tag)=0

virtual void	setInternalTag (MessageTag tag)=0
	Positionne un tag interne pour le message.

virtual Int32	tag () const =0
	Tag interne du message.

virtual MessageTag	internalTag () const =0
	Tag interne du message.

virtual MessageId	_internalMessageId () const =0
	Identificant du message.

virtual void	setStrategy (eStrategy strategy)=0
	Positionne la stratégie d'envoi/réception.

virtual eStrategy	strategy () const =0
	Stratégie utilisée pour les envois/réceptions.

virtual bool	isProcessed () const =0
	Indique si le message a déjà été traité.

Description détaillée

Interface d'un message de sérialisation entre IMessagePassingMng.

Un message de sérialisation consiste en une série d'octets envoyés d'un rang source() à un rang destination(). Si isSend() est vrai, c'est source() qui envoie à destination(), sinon c'est l'inverse. S'il s'agit d'un message de réception, le serializer() est alloué et remplit automatiquement. Pour que le parallélisme fonctionne correctement, il faut qu'à un message d'envoi corresponde un message de réception complémentaire (envoyé par le rang destination()).

Le message peut-être non bloquant. Un message peut-être détruit lorsque sa propriété finished() est vrai.

Définition à la ligne 44 du fichier arccore/src/message_passing/arccore/message_passing/ISerializeMessage.h.

Documentation des énumérations membres

◆ eMessageType

enum Arccore::MessagePassing::ISerializeMessage::eMessageType

Définition à la ligne 48 du fichier arccore/src/message_passing/arccore/message_passing/ISerializeMessage.h.

◆ eStrategy

enum class Arccore::MessagePassing::ISerializeMessage::eStrategy

strong

Stratégie d'envoi/réception.

Valeurs énumérées

Default

Stratégie par défaut.

OneMessage

Stratégie utilisant un seul message si possible.

Cela suppose d'utiliser la fonction mpProbe() pour connaitre la taille du message avant de poster la réception.

Définition à la ligne 55 du fichier arccore/src/message_passing/arccore/message_passing/ISerializeMessage.h.

Documentation des fonctions membres

◆ _internalMessageId()

virtual MessageId Arccore::MessagePassing::ISerializeMessage::_internalMessageId ( ) const

pure virtual

Identificant du message.

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ destination()

virtual MessageRank Arccore::MessagePassing::ISerializeMessage::destination ( ) const

pure virtual

Rang du destinataire (si isSend() est vrai) ou de l'envoyeur.

Dans le cas d'une réception, le rang peut valoir nul pour indiquer qu'on souhaite recevoir de n'importe qui. rang en spécifiant A_NULL_RANK.

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

Référencé par Arcane::ParallelExchanger::_processExchangeWithControl().

◆ destRank()

virtual Int32 Arccore::MessagePassing::ISerializeMessage::destRank ( ) const

pure virtual

Rang du destinataire (si isSend() est vrai) ou envoyeur.

Dans le cas d'une réception, il est possible de spécifier n'importe quel rang en spécifiant A_NULL_RANK.

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ finished()

virtual bool Arccore::MessagePassing::ISerializeMessage::finished ( ) const

pure virtual

true si le message est terminé

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ internalTag()

virtual MessageTag Arccore::MessagePassing::ISerializeMessage::internalTag ( ) const

pure virtual

Tag interne du message.

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ isProcessed()

virtual bool Arccore::MessagePassing::ISerializeMessage::isProcessed ( ) const

pure virtual

Indique si le message a déjà été traité.

Si le message a déjà été traité, il n'est pas possible de changer certaines caractéristiques (comme la stratégie ou le tag)

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ isSend()

virtual bool Arccore::MessagePassing::ISerializeMessage::isSend ( ) const

pure virtual

true s'il faut envoyer, false s'il faut recevoir

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

Référencé par Arcane::ParallelExchanger::_processExchangeWithControl().

◆ messageType()

virtual eMessageType Arccore::MessagePassing::ISerializeMessage::messageType ( ) const

pure virtual

Type du message.

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ origRank()

virtual Int32 Arccore::MessagePassing::ISerializeMessage::origRank ( ) const

pure virtual

Rang de l'envoyeur du message Voir aussi destRank() pour une interprétation suivant la valeur de isSend()

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ serializer()

virtual ISerializer * Arccore::MessagePassing::ISerializeMessage::serializer ( )

pure virtual

Sérialiseur.

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ setFinished()

virtual void Arccore::MessagePassing::ISerializeMessage::setFinished ( bool v )

pure virtual

Positionne l'état 'fini' du message.

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ setInternalTag()

virtual void Arccore::MessagePassing::ISerializeMessage::setInternalTag ( MessageTag tag )

pure virtual

Positionne un tag interne pour le message.

Ce tag est utile s'il faut envoyer/recevoir plusieurs messages à un même couple origin/destination.

Cette méthode est interne à Arccore.

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ setStrategy()

virtual void Arccore::MessagePassing::ISerializeMessage::setStrategy ( eStrategy strategy )

pure virtual

Positionne la stratégie d'envoi/réception.

La stratégie utilisée doit être la même pour le message envoyé et le message de réception sinon le comportement est indéfini.

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ setTag()

virtual void Arccore::MessagePassing::ISerializeMessage::setTag ( Int32 tag )

pure virtual

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ source()

virtual MessageRank Arccore::MessagePassing::ISerializeMessage::source ( ) const

pure virtual

Rang de l'envoyeur du message.

Voir aussi destination() pour une interprétation suivant la valeur de isSend()

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

Référencé par Arcane::ParallelExchanger::_processExchangeWithControl().

◆ strategy()

virtual eStrategy Arccore::MessagePassing::ISerializeMessage::strategy ( ) const

pure virtual

Stratégie utilisée pour les envois/réceptions.

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

◆ tag()

virtual Int32 Arccore::MessagePassing::ISerializeMessage::tag ( ) const

pure virtual

Tag interne du message.

Implémenté dans Arccore::MessagePassing::internal::BasicSerializeMessage.

La documentation de cette classe a été générée à partir du fichier suivant :

arccore/src/message_passing/arccore/message_passing/ISerializeMessage.h

Types publics

Fonctions membres publiques

Description détaillée

Documentation des énumérations membres

◆ eMessageType

◆ eStrategy

Documentation des fonctions membres

◆ _internalMessageId()

◆ destination()

◆ destRank()

◆ finished()

◆ internalTag()

◆ isProcessed()

◆ isSend()

◆ messageType()

◆ origRank()

◆ serializer()

◆ setFinished()

◆ setInternalTag()

◆ setStrategy()

◆ setTag()

◆ source()

◆ strategy()

◆ tag()