1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _RTL_RANDOM_H_
#define _RTL_RANDOM_H_ "$Revision: 1.7 $"
#include <sal/types.h>
#ifdef __cplusplus
extern "C" {
#endif
/*========================================================================
*
* rtlRandom interface.
*
*======================================================================*/
/** Random Pool opaque type.
*/
typedef void* rtlRandomPool;
/** Error Code enumeration.
*/
enum __rtl_RandomError
{
rtl_Random_E_None,
rtl_Random_E_Argument,
rtl_Random_E_Memory,
rtl_Random_E_Unknown,
rtl_Random_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
};
/** Error Code type.
*/
typedef enum __rtl_RandomError rtlRandomError;
/** Create a Random Pool.
@return initialized Random Pool, or NULL upon failure.
*/
rtlRandomPool SAL_CALL rtl_random_createPool (void) SAL_THROW_EXTERN_C();
/** Destroy a Random Pool.
@param Pool [in] a Random Pool.
@return none. Pool is invalid.
*/
void SAL_CALL rtl_random_destroyPool (
rtlRandomPool Pool
) SAL_THROW_EXTERN_C();
/** Add bytes to a Random Pool.
@param Pool [in] a Random Pool.
@param pBuffer [in] a buffer containing the bytes to add.
@param nBufLen [in] the number of bytes to read from the buffer.
@return rtl_Random_E_None upon success.
*/
rtlRandomError SAL_CALL rtl_random_addBytes (
rtlRandomPool Pool,
const void *Buffer,
sal_Size Bytes
) SAL_THROW_EXTERN_C();
/** Retrieve bytes from a Random Pool.
@param Pool [in] a Random Pool.
@param pBuffer [inout] a buffer to receive the random bytes.
@param nBufLen [in] the number of bytes to write to the buffer.
@return rtl_Random_E_None upon success.
*/
rtlRandomError SAL_CALL rtl_random_getBytes (
rtlRandomPool Pool,
void *Buffer,
sal_Size Bytes
) SAL_THROW_EXTERN_C();
/*========================================================================
*
* The End.
*
*======================================================================*/
#ifdef __cplusplus
}
#endif
#endif /* _RTL_RANDOM_H_ */
|
