simgrid::s4u::File Class Reference

Detailed Description

A simulated file.

Used to simulate the time it takes to access to a file, but does not really store any information.

They are located on simgrid::s4u::Storage that are accessed from a given simgrid::s4u::Host through mountpoints. For now, you cannot change the mountpoints programatically, and must declare them from your platform file.

Examples:

examples/s4u/actions-storage/s4u-actions-storage.cpp.

#include <File.hpp>

Public Member Functions
	File (std::string fullpath, void *userdata)
	File (std::string fullpath, sg_host_t host, void *userdata)
	~File ()
const char *	getPath ()
	Retrieves the path to the file. More...
sg_size_t	read (sg_size_t size)
	Simulates a local read action. More...
sg_size_t	write (sg_size_t size)
	Simulates a write action. More...
void	setUserdata (void *data)
	Allows to store user data on that host. More...
void *	getUserdata ()
	Retrieves the previously stored data. More...
sg_size_t	size ()
	Retrieve the datasize. More...
void	seek (sg_offset_t pos)
	Sets the file head to the given position. More...
void	seek (sg_offset_t pos, int origin)
sg_size_t	tell ()
	Retrieves the current file position. More...
void	move (std::string fullpath)
	Rename a file. More...
int	unlink ()
	Remove a file from disk. More...

Public Attributes
std::string	storage_type
std::string	storageId
std::string	mount_point
int	desc_id = 0

Constructor & Destructor Documentation

File() [1/2]

simgrid::s4u::File::File	(	std::string	fullpath,
		void *	userdata
	)

File() [2/2]

simgrid::s4u::File::File	(	std::string	fullpath,
		sg_host_t	host,
		void *	userdata
	)

~File()

simgrid::s4u::File::~File

(

)

Member Function Documentation

getPath()

const char* simgrid::s4u::File::getPath ( )

inline

Retrieves the path to the file.

read()

sg_size_t simgrid::s4u::File::read

(

sg_size_t

size

)

Simulates a local read action.

Returns the size of data actually read

Examples:

examples/s4u/actions-storage/s4u-actions-storage.cpp.

write()

sg_size_t simgrid::s4u::File::write

(

sg_size_t

size

)

Simulates a write action.

Returns the size of data actually written.

setUserdata()

void simgrid::s4u::File::setUserdata ( void *  data )

inline

Allows to store user data on that host.

getUserdata()

void* simgrid::s4u::File::getUserdata ( )

inline

Retrieves the previously stored data.

size()

sg_size_t simgrid::s4u::File::size

(

)

Retrieve the datasize.

seek() [1/2]

void simgrid::s4u::File::seek

(

sg_offset_t

pos

)

Sets the file head to the given position.

seek() [2/2]

void simgrid::s4u::File::seek	(	sg_offset_t	pos,
		int	origin
	)

tell()

sg_size_t simgrid::s4u::File::tell

(

)

Retrieves the current file position.

move()

void simgrid::s4u::File::move

(

std::string

fullpath

)

Rename a file.

WARNING: It is forbidden to move the file to another mount point

unlink()

int simgrid::s4u::File::unlink

(

)

Remove a file from disk.

Member Data Documentation

storage_type

std::string simgrid::s4u::File::storage_type

storageId

std::string simgrid::s4u::File::storageId

mount_point

std::string simgrid::s4u::File::mount_point

desc_id

int simgrid::s4u::File::desc_id = 0

---

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

• include/simgrid/s4u/File.hpp
• src/s4u/s4u_file.cpp