wrench::FileTransferThread Class Reference

A helper class that implements the concept of a communication thread that performs a file transfer. More...

#include <FileTransferThread.h>

Inheritance diagram for wrench::FileTransferThread:

Public Member Functions
	FileTransferThread (std::string hostname, std::shared_ptr< StorageService > parent, std::shared_ptr< DataFile >file, double num_bytes_to_transfer, simgrid::s4u::Mailbox *src_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, unsigned long buffer_size)
	Constructor. More...
	FileTransferThread (std::string hostname, std::shared_ptr< StorageService > parent, std::shared_ptr< DataFile >file, double num_bytes_to_transfer, std::shared_ptr< FileLocation > src_location, simgrid::s4u::Mailbox *dst_mailbox, simgrid::s4u::Mailbox *answer_mailbox_if_read, simgrid::s4u::Mailbox *answer_mailbox_if_write, simgrid::s4u::Mailbox *answer_mailbox_if_copy, unsigned long buffer_size)
	Constructor. More...
	FileTransferThread (std::string hostname, std::shared_ptr< StorageService > parent, std::shared_ptr< DataFile >file, double num_bytes_to_transfer, std::shared_ptr< FileLocation > src_location, std::shared_ptr< FileLocation > dsg_location, simgrid::s4u::Mailbox *answer_mailbox_if_read, simgrid::s4u::Mailbox *answer_mailbox_if_write, simgrid::s4u::Mailbox *answer_mailbox_if_copy, unsigned long buffer_size)
	Constructor. More...
void	cleanup (bool has_returned_from_main, int return_value) override
	Cleanup method. More...
int	main () override
	Main method. More...
Public Member Functions inherited from wrench::Service
void	assertServiceIsUp ()
	Throws an exception if the service is not up. More...
std::string	getHostname ()
	Get the name of the host on which the service is / will be running. More...
const WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE &	getMessagePayloadList () const
	Get all message payloads and their values of the Service. More...
double	getMessagePayloadValue (WRENCH_MESSAGEPAYLOAD_TYPE)
	Get a message payload of the Service as a double. More...
double	getNetworkTimeoutValue ()
	Returns the service's network timeout value. More...
std::string	getPhysicalHostname ()
	Get the physical name of the host on which the service is / will be running. More...
bool	getPropertyValueAsBoolean (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as a boolean. More...
double	getPropertyValueAsDouble (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as a double. More...
std::string	getPropertyValueAsString (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as a string. More...
unsigned long	getPropertyValueAsUnsignedLong (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as an unsigned long. More...
bool	isUp ()
	Returns true if the service is UP, false otherwise. More...
void	resume ()
	Resume the service. More...
void	setNetworkTimeoutValue (double value)
	Sets the service's network timeout value. More...
void	setStateToDown ()
	Set the state of the service to DOWN.
void	start (std::shared_ptr< Service > this_service, bool daemonize, bool auto_restart)
	Start the service. More...
virtual void	stop ()
	Synchronously stop the service (does nothing if the service is already stopped) More...
void	suspend ()
	Suspend the service.
Public Member Functions inherited from wrench::S4U_Daemon
	S4U_Daemon (std::string hostname, std::string process_name_prefix)
	Constructor (daemon with a mailbox) More...
void	acquireDaemonLock ()
	Method to acquire the daemon's lock. More...
void	createLifeSaver (std::shared_ptr< S4U_Daemon > reference)
	Create a life saver for the daemon. More...
std::string	getName ()
	Retrieve the process name. More...
int	getReturnValue ()
	Returns the value returned by main() (if the daemon has returned from main) More...
Simulation *	getSimulation ()
	Get the service's simulation. More...
S4U_Daemon::State	getState ()
	Get the daemon's state. More...
bool	hasReturnedFromMain ()
	Returns true if the daemon has returned from main() (i.e., not brutally killed) More...
bool	isDaemonized ()
	Return the daemonized status of the daemon. More...
bool	isSetToAutoRestart ()
	Return the auto-restart status of the daemon. More...
std::pair< bool, int >	join ()
	Join (i.e., wait for) the daemon. More...
void	releaseDaemonLock ()
	Method to release the daemon's lock. More...
void	resumeActor ()
	Resume the daemon/actor.
void	setSimulation (Simulation *simulation)
	Set the service's simulation. More...
void	setupOnExitFunction ()
	Sets up the on_exit function for the actor.
void	startDaemon (bool _daemonized, bool _auto_restart)
	Start the daemon. More...
void	suspendActor ()
	Suspend the daemon/actor.

Additional Inherited Members
Public Types inherited from wrench::S4U_Daemon
enum	State { UP, DOWN, SUSPENDED }
	Daemon states. More...
Static Public Member Functions inherited from wrench::S4U_Daemon
static simgrid::s4u::Mailbox *	getRunningActorRecvMailbox ()
	Return the running actor's recv mailbox. More...
Public Attributes inherited from wrench::S4U_Daemon
std::string	hostname
	The name of the host on which the daemon is running.
LifeSaver *	life_saver = nullptr
	The daemon's life saver.
simgrid::s4u::Mailbox *	mailbox
	The daemon's mailbox.
std::string	process_name
	The name of the daemon.
simgrid::s4u::Mailbox *	recv_mailbox
	The daemon's receive mailbox (to send to another daemon so that that daemon can reply)
Static Public Attributes inherited from wrench::S4U_Daemon
static std::unordered_map< aid_t, simgrid::s4u::Mailbox * >	map_actor_to_recv_mailbox
Protected Member Functions inherited from wrench::Service
	Service (std::string hostname, std::string process_name_prefix)
	Constructor. More...
	~Service () override
	Destructor.
template<class T >
std::shared_ptr< T >	getSharedPtr ()
	Method to retrieve the shared_ptr to a service. More...
void	serviceSanityCheck ()
	Check whether the service is properly configured and running. More...
void	setMessagePayload (WRENCH_MESSAGEPAYLOAD_TYPE, double)
	Set a message payload of the Service. More...
void	setMessagePayloads (WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE default_messagepayload_values, WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE overriden_messagepayload_values)
	Set default and user-defined message payloads. More...
void	setProperties (WRENCH_PROPERTY_COLLECTION_TYPE default_property_values, WRENCH_PROPERTY_COLLECTION_TYPE overriden_property_values)
	Set default and user-defined properties. More...
void	setProperty (WRENCH_PROPERTY_TYPE, const std::string &)
	Set a property of the Service. More...
Protected Member Functions inherited from wrench::S4U_Daemon
bool	killActor ()
	Kill the daemon/actor (does nothing if already dead) More...
void	runMainMethod ()
	Method that run's the user-defined main method (that's called by the S4U actor class)
Static Protected Member Functions inherited from wrench::Service
static void	assertServiceIsUp (std::shared_ptr< Service > s)
	Assert for the service being up. More...
Protected Attributes inherited from wrench::Service
WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE	messagepayload_list
	The service's messagepayload list.
std::string	name
	The service's name.
double	network_timeout = 30.0
	The time (in seconds) after which a service that doesn't send back a reply (control) message causes a NetworkTimeOut exception. (default: 30 second; if <0 never timeout)
WRENCH_PROPERTY_COLLECTION_TYPE	property_list
	The service's property list.
bool	shutting_down = false
	A boolean that indicates if the service is in the middle of shutting down.
Protected Attributes inherited from wrench::S4U_Daemon
unsigned int	num_starts = 0
	The number of time that this daemon has started (i.e., 1 + number of restarts)
Simulation *	simulation
	a pointer to the simulation object
State	state
	The service's state.

Detailed Description

A helper class that implements the concept of a communication thread that performs a file transfer.

Constructor & Destructor Documentation

FileTransferThread() [1/3]

wrench::FileTransferThread::FileTransferThread	(	std::string	hostname,
		std::shared_ptr< StorageService >	parent,
		std::shared_ptr< DataFile >	file,
		double	num_bytes_to_transfer,
		simgrid::s4u::Mailbox *	src_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,
		unsigned long	buffer_size
	)

Constructor.

Parameters

hostname	host on which to run
parent	the parent storage service
file	the file corresponding to the connection
num_bytes_to_transfer	number of bytes to transfer
src_mailbox	the a source mailbox to receive data from
dst_location	a location to write data to
answer_mailbox_if_read	the mailbox to send an answer to in case this was a file read ("" if none). This will simply be reported to the parent service, who may use it as needed
answer_mailbox_if_write	the mailbox to send an answer to in case this was a file write ("" if none). This will simply be reported to the parent service, who may use it as needed
answer_mailbox_if_copy	the mailbox to send an answer to in case this was a file copy ("" if none). This will simply be reported to the parent service, who may use it as needed
buffer_size	the buffer size to use

FileTransferThread() [2/3]

wrench::FileTransferThread::FileTransferThread	(	std::string	hostname,
		std::shared_ptr< StorageService >	parent,
		std::shared_ptr< DataFile >	file,
		double	num_bytes_to_transfer,
		std::shared_ptr< FileLocation >	src_location,
		simgrid::s4u::Mailbox *	dst_mailbox,
		simgrid::s4u::Mailbox *	answer_mailbox_if_read,
		simgrid::s4u::Mailbox *	answer_mailbox_if_write,
		simgrid::s4u::Mailbox *	answer_mailbox_if_copy,
		unsigned long	buffer_size
	)

Constructor.

Parameters

hostname	host on which to run
parent	the parent storage service
file	the file corresponding to the connection
src_location	a location to read data from
dst_mailbox	a mailbox to send data to
answer_mailbox_if_read	the mailbox to send an answer to in case this was a file read ("" if none). This will simply be reported to the parent service, who may use it as needed
answer_mailbox_if_write	the mailbox to send an answer to in case this was a file write ("" if none). This will simply be reported to the parent service, who may use it as needed
answer_mailbox_if_copy	the mailbox to send an answer to in case this was a file copy ("" if none). This will simply be reported to the parent service, who may use it as needed
buffer_size	the buffer size to use

FileTransferThread() [3/3]

wrench::FileTransferThread::FileTransferThread	(	std::string	hostname,
		std::shared_ptr< StorageService >	parent,
		std::shared_ptr< DataFile >	file,
		double	num_bytes_to_transfer,
		std::shared_ptr< FileLocation >	src_location,
		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,
		unsigned long	buffer_size
	)

Constructor.

Parameters

hostname	host on which to run
parent	the parent storage service
file	the file corresponding to the connection
src_location	a location to read data from
dst_location	a location to send data to
answer_mailbox_if_read	the mailbox to send an answer to in case this was a file read (nullptr if none). This will simply be reported to the parent service, who may use it as needed
answer_mailbox_if_write	the mailbox to send an answer to in case this was a file write (nullptr if none). This will simply be reported to the parent service, who may use it as needed
answer_mailbox_if_copy	the mailbox to send an answer to in case this was a file copy (nullptr if none). This will simply be reported to the parent service, who may use it as needed
buffer_size	the buffer size to use

Member Function Documentation

cleanup()

void wrench::FileTransferThread::cleanup ( bool  has_returned_from_main, int  return_value  )

overridevirtual

Cleanup method.

Parameters

has_returned_from_main	whether main() returned
return_value	the return value (if main() returned)

Reimplemented from wrench::S4U_Daemon.

main()

int wrench::FileTransferThread::main ( )

overridevirtual

Main method.

Returns

0 on success, non-zero otherwise

Sending a local file to the network

Receiving a file from the network

Copying a local file

Downloading a file from another storage service

Implements wrench::S4U_Daemon.

---

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

• FileTransferThread.h
• FileTransferThread.cpp