#include <PendingMPIRequest.hpp>

Public Member Functions
MPI_Request *	getMPIRequestFromHandle ()
	Fetch the MPI_Request from its handle that is attached to this PendingMPIRequest. More...

size_t	getMPIRequestIndex ()
	Get the Handle to the MPIRequestPool that can be used to get the associated MPI_Request. More...

	PendingMPIRequest (sgpp::datadriven::MPIRequestPool *requestPool)
	Create a PendingMPIRequest in the specified MPIRequestPool. More...

	~PendingMPIRequest ()
	Removes the PendingMPIRequest from its MPIRequestPool automatically. More...

Public Attributes
sgpp::datadriven::MPI_Packet *	buffer
	The buffer that contains the actual data to be sent or received. More...

std::function< void(PendingMPIRequest &)>	callback
	The callback to execute when the incoming/outgoing MPIRequest is completed. More...

bool	disposeAfterCallback
	Whether to delete the request after calling the callback. More...

bool	inbound
	Whether this PendingMPIRequest is a request for incoming messages. More...

Protected Attributes
size_t	mpiRequestIndex
	The handle to the MPI_Request inside the request pool. More...

sgpp::datadriven::MPIRequestPool &	mpiRequestPool
	A reference to the MPIRequestPool to which this PendingMPIRequest is associated with. More...

Constructor & Destructor Documentation

◆ PendingMPIRequest()

sgpp::datadriven::PendingMPIRequest::PendingMPIRequest ( sgpp::datadriven::MPIRequestPool * requestPool )

explicit

Create a PendingMPIRequest in the specified MPIRequestPool.

Parameters

requestPool The MPIRequestPool to create the request in.

References sgpp::datadriven::MPIRequestPool::createMPIRequestHandle(), mpiRequestIndex, and mpiRequestPool.

◆ ~PendingMPIRequest()

sgpp::datadriven::PendingMPIRequest::~PendingMPIRequest ( )

Removes the PendingMPIRequest from its MPIRequestPool automatically.

References sgpp::datadriven::MPIRequestPool::deleteMPIRequestHandle(), mpiRequestIndex, and mpiRequestPool.

Member Function Documentation

◆ getMPIRequestFromHandle()

MPI_Request * sgpp::datadriven::PendingMPIRequest::getMPIRequestFromHandle ( )

Fetch the MPI_Request from its handle that is attached to this PendingMPIRequest.

Returns: The MPI_Request stored in the MPIRequestPool.

References sgpp::datadriven::MPIRequestPool::getMPIRequestHandle(), mpiRequestIndex, and mpiRequestPool.

Referenced by sgpp::datadriven::MPIMethods::sendIBcast(), and sgpp::datadriven::MPIMethods::sendISend().

◆ getMPIRequestIndex()

size_t sgpp::datadriven::PendingMPIRequest::getMPIRequestIndex ( )

Get the Handle to the MPIRequestPool that can be used to get the associated MPI_Request.

Returns: The handle to the MPI_Request in the MPIRequestPool.

References mpiRequestIndex.

Member Data Documentation

◆ buffer

sgpp::datadriven::MPI_Packet* sgpp::datadriven::PendingMPIRequest::buffer

The buffer that contains the actual data to be sent or received.

Referenced by sgpp::datadriven::MPIMethods::createPendingMPIRequest(), sgpp::datadriven::LearnerSGDEOnOffParallel::doRefinementForAll(), sgpp::datadriven::MPIMethods::handleIncomingRequestFromCallback(), sgpp::datadriven::MPIMethods::processIncomingMPICommands(), and sgpp::datadriven::MPIMethods::waitForIncomingMessageType().

◆ callback

std::function<void(PendingMPIRequest &)> sgpp::datadriven::PendingMPIRequest::callback

The callback to execute when the incoming/outgoing MPIRequest is completed.

Referenced by sgpp::datadriven::MPIMethods::createPendingMPIRequest().

◆ disposeAfterCallback

bool sgpp::datadriven::PendingMPIRequest::disposeAfterCallback

Whether to delete the request after calling the callback.

This is set to false for requests that reuse their buffers after completing, such as restarting a read request in the same slot.

Referenced by sgpp::datadriven::MPIMethods::createPendingMPIRequest(), and sgpp::datadriven::MPIMethods::processIncomingMPICommands().

◆ inbound

bool sgpp::datadriven::PendingMPIRequest::inbound

Whether this PendingMPIRequest is a request for incoming messages.

Referenced by sgpp::datadriven::MPIMethods::createPendingMPIRequest(), and sgpp::datadriven::MPIMethods::waitForIncomingMessageType().

◆ mpiRequestIndex

size_t sgpp::datadriven::PendingMPIRequest::mpiRequestIndex

protected

The handle to the MPI_Request inside the request pool.

Referenced by getMPIRequestFromHandle(), getMPIRequestIndex(), PendingMPIRequest(), and ~PendingMPIRequest().

◆ mpiRequestPool

sgpp::datadriven::MPIRequestPool& sgpp::datadriven::PendingMPIRequest::mpiRequestPool