diff options
author | Vsevolod Stakhov <vsevolod@rambler-co.ru> | 2009-02-06 15:00:38 +0300 |
---|---|---|
committer | Vsevolod Stakhov <vsevolod@rambler-co.ru> | 2009-02-06 15:00:38 +0300 |
commit | 7f8de787946b883cc791bf6c0bcb514496caf074 (patch) | |
tree | 8c828243de051ba25ed3806d2a4fca9eaf3cae83 /src/statfile.h | |
parent | a3c3fb96d13f2cbfc5ab984c1886441ec0e9b47b (diff) | |
download | rspamd-7f8de787946b883cc791bf6c0bcb514496caf074.tar.gz rspamd-7f8de787946b883cc791bf6c0bcb514496caf074.zip |
* Make doxygen happy about structures members
Diffstat (limited to 'src/statfile.h')
-rw-r--r-- | src/statfile.h | 51 |
1 files changed, 26 insertions, 25 deletions
diff --git a/src/statfile.h b/src/statfile.h index fd0d20626..539fda842 100644 --- a/src/statfile.h +++ b/src/statfile.h @@ -1,5 +1,6 @@ /** - * Describes common methods in accessing statistics files and caching them in memory + * @file statfile.h + * Describes common methods for accessing statistics files and caching them in memory */ #ifndef RSPAMD_STATFILE_H @@ -21,58 +22,58 @@ * Common statfile header */ struct stat_file_header { - u_char magic[3]; /** < magic signature ('r' 's' 'd') */ - u_char version[2]; /** < version of statfile (1.0) */ - u_char padding[3]; /** < padding */ - uint64_t create_time; /** < create time (time_t->uint64_t) */ + u_char magic[3]; /**< magic signature ('r' 's' 'd') */ + u_char version[2]; /**< version of statfile (1.0) */ + u_char padding[3]; /**< padding */ + uint64_t create_time; /**< create time (time_t->uint64_t) */ } __attribute__((__packed__)); /** * Block of data in statfile */ struct stat_file_block { - uint32_t hash1; /** < hash1 (also acts as index) */ - uint32_t hash2; /** < hash2 */ - float value; /** < float value */ - uint32_t last_access; /** < last access to block since create time of file */ + uint32_t hash1; /**< hash1 (also acts as index) */ + uint32_t hash2; /**< hash2 */ + float value; /**< float value */ + uint32_t last_access; /**< last access to block since create time of file */ }; /** * Statistic file */ struct stat_file { - struct stat_file_header header; /** < header */ - struct stat_file_block blocks[1]; /** < first block of data */ + struct stat_file_header header; /**< header */ + struct stat_file_block blocks[1]; /**< first block of data */ }; /** * Common view of statfile object */ typedef struct stat_file_s { - char *filename; /** < name of file */ - int fd; /** < descriptor */ - void *map; /** < mmaped area */ - time_t open_time; /** < time when file was opened */ - time_t access_time; /** < last access time */ - size_t len; /** < length of file(in bytes) */ - size_t blocks; /** < length of file in blocks */ - gint *lock; /** < mutex */ + char *filename; /**< name of file */ + int fd; /**< descriptor */ + void *map; /**< mmaped area */ + time_t open_time; /**< time when file was opened */ + time_t access_time; /**< last access time */ + size_t len; /**< length of file(in bytes) */ + size_t blocks; /**< length of file in blocks */ + gint *lock; /**< mutex */ } stat_file_t; /** * Statfiles pool */ typedef struct statfile_pool_s { - rspamd_hash_t *files; /** < hash table of opened files indexed by name */ - int opened; /** < number of opened files */ - size_t max; /** < maximum size */ - size_t occupied; /** < current size */ - memory_pool_t *pool; /** < memory pool object */ + rspamd_hash_t *files; /**< hash table of opened files indexed by name */ + int opened; /**< number of opened files */ + size_t max; /**< maximum size */ + size_t occupied; /**< current size */ + memory_pool_t *pool; /**< memory pool object */ } statfile_pool_t; /** * Create new statfile pool - * @param size maximum size + * @param max_size maximum size * @return statfile pool object */ statfile_pool_t* statfile_pool_new (size_t max_size); |