Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::MessagePassing::BasicSerializeMessage Class Reference

Public Member Functions

BasicSerializeMessage & operator= (const BasicSerializeMessage &)=delete
 BasicSerializeMessage (const BasicSerializeMessage &)=delete
bool isSend () const override
 true if it should send, false if it should receive
eMessageType messageType () const override
 Message type.
Int32 destRank () const override
 Destination rank (if isSend() is true) or sender.
Int32 origRank () const override
 Message sender rank See also destRank() for interpretation based on the value of isSend().
MessageRank destination () const override
 Destination rank (if isSend() is true) or sender.
MessageRank source () const override
 Message sender rank.
ISerializer * serializer () override
 Serializer.
bool finished () const override
 true if the message is finished
void setFinished (bool v) override
void setTag (Int32 tag) override
Int32 tag () const override
void setInternalTag (MessageTag tag) override
MessageTag internalTag () const override
MessageId _internalMessageId () const override
void setStrategy (eStrategy strategy) override
 Sets the sending/receiving strategy.
eStrategy strategy () const override
 Strategy used for sends/receives.
bool isProcessed () const override
 Indicates if the message has already been processed.
BasicSerializer & buffer ()
BasicSerializer * trueSerializer () const
Int32 messageNumber () const
void setMessageNumber (Int32 v)
void setIsProcessed (bool v)
ePointToPointMessageType _internalMessageType () const
Public Member Functions inherited from Arcane::MessagePassing::ISerializeMessage
virtual ~ISerializeMessage ()=default
 Releases resources.

Static Public Member Functions

static MessageTag defaultTag ()
 Default tag for serialization messages.
static Ref< ISerializeMessage > create (MessageRank source, MessageRank destination, ePointToPointMessageType type)
static Ref< ISerializeMessage > create (MessageRank source, MessageRank destination, MessageTag tag, ePointToPointMessageType type)
static Ref< ISerializeMessage > create (MessageRank source, MessageId message_id)

Static Public Attributes

static const Int32 DEFAULT_SERIALIZE_TAG_VALUE = 101

Protected Member Functions

 BasicSerializeMessage (MessageRank orig_rank, MessageRank dest_rank, ePointToPointMessageType mtype)
 BasicSerializeMessage (MessageRank orig_rank, MessageRank dest_rank, MessageTag tag, ePointToPointMessageType mtype)
 BasicSerializeMessage (MessageRank orig_rank, MessageRank dest_rank, ePointToPointMessageType type, BasicSerializer *serializer)
 BasicSerializeMessage (MessageRank orig_rank, MessageRank dest_rank, MessageTag tag, ePointToPointMessageType type, BasicSerializer *serializer)
 BasicSerializeMessage (MessageRank orig_rank, MessageId message_id, BasicSerializer *serializer)

Static Protected Member Functions

static ePointToPointMessageType _toP2PType (eMessageType mtype)
static eMessageType _toMessageType (ePointToPointMessageType mtype)

Additional Inherited Members

Public Types inherited from Arcane::MessagePassing::ISerializeMessage
enum  eMessageType { MT_Send , MT_Recv , MT_Broadcast }
enum class  eStrategy { Default , OneMessage }
 Sending/receiving strategy. More...

Detailed Description

Definition at line 49 of file BasicSerializeMessage.h.

Constructor & Destructor Documentation

◆ ~BasicSerializeMessage()

Arcane::MessagePassing::internal::BasicSerializeMessage::~BasicSerializeMessage ( )
override

Definition at line 126 of file BasicSerializeMessage.cc.

◆ BasicSerializeMessage() [1/5]

Arcane::MessagePassing::internal::BasicSerializeMessage::BasicSerializeMessage ( MessageRank orig_rank,
MessageRank dest_rank,
ePointToPointMessageType mtype )
protected

Definition at line 116 of file BasicSerializeMessage.cc.

◆ BasicSerializeMessage() [2/5]

Arcane::MessagePassing::internal::BasicSerializeMessage::BasicSerializeMessage ( MessageRank orig_rank,
MessageRank dest_rank,
MessageTag tag,
ePointToPointMessageType mtype )
protected

Definition at line 106 of file BasicSerializeMessage.cc.

◆ BasicSerializeMessage() [3/5]

Arcane::MessagePassing::internal::BasicSerializeMessage::BasicSerializeMessage ( MessageRank orig_rank,
MessageRank dest_rank,
ePointToPointMessageType type,
BasicSerializer * serializer )
protected

Definition at line 77 of file BasicSerializeMessage.cc.

◆ BasicSerializeMessage() [4/5]

Arcane::MessagePassing::internal::BasicSerializeMessage::BasicSerializeMessage ( MessageRank orig_rank,
MessageRank dest_rank,
MessageTag tag,
ePointToPointMessageType type,
BasicSerializer * serializer )
protected

Definition at line 59 of file BasicSerializeMessage.cc.

◆ BasicSerializeMessage() [5/5]

Arcane::MessagePassing::internal::BasicSerializeMessage::BasicSerializeMessage ( MessageRank orig_rank,
MessageId message_id,
BasicSerializer * serializer )
protected

Definition at line 88 of file BasicSerializeMessage.cc.

Member Function Documentation

◆ _internalMessageId()

MessageId Arcane::MessagePassing::internal::BasicSerializeMessage::_internalMessageId ( ) const
inlineoverridevirtual

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 107 of file BasicSerializeMessage.h.

◆ _internalMessageType()

ePointToPointMessageType Arcane::MessagePassing::internal::BasicSerializeMessage::_internalMessageType ( ) const
inline

Definition at line 119 of file BasicSerializeMessage.h.

◆ _toMessageType()

ISerializeMessage::eMessageType Arcane::MessagePassing::internal::BasicSerializeMessage::_toMessageType ( ePointToPointMessageType mtype)
staticprotected

Definition at line 44 of file BasicSerializeMessage.cc.

◆ _toP2PType()

ePointToPointMessageType Arcane::MessagePassing::internal::BasicSerializeMessage::_toP2PType ( eMessageType mtype)
staticprotected

Definition at line 27 of file BasicSerializeMessage.cc.

◆ buffer()

BasicSerializer & Arcane::MessagePassing::internal::BasicSerializeMessage::buffer ( )
inline

Definition at line 114 of file BasicSerializeMessage.h.

◆ create() [1/3]

Ref< ISerializeMessage > Arcane::MessagePassing::internal::BasicSerializeMessage::create ( MessageRank source,
MessageId message_id )
static

Definition at line 184 of file BasicSerializeMessage.cc.

◆ create() [2/3]

Ref< ISerializeMessage > Arcane::MessagePassing::internal::BasicSerializeMessage::create ( MessageRank source,
MessageRank destination,
ePointToPointMessageType type )
static

Definition at line 174 of file BasicSerializeMessage.cc.

◆ create() [3/3]

Ref< ISerializeMessage > Arcane::MessagePassing::internal::BasicSerializeMessage::create ( MessageRank source,
MessageRank destination,
MessageTag tag,
ePointToPointMessageType type )
static

Definition at line 163 of file BasicSerializeMessage.cc.

◆ defaultTag()

MessageTag Arcane::MessagePassing::internal::BasicSerializeMessage::defaultTag ( )
inlinestatic

Default tag for serialization messages.

Definition at line 57 of file BasicSerializeMessage.h.

◆ destination()

MessageRank Arcane::MessagePassing::internal::BasicSerializeMessage::destination ( ) const
inlineoverridevirtual

Destination rank (if isSend() is true) or sender.

In the case of a reception, the rank can be null to indicate that you wish to receive from anyone. rank by specifying A_NULL_RANK.

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 98 of file BasicSerializeMessage.h.

◆ destRank()

Int32 Arcane::MessagePassing::internal::BasicSerializeMessage::destRank ( ) const
inlineoverridevirtual

Destination rank (if isSend() is true) or sender.

In the case of a reception, it is possible to specify any rank by specifying A_NULL_RANK.

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 96 of file BasicSerializeMessage.h.

◆ finished()

bool Arcane::MessagePassing::internal::BasicSerializeMessage::finished ( ) const
inlineoverridevirtual

true if the message is finished

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 101 of file BasicSerializeMessage.h.

◆ internalTag()

MessageTag Arcane::MessagePassing::internal::BasicSerializeMessage::internalTag ( ) const
inlineoverridevirtual

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 106 of file BasicSerializeMessage.h.

◆ isProcessed()

bool Arcane::MessagePassing::internal::BasicSerializeMessage::isProcessed ( ) const
inlineoverridevirtual

Indicates if the message has already been processed.

If the message has already been processed, it is not possible to change certain characteristics (such as the strategy or the tag)

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 110 of file BasicSerializeMessage.h.

◆ isSend()

bool Arcane::MessagePassing::internal::BasicSerializeMessage::isSend ( ) const
inlineoverridevirtual

true if it should send, false if it should receive

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 94 of file BasicSerializeMessage.h.

◆ messageNumber()

Int32 Arcane::MessagePassing::internal::BasicSerializeMessage::messageNumber ( ) const
inline

Definition at line 116 of file BasicSerializeMessage.h.

◆ messageType()

eMessageType Arcane::MessagePassing::internal::BasicSerializeMessage::messageType ( ) const
inlineoverridevirtual

Message type.

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 95 of file BasicSerializeMessage.h.

◆ origRank()

Int32 Arcane::MessagePassing::internal::BasicSerializeMessage::origRank ( ) const
inlineoverridevirtual

Message sender rank See also destRank() for interpretation based on the value of isSend().

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 97 of file BasicSerializeMessage.h.

◆ serializer()

ISerializer * Arcane::MessagePassing::internal::BasicSerializeMessage::serializer ( )
inlineoverridevirtual

Serializer.

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 100 of file BasicSerializeMessage.h.

◆ setFinished()

void Arcane::MessagePassing::internal::BasicSerializeMessage::setFinished ( bool v)
inlineoverridevirtual

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 102 of file BasicSerializeMessage.h.

◆ setInternalTag()

void Arcane::MessagePassing::internal::BasicSerializeMessage::setInternalTag ( MessageTag tag)
inlineoverridevirtual

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 105 of file BasicSerializeMessage.h.

◆ setIsProcessed()

void Arcane::MessagePassing::internal::BasicSerializeMessage::setIsProcessed ( bool v)
inline

Definition at line 118 of file BasicSerializeMessage.h.

◆ setMessageNumber()

void Arcane::MessagePassing::internal::BasicSerializeMessage::setMessageNumber ( Int32 v)
inline

Definition at line 117 of file BasicSerializeMessage.h.

◆ setStrategy()

void Arcane::MessagePassing::internal::BasicSerializeMessage::setStrategy ( eStrategy strategy)
overridevirtual

Sets the sending/receiving strategy.

The strategy used must be the same for the sent message and the receive message, otherwise the behavior is undefined.

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 152 of file BasicSerializeMessage.cc.

◆ setTag()

void Arcane::MessagePassing::internal::BasicSerializeMessage::setTag ( Int32 tag)
inlineoverridevirtual

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 103 of file BasicSerializeMessage.h.

◆ source()

MessageRank Arcane::MessagePassing::internal::BasicSerializeMessage::source ( ) const
inlineoverridevirtual

Message sender rank.

See also destination() for interpretation based on the value of isSend()

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 99 of file BasicSerializeMessage.h.

◆ strategy()

eStrategy Arcane::MessagePassing::internal::BasicSerializeMessage::strategy ( ) const
inlineoverridevirtual

Strategy used for sends/receives.

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 109 of file BasicSerializeMessage.h.

◆ tag()

Int32 Arcane::MessagePassing::internal::BasicSerializeMessage::tag ( ) const
inlineoverridevirtual

Implements Arcane::MessagePassing::ISerializeMessage.

Definition at line 104 of file BasicSerializeMessage.h.

◆ trueSerializer()

BasicSerializer * Arcane::MessagePassing::internal::BasicSerializeMessage::trueSerializer ( ) const
inline

Definition at line 115 of file BasicSerializeMessage.h.

Member Data Documentation

◆ DEFAULT_SERIALIZE_TAG_VALUE

const Int32 Arcane::MessagePassing::internal::BasicSerializeMessage::DEFAULT_SERIALIZE_TAG_VALUE = 101
static

Definition at line 54 of file BasicSerializeMessage.h.

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