documented the new function that helps sensornet checkpointing to protect

file descriptors while rolling back state.
This commit is contained in:
nvt-se 2009-01-29 18:24:58 +00:00
parent 2218d8ef8b
commit 4b56200586

View File

@ -38,8 +38,6 @@
#ifndef CFS_COFFEE_H
#define CFS_COFFEE_H
void *cfs_coffee_get_fd_set(unsigned *size);
/**
* \file
* Header for the Coffee file system.
@ -87,6 +85,19 @@ int cfs_coffee_configure_log(const char *file, unsigned log_size,
*/
int cfs_coffee_format(void);
/**
* \brief Gives information about the file descriptor area in Coffee.
* \param size
* \return A pointer to the file descriptor set.
*
* This function returns the file descriptor set and sets the size
* argument to the number of bytes that the set uses. Mainly used for
* sensornet checkpointing to protect the file descriptor while rolling
* back the state from a file.
*/
void *cfs_coffee_get_fd_set(unsigned *size);
/** @} */
/** @} */