Arcane::MessagePassing::MessageId Class Reference

MessageId. More...

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

Collaboration diagram for Arcane::MessagePassing::MessageId:

Classes
union	_Message

Public Types
using	SourceInfo = MessageSourceInfo

Public Member Functions
	MessageId (MessageSourceInfo source_info, void *amessage)
	MessageId (MessageSourceInfo source_info, const void *amessage)
	MessageId (MessageSourceInfo source_info, int amessage)
	MessageId (MessageSourceInfo source_info, long amessage)
	MessageId (MessageSourceInfo source_info, std::size_t amessage)
	MessageId (const MessageId &rhs)
const MessageId &	operator= (const MessageId &rhs)
template<typename T>
	operator const T * () const
template<typename T>
	operator T* () const
	operator int () const
	operator long () const
	operator size_t () const
bool	isValid () const
void *	messageAsVoidPtr () const
void	reset ()
void	print (std::ostream &o) const
MessageSourceInfo	sourceInfo () const
	Information about the message source;.
void	setSourceInfo (MessageSourceInfo si)
	Sets the message source information;.

Static Public Member Functions
static void	setNullMessage (MessageId r)

Private Types
enum	Type {   T_Int , T_Long , T_SizeT , T_Ptr ,   T_Null }

Private Attributes
MessageSourceInfo	m_source_info
int	m_type = T_Null
_Message	m_message

Static Private Attributes
static _Message	null_message

Detailed Description

MessageId.

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

Once the call to mpProbe() is made, it is possible to retrieve the information about the message source via sourceInfo().

With MPI, this class encapsulates the MPI_Message type.

Definition at line 45 of file MessageId.h.

Member Typedef Documentation

SourceInfo

using Arcane::MessagePassing::MessageId::SourceInfo = MessageSourceInfo

Definition at line 67 of file MessageId.h.

Member Enumeration Documentation

Type

enum Arcane::MessagePassing::MessageId::Type

private

Definition at line 56 of file MessageId.h.

Constructor & Destructor Documentation

MessageId() [1/7]

Arcane::MessagePassing::MessageId::MessageId ( )

inline

Definition at line 69 of file MessageId.h.

MessageId() [2/7]

Arcane::MessagePassing::MessageId::MessageId ( MessageSourceInfo source_info, void * amessage )

inline

Definition at line 73 of file MessageId.h.

MessageId() [3/7]

Arcane::MessagePassing::MessageId::MessageId ( MessageSourceInfo source_info, const void * amessage )

inline

Definition at line 80 of file MessageId.h.

MessageId() [4/7]

Arcane::MessagePassing::MessageId::MessageId ( MessageSourceInfo source_info, int amessage )

inline

Definition at line 87 of file MessageId.h.

MessageId() [5/7]

Arcane::MessagePassing::MessageId::MessageId ( MessageSourceInfo source_info, long amessage )

inline

Definition at line 94 of file MessageId.h.

MessageId() [6/7]

Arcane::MessagePassing::MessageId::MessageId ( MessageSourceInfo source_info, std::size_t amessage )

inline

Definition at line 101 of file MessageId.h.

MessageId() [7/7]

Arcane::MessagePassing::MessageId::MessageId ( const MessageId & rhs )

inline

Definition at line 108 of file MessageId.h.

Member Function Documentation

isValid()

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

inline

Definition at line 136 of file MessageId.h.

messageAsVoidPtr()

void * Arcane::MessagePassing::MessageId::messageAsVoidPtr ( ) const

inline

Definition at line 148 of file MessageId.h.

operator const T *()

template<typename T>

Arcane::MessagePassing::MessageId::operator const T * ( ) const

inlineexplicit

Definition at line 126 of file MessageId.h.

operator int()

Arcane::MessagePassing::MessageId::operator int ( ) const

inlineexplicit

Definition at line 129 of file MessageId.h.

operator long()

Arcane::MessagePassing::MessageId::operator long ( ) const

inlineexplicit

Definition at line 130 of file MessageId.h.

operator size_t()

Arcane::MessagePassing::MessageId::operator size_t ( ) const

inlineexplicit

Definition at line 131 of file MessageId.h.

operator T*()

template<typename T>

Arcane::MessagePassing::MessageId::operator T* ( ) const

inlineexplicit

Definition at line 128 of file MessageId.h.

operator=()

const MessageId & Arcane::MessagePassing::MessageId::operator= ( const MessageId & rhs )

inline

Definition at line 115 of file MessageId.h.

print()

void Arcane::MessagePassing::MessageId::print

(

std::ostream &

o

)

const

Definition at line 32 of file MessageId.cc.

reset()

void Arcane::MessagePassing::MessageId::reset ( )

inline

Definition at line 152 of file MessageId.h.

setNullMessage()

void Arcane::MessagePassing::MessageId::setNullMessage ( MessageId r )

inlinestatic

Definition at line 150 of file MessageId.h.

setSourceInfo()

void Arcane::MessagePassing::MessageId::setSourceInfo ( MessageSourceInfo si )

inline

Sets the message source information;.

Definition at line 163 of file MessageId.h.

sourceInfo()

MessageSourceInfo Arcane::MessagePassing::MessageId::sourceInfo ( ) const

inline

Information about the message source;.

Definition at line 160 of file MessageId.h.

Member Data Documentation

m_message

_Message Arcane::MessagePassing::MessageId::m_message

private

Definition at line 169 of file MessageId.h.

m_source_info

MessageSourceInfo Arcane::MessagePassing::MessageId::m_source_info

private

Definition at line 167 of file MessageId.h.

m_type

int Arcane::MessagePassing::MessageId::m_type = T_Null

private

Definition at line 168 of file MessageId.h.

null_message

MessagePassing::MessageId::_Message Arcane::MessagePassing::MessageId::null_message

staticprivate

Definition at line 170 of file MessageId.h.

---

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

• MessageId.h
• MessageId.cc