Message using a SerializeBuffer. More...

#include <arcane/core/internal/SerializeMessage.h>

Inheritance diagram for Arcane::SerializeMessage:

Collaboration diagram for Arcane::SerializeMessage:

Public Member Functions
	SerializeMessage (Int32 orig_rank, Int32 dest_rank, eMessageType mtype)
	SerializeMessage (Int32 orig_rank, MessagePassing::MessageId message_id)
SerializeBuffer &	buffer ()
Public Member Functions inherited from Arcane::MessagePassing::internal::BasicSerializeMessage
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
	Sets the 'finished' state of the message.
void	setTag (Int32 tag) override
Int32	tag () const override
	Internal tag of the message.
void	setInternalTag (MessageTag tag) override
	Sets an internal tag for the message.
MessageTag	internalTag () const override
	Internal tag of the message.
MessageId	_internalMessageId () const override
	Message identifier.
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.

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...
Static Public Member Functions inherited from Arcane::MessagePassing::internal::BasicSerializeMessage
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 inherited from Arcane::MessagePassing::internal::BasicSerializeMessage
static const Int32	DEFAULT_SERIALIZE_TAG_VALUE = 101
Protected Member Functions inherited from Arcane::MessagePassing::internal::BasicSerializeMessage
	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 inherited from Arcane::MessagePassing::internal::BasicSerializeMessage
static ePointToPointMessageType	_toP2PType (eMessageType mtype)
static eMessageType	_toMessageType (ePointToPointMessageType mtype)

Detailed Description

Message using a SerializeBuffer.

A message consists of a series of bytes sent from one rank (origRank()) to another (destRank()). If isSend() is true, origRank() sends to destRank(), otherwise it is the reverse. If it is a receive message, the serializer() is allocated and filled automatically.

For parallelism to work correctly, a complementary message must be sent by destRank().

Definition at line 42 of file SerializeMessage.h.

Constructor & Destructor Documentation

◆ SerializeMessage() [1/2]

Arcane::SerializeMessage::SerializeMessage	(	Int32	orig_rank,
		Int32	dest_rank,
		eMessageType	mtype )

Definition at line 26 of file SerializeMessage.cc.

◆ SerializeMessage() [2/2]

Arcane::SerializeMessage::SerializeMessage	(	Int32	orig_rank,
		MessagePassing::MessageId	message_id )

Definition at line 36 of file SerializeMessage.cc.

Member Function Documentation

◆ buffer()

SerializeBuffer & Arcane::SerializeMessage::buffer ( )

inline

Definition at line 53 of file SerializeMessage.h.

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