0661830c90
2008/04/01 12:34:04 thb 1.6.378.2: #i85898# Stripping all external header guards 2008/03/31 13:23:38 rt 1.6.378.1: #i87441# Change license header to LPGL v3.
117 lines
3.2 KiB
C
117 lines
3.2 KiB
C
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2008 by Sun Microsystems, Inc.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: random.h,v $
|
|
* $Revision: 1.7 $
|
|
*
|
|
* 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_ */
|
|
|