SimGrid: Msg_storage_management

SimGrid 3.10 Versatile Simulation of Distributed Systems

- Home page
- Online documentation
- Dev's Corner

All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Typedefs | Functions
Msg_storage_management

## Typedefs
typedef xbt_dictelm_t | msg_storage_t
| Storage datatype.You should consider this as an opaque object.

## Functions
const char * | MSG_storage_get_name (msg_storage_t storage)
| Returns the name of the msg_storage_t.
sg_storage_size_t | MSG_storage_get_free_size (const char *name)
| Returns the free space size of a storage element.
sg_storage_size_t | MSG_storage_get_used_size (const char *name)
| Returns the used space size of a storage element.
xbt_dict_t | MSG_storage_get_properties (msg_storage_t storage)
| Returns a xbt_dict_t consisting of the list of properties assigned to this storage.
void | MSG_storage_set_property_value (msg_storage_t storage, const char *name, char *value, void_f_pvoid_t free_ctn)
| Change the value of a given storage property.
msg_storage_t | MSG_storage_get_by_name (const char *name)
| Finds a msg_storage_t using its name.
xbt_dynar_t | MSG_storages_as_dynar (void)
| Returns a dynar containing all the storage elements declared at a given point of time.
msg_error_t | MSG_storage_set_data (msg_storage_t storage, void *data)
| Set the user data of a msg_storage_t. This functions checks whether some data has already been associated to storage or not and attach data to storage if it is possible.
xbt_dict_t | MSG_storage_get_content (msg_storage_t storage)
| Returns the content (file list) of a msg_storage_t.

## Detailed Description

(msg_storage_t) and the functions for managing it.

## Function Documentation

const char* MSG_storage_get_name | ( | msg_storage_t | storage | ) |

Returns the name of the msg_storage_t.

This functions checks whether a storage is a valid pointer or not and return its name.

sg_storage_size_t MSG_storage_get_free_size | ( | const char * | name | ) |

Returns the free space size of a storage element.

Parameters

  name | the name of a storage

Returns
  the free space size of the storage element (as a sg_storage_size_t)

sg_storage_size_t MSG_storage_get_used_size | ( | const char * | name | ) |

Returns the used space size of a storage element.

Parameters

  name | the name of a storage

Returns
  the used space size of the storage element (as a sg_storage_size_t)

xbt_dict_t MSG_storage_get_properties | ( | msg_storage_t | storage | ) |

Returns a xbt_dict_t consisting of the list of properties assigned to this storage.

Parameters

  storage | a storage

Returns
  a dict containing the properties

void MSG_storage_set_property_value | ( | msg_storage_t | storage,
|  | const char * | name,
|  | char * | value,
|  | void_f_pvoid_t | free_ctn
| ) |  |

Change the value of a given storage property.

Parameters

  storage | a storage
  name | a property name
  value | what to change the property to
  free_ctn | the freeing function to use to kill the value on need

msg_storage_t MSG_storage_get_by_name | ( | const char * | name | ) |

Finds a msg_storage_t using its name.

Parameters

  name | the name of a storage

Returns
  the corresponding storage

xbt_dict_t MSG_storage_get_content | ( | msg_storage_t | storage | ) |

Returns the content (file list) of a msg_storage_t.

Parameters

  storage | a storage

Returns
  The content of this storage element as a dict (full path file => size)