include/rtl/random.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 /*
  21  * This file is part of LibreOffice published API.
  22  */
  23
  24 #ifndef INCLUDED_RTL_RANDOM_H
  25 #define INCLUDED_RTL_RANDOM_H
  26
  27 #include "sal/config.h"
  28
  29 #include "sal/saldllapi.h"
  30 #include "sal/types.h"
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /** Random Pool opaque type.
  37  */
  38 typedef void* rtlRandomPool;
  39
  40
  41 /** Error Code enumeration.
  42  */
  43 enum __rtl_RandomError
  44 {
  45     rtl_Random_E_None,
  46     rtl_Random_E_Argument,
  47     rtl_Random_E_Memory,
  48     rtl_Random_E_Unknown,
  49     rtl_Random_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
  50 };
  51
  52 /** Error Code type.
  53  */
  54 typedef enum __rtl_RandomError rtlRandomError;
  55
  56
  57 /** Create a Random Pool.
  58     @return initialized Random Pool, or NULL upon failure.
  59  */
  60 SAL_DLLPUBLIC rtlRandomPool SAL_CALL rtl_random_createPool (void) SAL_THROW_EXTERN_C();
  61
  62
  63 /** Destroy a Random Pool.
  64     @param[in] Pool a Random Pool.
  65     @return none. Pool is invalid.
  66  */
  67 SAL_DLLPUBLIC void SAL_CALL rtl_random_destroyPool (
  68     rtlRandomPool Pool
  69 ) SAL_THROW_EXTERN_C();
  70
  71
  72 /** Add bytes to a Random Pool.
  73     @param[in] Pool   a Random Pool.
  74     @param[in] Buffer a buffer containing the bytes to add.
  75     @param[in] Bytes  the number of bytes to read from the buffer.
  76     @retval rtl_Random_E_None upon success.
  77  */
  78 SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_addBytes (
  79     rtlRandomPool  Pool,
  80     const void    *Buffer,
  81     sal_Size       Bytes
  82 ) SAL_THROW_EXTERN_C();
  83
  84
  85 /** Retrieve bytes from a Random Pool.
  86     @param[in] Pool    a Random Pool.
  87     @param[in,out] Buffer a buffer to receive the random bytes.
  88     @param[in] Bytes the number of bytes to write to the buffer.
  89     @retval rtl_Random_E_None upon success.
  90  */
  91 SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_getBytes (
  92     rtlRandomPool  Pool,
  93     void          *Buffer,
  94     sal_Size       Bytes
  95 ) SAL_THROW_EXTERN_C();
  96
  97 #ifdef __cplusplus
  98 }
  99 #endif
 100
 101 #endif // INCLUDED_RTL_RANDOM_H
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */