Arcane::Parallel::MessageSourceInfo Class Reference

Information about the source of a message. More...

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

Collaboration diagram for Arcane::Parallel::MessageSourceInfo:

Public Member Functions
	MessageSourceInfo ()=default
	Creates a source corresponding to no message (isValid()==false).
	MessageSourceInfo (MessageRank rank, MessageTag tag, Int64 size)
	Creates a source corresponding to rank rank and tag tag.
MessageRank	rank () const
	Source rank.
void	setRank (MessageRank rank)
	Sets the source rank.
MessageTag	tag () const
	Message tag.
void	setTag (MessageTag tag)
	Sets the message tag.
Int64	size () const
	Message size.
void	setSize (Int64 size)
	Sets the message size.
bool	isValid () const
	Indicates if the source is valid.

Private Attributes
MessageRank	m_rank
MessageTag	m_tag
Int64	m_size = 0

Detailed Description

Information about the source of a message.

This information is used to retrieve message information following a call to mpProbe() or mpLegacyProbe(). The returned instance can be used to perform a reception via mpReceive().

Definition at line 36 of file MessageSourceInfo.h.

Constructor & Destructor Documentation

MessageSourceInfo()

Arcane::MessagePassing::MessageSourceInfo::MessageSourceInfo ( MessageRank rank, MessageTag tag, Int64 size )

inline

Creates a source corresponding to rank rank and tag tag.

If rank.isNull() or tag.isNull(), then isValid() will be false.

Definition at line 48 of file MessageSourceInfo.h.

Member Function Documentation

isValid()

bool Arcane::MessagePassing::MessageSourceInfo::isValid ( ) const

inline

Indicates if the source is valid.

Definition at line 75 of file MessageSourceInfo.h.

rank()

MessageRank Arcane::MessagePassing::MessageSourceInfo::rank ( ) const

inline

Source rank.

Definition at line 57 of file MessageSourceInfo.h.

setRank()

void Arcane::MessagePassing::MessageSourceInfo::setRank ( MessageRank rank )

inline

Sets the source rank.

Definition at line 60 of file MessageSourceInfo.h.

setSize()

void Arcane::MessagePassing::MessageSourceInfo::setSize ( Int64 size )

inline

Sets the message size.

Definition at line 72 of file MessageSourceInfo.h.

setTag()

void Arcane::MessagePassing::MessageSourceInfo::setTag ( MessageTag tag )

inline

Sets the message tag.

Definition at line 66 of file MessageSourceInfo.h.

size()

Int64 Arcane::MessagePassing::MessageSourceInfo::size ( ) const

inline

Message size.

Definition at line 69 of file MessageSourceInfo.h.

tag()

MessageTag Arcane::MessagePassing::MessageSourceInfo::tag ( ) const

inline

Message tag.

Definition at line 63 of file MessageSourceInfo.h.

Member Data Documentation

m_rank

MessageRank Arcane::MessagePassing::MessageSourceInfo::m_rank

private

Definition at line 79 of file MessageSourceInfo.h.

m_size

Int64 Arcane::MessagePassing::MessageSourceInfo::m_size = 0

private

Definition at line 81 of file MessageSourceInfo.h.

m_tag

MessageTag Arcane::MessagePassing::MessageSourceInfo::m_tag

private

Definition at line 80 of file MessageSourceInfo.h.

---

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

• MessageSourceInfo.h