| Alexandre Lision | 94f06ba | 2013-12-09 16:28:33 -0500 | [diff] [blame] | 1 | /* $Id$ */ |
| Tristan Matthews | 0a329cc | 2013-07-17 13:20:14 -0400 | [diff] [blame] | 2 | /* |
| 3 | * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com) |
| 4 | * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org> |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this program; if not, write to the Free Software |
| 18 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 19 | */ |
| 20 | #ifndef __PJ_RAND_H__ |
| 21 | #define __PJ_RAND_H__ |
| 22 | |
| 23 | /** |
| 24 | * @file rand.h |
| 25 | * @brief Random Number Generator. |
| 26 | */ |
| 27 | |
| 28 | #include <pj/config.h> |
| 29 | |
| 30 | PJ_BEGIN_DECL |
| 31 | |
| 32 | |
| 33 | /** |
| 34 | * @defgroup PJ_RAND Random Number Generator |
| 35 | * @ingroup PJ_MISC |
| 36 | * @{ |
| 37 | * This module contains functions for generating random numbers. |
| 38 | * This abstraction is needed not only because not all platforms have |
| 39 | * \a rand() and \a srand(), but also on some platforms \a rand() |
| 40 | * only has 16-bit randomness, which is not good enough. |
| 41 | */ |
| 42 | |
| 43 | /** |
| 44 | * Put in seed to random number generator. |
| 45 | * |
| 46 | * @param seed Seed value. |
| 47 | */ |
| 48 | PJ_DECL(void) pj_srand(unsigned int seed); |
| 49 | |
| 50 | |
| 51 | /** |
| 52 | * Generate random integer with 32bit randomness. |
| 53 | * |
| 54 | * @return a random integer. |
| 55 | */ |
| 56 | PJ_DECL(int) pj_rand(void); |
| 57 | |
| 58 | |
| 59 | /** @} */ |
| 60 | |
| 61 | |
| 62 | PJ_END_DECL |
| 63 | |
| 64 | |
| 65 | #endif /* __PJ_RAND_H__ */ |
| 66 | |