asi esta bien?

[z.facultad/75.06/emufs.git] / emufs / tipo3.h

diff --git a/emufs/tipo3.h b/emufs/tipo3.h
index 508f3963fbea9aa31b96b5d8365671717b8bf5e6..12ed7321bd00190d37d10d337f9315c0e3f1cb35 100644 (file)
--- a/emufs/tipo3.h
+++ b/emufs/tipo3.h
@@ -47,25 +47,44 @@
 #include "idx.h"
 #include "fsc.h"
 
 #include "idx.h"
 #include "fsc.h"
 

-/** Lee el registro \param id_reg y lo almacena en \param ptr */
-void* emufs_tipo3_leer_registro(EMUFS*, EMUFS_REG_ID, EMUFS_REG_SIZE*, int*);
+/** Devuelve un puntero con la memoria reservada que contiene al registro solicitado
+  * por el segundo parámetro \c ID, y almacena en \c reg_size el tamaño del
+  * registro leido, que en este caso no es necesario pues es constante y es conocicdo de antemano.
+  * Para realizar esta acción, busca en el archivo .idx el bloque al cual pertenece el registro.
+  */
+void* emufs_tipo3_leer_registro(EMUFS *emu, EMUFS_REG_ID ID, EMUFS_REG_SIZE* reg_size, int* err);

 
 

-/** Lee el bloque \param num_bloque y lo almacena en \param ptr */
+/** Devuelve un puntero con la memoria reservada que contiene el bloque solicitado por
+  * el segundo parámetro \c num_bloque. Como la numeración de los bloques es virtual,
+  * el acceso al archivo para levantar un bloque es directo, es decir, se posiciona directamente
+  * en en número de bloque multiplicado por el tamaño del mismo, salteando antes el encabezado del archivo.
+  */

 void* emufs_tipo3_leer_bloque(EMUFS*, EMUFS_BLOCK_ID, int*);
 
 void* emufs_tipo3_leer_bloque(EMUFS*, EMUFS_BLOCK_ID, int*);
 

-/** Graba el registro apuntado por \param ptr en el archivo */
+/** Graba un registro en un bloque donde haya espacio suficiente, y si no 
+  * crea un nuevo bloque y lo agrega al final del archivo. 
+  * El registro a grabar es apuntado por el segundo parámetro \param ptr 
+  * y el tamaño viene indicado en \c tam.
+  * Luego de realizar la grabación, actualiza los archivos índice con los
+  * valores correspondientes.
+  */

 EMUFS_REG_ID emufs_tipo3_grabar_registro(EMUFS *emu, void *ptr, EMUFS_REG_SIZE, int*);
 
 EMUFS_REG_ID emufs_tipo3_grabar_registro(EMUFS *emu, void *ptr, EMUFS_REG_SIZE, int*);
 

-/** Graba el bloque apuntado por \param ptr en el archivo */
+/** Graba el bloque apuntado por \c ptr en el archivo */

 int emufs_tipo3_grabar_bloque(EMUFS *emu, void *ptr, EMUFS_BLOCK_ID num_bloque);
 
 int emufs_tipo3_grabar_bloque(EMUFS *emu, void *ptr, EMUFS_BLOCK_ID num_bloque);
 

-/** Borra el registro \param id_reg del archivo de datos */
+/** Borra el registro \c id_reg del archivo de datos, y actualiza los archivos
+  *    de índice para mantener la coherencia en las próximas modificaciones.
+  */

 int emufs_tipo3_borrar_registro(EMUFS *emu, EMUFS_REG_ID id_reg);
 
 /** Método para modificar un registro */
 EMUFS_REG_ID emufs_tipo3_modificar_registro(EMUFS *emu, EMUFS_REG_ID, void*, EMUFS_REG_SIZE, int*);
 
 int emufs_tipo3_borrar_registro(EMUFS *emu, EMUFS_REG_ID id_reg);
 
 /** Método para modificar un registro */
 EMUFS_REG_ID emufs_tipo3_modificar_registro(EMUFS *emu, EMUFS_REG_ID, void*, EMUFS_REG_SIZE, int*);
 

-/** Carga una estructura del tipo EMUFS_Estadisticas con las estadisticas del archivo */
+/** Completa una estructura del tipo EMUFS_Estadisticas con las estadísticas del
+  * archivo de datos, espacio libre total, cantidad de registros, cantidad de bloques,
+  * tamaño del archivo en bytes, relaciones entre tamaños y espacios libres, etc.
+  */

 EMUFS_Estadisticas emufs_tipo3_leer_estadisticas(EMUFS *);
 
 /** Lee un registro con su informacion de control */
 EMUFS_Estadisticas emufs_tipo3_leer_estadisticas(EMUFS *);
 
 /** Lee un registro con su informacion de control */