source: rtems/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h @ 3c96bee

4.115
Last change on this file since 3c96bee was a15eaaf, checked in by Joel Sherrill <joel.sherrill@…>, on 01/10/13 at 19:20:34

cpukit: Doxygen group fixes and many warnings addressed

The output of the modules.html is much improved. Most
filesystem and POSIX API related groups are properly nested.
Some formatting issues were addressed as were multiple
inconsistencies.
  • Property mode set to 100644
File size: 873 bytes
Line 
1/**
2 * @file
3 *
4 * @brief Provides a 32bit Hash of a String used to Search a Directory
5 *
6 * @ingroup rtems_rfs
7 *
8 * RTEMS File Systems Directory Hash provides a 32bit hash of a string. This is
9 * used to search a directory.
10 */
11
12/*
13 *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
14 *
15 *  The license and distribution terms for this file may be
16 *  found in the file LICENSE in this distribution or at
17 *  http://www.rtems.com/license/LICENSE.
18 */
19
20#if !defined (_RTEMS_RFS_DIR_HASH_H_)
21#define _RTEMS_RFS_DIR_HAS_H_
22
23#include <stddef.h>
24#include <stdint.h>
25
26/**
27 * Compute a hash of the key over the length of string.
28 *
29 * @param[in] key is a pointer to the key to calculate the hash of.
30 * @param[in] length is the length of the key in bytes.
31 *
32 * @retval hash The computed uint32_t hash.
33 */
34uint32_t rtems_rfs_dir_hash (const void *key, size_t length);
35
36#endif
Note: See TracBrowser for help on using the repository browser.