WRENCH  1.11
Cyberinfrastructure Simulation Workbench
Overview Installation Getting Started WRENCH 101 WRENCH 102
Public Member Functions | Public Attributes | List of all members
wrench::FileTransferThreadNotificationMessage Class Reference

A message sent to by a FileTransferThread to report on success/failure of the transfer. More...

#include <FileTransferThreadMessage.h>

Inheritance diagram for wrench::FileTransferThreadNotificationMessage:
wrench::FileTransferThreadMessage wrench::ServiceMessage wrench::SimulationMessage

Public Member Functions

 FileTransferThreadNotificationMessage (std::shared_ptr< FileTransferThread > file_transfer_thread, std::shared_ptr< DataFile >file, simgrid::s4u::Mailbox *src_mailbox, std::shared_ptr< FileLocation > src_location, simgrid::s4u::Mailbox *dst_mailbox, std::shared_ptr< FileLocation > dst_location, simgrid::s4u::Mailbox *answer_mailbox_if_read, simgrid::s4u::Mailbox *answer_mailbox_if_write, simgrid::s4u::Mailbox *answer_mailbox_if_copy, bool success, std::shared_ptr< FailureCause > failure_cause)
 Constructor. More...
 
- Public Member Functions inherited from wrench::SimulationMessage
 SimulationMessage (double payload)
 Constructor. More...
 
virtual std::string getName ()
 Retrieve the message name. More...
 

Public Attributes

simgrid::s4u::Mailbox * answer_mailbox_if_copy
 If this was a file copy, the mailbox to which an answer should be send.
 
simgrid::s4u::Mailbox * answer_mailbox_if_read
 If this was a file read, the mailbox to which an answer should be send.
 
simgrid::s4u::Mailbox * answer_mailbox_if_write
 If this was a file write, the mailbox to which an answer should be send.
 
std::shared_ptr< FileLocationdst_location
 Destination location (or nullptr if source wasn't a location)
 
simgrid::s4u::Mailbox * dst_mailbox
 Destination mailbox (or "" if destination wasn't a mailbox)
 
std::shared_ptr< FailureCausefailure_cause
 The failure cause is case of a failure.
 
std::shared_ptr< DataFilefile
 File that was being communicated.
 
std::shared_ptr< FileTransferThreadfile_transfer_thread
 File transfer thread that sent this message.
 
std::shared_ptr< FileLocationsrc_location
 Source location (or nullptr if source wasn't a location)
 
simgrid::s4u::Mailbox * src_mailbox
 Source mailbox (or "" if source wasn't a mailbox)
 
bool success
 Whether the transfer succeeded or not.
 
- Public Attributes inherited from wrench::SimulationMessage
double payload
 The message name. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wrench::FileTransferThreadMessage
 FileTransferThreadMessage (double payload)
 Constructor. More...
 
- Protected Member Functions inherited from wrench::ServiceMessage
 ServiceMessage (double payload)
 Constructor. More...
 

Detailed Description

A message sent to by a FileTransferThread to report on success/failure of the transfer.

Constructor & Destructor Documentation

◆ FileTransferThreadNotificationMessage()

wrench::FileTransferThreadNotificationMessage::FileTransferThreadNotificationMessage ( std::shared_ptr< FileTransferThread file_transfer_thread,
std::shared_ptr< DataFile file,
simgrid::s4u::Mailbox *  src_mailbox,
std::shared_ptr< FileLocation src_location,
simgrid::s4u::Mailbox *  dst_mailbox,
std::shared_ptr< FileLocation dst_location,
simgrid::s4u::Mailbox *  answer_mailbox_if_read,
simgrid::s4u::Mailbox *  answer_mailbox_if_write,
simgrid::s4u::Mailbox *  answer_mailbox_if_copy,
bool  success,
std::shared_ptr< FailureCause failure_cause 
)
inline

Constructor.

Parameters
file_transfer_threadthe FileTransferThread that sent this message
filethe file that was being transfered
src_mailboxthe source mailbox of the transfer (or "" if source wasn't a mailbox)
src_locationthe source location of the transfer (or nullptr if source wasn't a location)
dst_mailboxthe destination mailbox of the transfer (or "" if source wasn't a mailbox)
dst_locationthe destination location of the transfer (or nullptr if source wasn't a location)
answer_mailbox_if_readthe mailbox that a "read is done" may be sent to if necessary
answer_mailbox_if_writethe mailbox that a "write is done" may be sent to if necessary
answer_mailbox_if_copythe mailbox that a "copy is done/failed" may be sent if necessary
successwhether the transfer succeeded
failure_causethe failure cause (nullptr if success)

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